source: chapter08/binutils.xml@ 6ff520f

ml-11.0 multilib
Last change on this file since 6ff520f was 6ff520f, checked in by Thomas Trepl (Moody) <thomas@…>, 3 years ago

Automatic merge of trunk into multilib

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