source: chapter08/binutils.xml@ f7cdb10

xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1
Last change on this file since f7cdb10 was 3ba50cf, checked in by Xi Ruoyao <xry111@…>, 14 months ago

loongarch: binutils: Don't enable gold

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