source: chapter08/binutils.xml@ 075d35fb

11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 arm ml-11.0 multilib s6-init trunk xry111/clfs-ng xry111/glibc-2.34 xry111/lfs-next xry111/tester-nohack
Last change on this file since 075d35fb was 075d35fb, checked in by Ken Moffat <ken@…>, 14 months ago

Some updates re test failures.

  • Property mode set to 100644
File size: 15.2 KB
Line 
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]>
7
8<sect1 id="ch-system-binutils" role="wrap">
9 <?dbhtml filename="binutils.html"?>
10
11 <sect1info condition="script">
12 <productname>binutils</productname>
13 <productnumber>&binutils-version;</productnumber>
14 <address>&binutils-url;</address>
15 </sect1info>
16
17 <title>Binutils-&binutils-version;</title>
18
19 <indexterm zone="ch-system-binutils">
20 <primary sortas="a-Binutils">Binutils</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The Binutils package contains a linker, an assembler, and other
27 tools for handling object files.</para>
28
29 <segmentedlist>
30 <segtitle>&buildtime;</segtitle>
31 <segtitle>&diskspace;</segtitle>
32
33 <seglistitem>
34 <seg>&binutils-fin-sbu;</seg>
35 <seg>&binutils-fin-du;</seg>
36 </seglistitem>
37 </segmentedlist>
38
39 </sect2>
40
41 <sect2 role="installation">
42 <title>Installation of Binutils</title>
43
44 <para>Verify that the PTYs are working properly inside the chroot
45 environment by performing a simple test:</para>
46
47<screen><userinput remap="test">expect -c "spawn ls"</userinput></screen>
48
49 <para>This command should output the following:</para>
50
51<screen><computeroutput>spawn ls</computeroutput></screen>
52
53 <para>If, instead, the output includes the message below, then the environment
54 is not set up for proper PTY operation. This issue needs to be resolved before
55 running the test suites for Binutils and GCC:</para>
56
57<screen><computeroutput>The system has no more ptys.
58Ask your system administrator to create more.</computeroutput></screen>
59
60 <para>Now remove one test that prevents the tests from running
61 to completion:</para>
62
63<screen><userinput remap="pre">sed -i '/@\tincremental_copy/d' gold/testsuite/Makefile.in</userinput></screen>
64
65 <para>The Binutils documentation recommends building Binutils
66 in a dedicated build directory:</para>
67
68<screen><userinput remap="pre">mkdir -v build
69cd build</userinput></screen>
70
71 <para>Prepare Binutils for compilation:</para>
72
73<screen><userinput remap="configure">../configure --prefix=/usr \
74 --enable-gold \
75 --enable-ld=default \
76 --enable-plugins \
77 --enable-shared \
78 --disable-werror \
79 --enable-64-bit-bfd \
80 --with-system-zlib</userinput></screen>
81 <variablelist>
82 <title>The meaning of the configure parameters:</title>
83
84 <varlistentry>
85 <term><parameter>--enable-gold</parameter></term>
86 <listitem>
87 <para>Build the gold linker and install it as ld.gold (along side the
88 default linker).</para>
89 </listitem>
90 </varlistentry>
91
92 <varlistentry>
93 <term><parameter>--enable-ld=default</parameter></term>
94 <listitem>
95 <para>Build the original bfd linker and install it as both ld (the
96 default linker) and ld.bfd.</para>
97 </listitem>
98 </varlistentry>
99
100 <varlistentry>
101 <term><parameter>--enable-plugins</parameter></term>
102 <listitem>
103 <para>Enables plugin support for the linker.</para>
104 </listitem>
105 </varlistentry>
106
107 <varlistentry>
108 <term><parameter>--enable-64-bit-bfd</parameter></term>
109 <listitem>
110 <para>Enables 64-bit support (on hosts with narrower word sizes).
111 May not be needed on 64-bit systems, but does no harm.</para>
112 </listitem>
113 </varlistentry>
114
115 <varlistentry>
116 <term><parameter>--with-system-zlib</parameter></term>
117 <listitem>
118 <para>Use the installed zlib library rather than building the
119 included version.</para>
120 </listitem>
121 </varlistentry>
122
123 </variablelist>
124
125 <para>Compile the package:</para>
126
127<screen><userinput remap="make">make tooldir=/usr</userinput></screen>
128
129 <variablelist>
130 <title>The meaning of the make parameter:</title>
131
132 <varlistentry>
133 <term><parameter>tooldir=/usr</parameter></term>
134 <listitem>
135 <para>Normally, the tooldir (the directory where the executables will
136 ultimately be located) is set to <filename
137 class="directory">$(exec_prefix)/$(target_alias)</filename>. For
138 example, x86_64 machines would expand that to <filename
139 class="directory">/usr/x86_64-pc-linux-gnu</filename>. Because this is
140 a custom system, this target-specific directory in <filename
141 class="directory">/usr</filename> is not required. <filename
142 class="directory">$(exec_prefix)/$(target_alias)</filename> would be
143 used if the system was used to cross-compile (for example, compiling a
144 package on an Intel machine that generates code that can be executed
145 on PowerPC machines).</para>
146 </listitem>
147 </varlistentry>
148
149 </variablelist>
150
151 <important>
152 <para>The test suite for Binutils in this section is considered critical.
153 Do not skip it under any circumstances.</para>
154 </important>
155
156 <para>Test the results:</para>
157
158<screen><userinput remap="test">make -k check</userinput></screen>
159
160 <para>Seven gold tests are known to fail with gcc-11.1.0</para>
161
162 <para>Four ld tests named <quote>Run property ...</quote> are known to
163 fail.</para>
164
165 <para>Install the package:</para>
166
167<screen><userinput remap="install">make tooldir=/usr install -j1</userinput></screen>
168
169 <para>Remove useless static libraries:</para>
170
171<screen><userinput remap="install">rm -fv /usr/lib/lib{bfd,ctf,ctf-nobfd,opcodes}.a</userinput></screen>
172
173 </sect2>
174
175 <sect2 id="contents-binutils" role="content">
176 <title>Contents of Binutils</title>
177
178 <segmentedlist>
179 <segtitle>Installed programs</segtitle>
180 <segtitle>Installed libraries</segtitle>
181 <segtitle>Installed directory</segtitle>
182
183 <seglistitem>
184 <seg>addr2line, ar, as, c++filt, dwp, elfedit, gprof, ld, ld.bfd, ld.gold, nm,
185 objcopy, objdump, ranlib, readelf, size, strings, and strip</seg>
186 <seg>libbfd.so, libctf.so, libctf-nobfd.so, and libopcodes.so</seg>
187 <seg>/usr/lib/ldscripts</seg>
188 </seglistitem>
189 </segmentedlist>
190
191 <variablelist>
192 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
193 <?dbfo list-presentation="list"?>
194 <?dbhtml list-presentation="table"?>
195
196 <varlistentry id="addr2line">
197 <term><command>addr2line</command></term>
198 <listitem>
199 <para>Translates program addresses to file names and line numbers;
200 given an address and the name of an executable, it uses the debugging
201 information in the executable to determine which source file and line
202 number are associated with the address</para>
203 <indexterm zone="ch-system-binutils addr2line">
204 <primary sortas="b-addr2line">addr2line</primary>
205 </indexterm>
206 </listitem>
207 </varlistentry>
208
209 <varlistentry id="ar">
210 <term><command>ar</command></term>
211 <listitem>
212 <para>Creates, modifies, and extracts from archives</para>
213 <indexterm zone="ch-system-binutils ar">
214 <primary sortas="b-ar">ar</primary>
215 </indexterm>
216 </listitem>
217 </varlistentry>
218
219 <varlistentry id="as">
220 <term><command>as</command></term>
221 <listitem>
222 <para>An assembler that assembles the output of <command>gcc</command>
223 into object files</para>
224 <indexterm zone="ch-system-binutils as">
225 <primary sortas="b-as">as</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="c-filt">
231 <term><command>c++filt</command></term>
232 <listitem>
233 <para>Used by the linker to de-mangle C++ and Java symbols and to keep
234 overloaded functions from clashing</para>
235 <indexterm zone="ch-system-binutils c-filt">
236 <primary sortas="b-c++filt">c++filt</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="dwp">
242 <term><command>dwp</command></term>
243 <listitem>
244 <para>The DWARF packaging utility</para>
245 <indexterm zone="ch-system-binutils dwp">
246 <primary sortas="dwp">dwp</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry id="elfedit">
252 <term><command>elfedit</command></term>
253 <listitem>
254 <para>Updates the ELF header of ELF files</para>
255 <indexterm zone="ch-system-binutils elfedit">
256 <primary sortas="b-elfedit">elfedit</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="gprof">
262 <term><command>gprof</command></term>
263 <listitem>
264 <para>Displays call graph profile data</para>
265 <indexterm zone="ch-system-binutils gprof">
266 <primary sortas="b-gprof">gprof</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="ld">
272 <term><command>ld</command></term>
273 <listitem>
274 <para>A linker that combines a number of object and archive files
275 into a single file, relocating their data and tying up symbol
276 references</para>
277 <indexterm zone="ch-system-binutils ld">
278 <primary sortas="b-ld">ld</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="ld.gold">
284 <term><command>ld.gold</command></term>
285 <listitem>
286 <para>A cut down version of ld that only supports the
287 elf object file format</para>
288 <indexterm zone="ch-system-binutils ld.gold">
289 <primary sortas="b-ld.gold">ld.gold</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="ld.bfd">
295 <term><command>ld.bfd</command></term>
296 <listitem>
297 <para>Hard link to <command>ld</command></para>
298 <indexterm zone="ch-system-binutils ld.bfd">
299 <primary sortas="b-ld.bfd">ld.bfd</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="nm">
305 <term><command>nm</command></term>
306 <listitem>
307 <para>Lists the symbols occurring in a given object file</para>
308 <indexterm zone="ch-system-binutils nm">
309 <primary sortas="b-nm">nm</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="objcopy">
315 <term><command>objcopy</command></term>
316 <listitem>
317 <para>Translates one type of object file into another</para>
318 <indexterm zone="ch-system-binutils objcopy">
319 <primary sortas="b-objcopy">objcopy</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="objdump">
325 <term><command>objdump</command></term>
326 <listitem>
327 <para>Displays information about the given object file, with options
328 controlling the particular information to display; the information
329 shown is useful to programmers who are working on the compilation
330 tools</para>
331 <indexterm zone="ch-system-binutils objdump">
332 <primary sortas="b-objdump">objdump</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="ranlib">
338 <term><command>ranlib</command></term>
339 <listitem>
340 <para>Generates an index of the contents of an archive and stores it
341 in the archive; the index lists all of the symbols defined by archive
342 members that are relocatable object files</para>
343 <indexterm zone="ch-system-binutils ranlib">
344 <primary sortas="b-ranlib">ranlib</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="readelf">
350 <term><command>readelf</command></term>
351 <listitem>
352 <para>Displays information about ELF type binaries</para>
353 <indexterm zone="ch-system-binutils readelf">
354 <primary sortas="b-readelf">readelf</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="size">
360 <term><command>size</command></term>
361 <listitem>
362 <para>Lists the section sizes and the total size for the given
363 object files</para>
364 <indexterm zone="ch-system-binutils size">
365 <primary sortas="b-size">size</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="strings">
371 <term><command>strings</command></term>
372 <listitem>
373 <para>Outputs, for each given file, the sequences of printable
374 characters that are of at least the specified length (defaulting to
375 four); for object files, it prints, by default, only the strings from
376 the initializing and loading sections while for other types of files, it
377 scans the entire file</para>
378 <indexterm zone="ch-system-binutils strings">
379 <primary sortas="b-strings">strings</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="strip">
385 <term><command>strip</command></term>
386 <listitem>
387 <para>Discards symbols from object files</para>
388 <indexterm zone="ch-system-binutils strip">
389 <primary sortas="b-strip">strip</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="libbfd">
395 <term><filename class="libraryfile">libbfd</filename></term>
396 <listitem>
397 <para>The Binary File Descriptor library</para>
398 <indexterm zone="ch-system-binutils libbfd">
399 <primary sortas="c-libbfd">libbfd</primary>
400 </indexterm>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry id="libctf">
405 <term><filename class="libraryfile">libctf</filename></term>
406 <listitem>
407 <para>The Compat ANSI-C Type Format debugging support library</para>
408 <indexterm zone="ch-system-binutils libctf">
409 <primary sortas="c-libctf">libctf</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="libctf-nobfd">
415 <term><filename class="libraryfile">libctf-nobfd</filename></term>
416 <listitem>
417 <para>A libctf variant which does not use libbfd functionality</para>
418 <indexterm zone="ch-system-binutils libctf-nobfd">
419 <primary sortas="c-libctf-nobfd">libctf-nobfd</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="libopcodes">
425 <term><filename class="libraryfile">libopcodes</filename></term>
426 <listitem>
427 <para>A library for dealing with opcodes&mdash;the <quote>readable
428 text</quote> versions of instructions for the processor;
429 it is used for building utilities like
430 <command>objdump</command></para>
431 <indexterm zone="ch-system-binutils libopcodes">
432 <primary sortas="c-libopcodes">libopcodes</primary>
433 </indexterm>
434 </listitem>
435 </varlistentry>
436
437 </variablelist>
438
439 </sect2>
440
441</sect1>
Note: See TracBrowser for help on using the repository browser.