source: chapter08/binutils.xml@ 3d891c7

xry111/mips64el
Last change on this file since 3d891c7 was e871ed6, checked in by Xi Ruoyao <xry111@…>, 4 months ago

mips64el: binutils: Update test suite known failures

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