| 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
|
|---|
| 48 | cd 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, 64-bit LoongArch machines would expand that to <filename
|
|---|
| 110 | class="directory">/usr/loongarch64-unknown-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:</para>
|
|---|
| 140 |
|
|---|
| 141 | <screen><userinput remap="install">rm -fv /usr/lib/lib{bfd,ctf,ctf-nobfd,sframe,opcodes}.a</userinput></screen>
|
|---|
| 142 |
|
|---|
| 143 | </sect2>
|
|---|
| 144 |
|
|---|
| 145 | <sect2 id="contents-binutils" role="content">
|
|---|
| 146 | <title>Contents of Binutils</title>
|
|---|
| 147 |
|
|---|
| 148 | <segmentedlist>
|
|---|
| 149 | <segtitle>Installed programs</segtitle>
|
|---|
| 150 | <segtitle>Installed libraries</segtitle>
|
|---|
| 151 | <segtitle>Installed directory</segtitle>
|
|---|
| 152 |
|
|---|
| 153 | <seglistitem>
|
|---|
| 154 | <seg>addr2line, ar, as, c++filt, dwp, elfedit, gprof, gprofng, ld, ld.bfd, nm,
|
|---|
| 155 | objcopy, objdump, ranlib, readelf, size, strings, and strip</seg>
|
|---|
| 156 | <seg>libbfd.so, libctf.so, libctf-nobfd.so, libopcodes.so, and libsframe.so</seg>
|
|---|
| 157 | <seg>/usr/lib/ldscripts</seg>
|
|---|
| 158 | </seglistitem>
|
|---|
| 159 | </segmentedlist>
|
|---|
| 160 |
|
|---|
| 161 | <variablelist>
|
|---|
| 162 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 163 | <?dbfo list-presentation="list"?>
|
|---|
| 164 | <?dbhtml list-presentation="table"?>
|
|---|
| 165 |
|
|---|
| 166 | <varlistentry id="addr2line">
|
|---|
| 167 | <term><command>addr2line</command></term>
|
|---|
| 168 | <listitem>
|
|---|
| 169 | <para>Translates program addresses to file names and line numbers;
|
|---|
| 170 | given an address and the name of an executable, it uses the debugging
|
|---|
| 171 | information in the executable to determine which source file and line
|
|---|
| 172 | number are associated with the address</para>
|
|---|
| 173 | <indexterm zone="ch-system-binutils addr2line">
|
|---|
| 174 | <primary sortas="b-addr2line">addr2line</primary>
|
|---|
| 175 | </indexterm>
|
|---|
| 176 | </listitem>
|
|---|
| 177 | </varlistentry>
|
|---|
| 178 |
|
|---|
| 179 | <varlistentry id="ar">
|
|---|
| 180 | <term><command>ar</command></term>
|
|---|
| 181 | <listitem>
|
|---|
| 182 | <para>Creates, modifies, and extracts from archives</para>
|
|---|
| 183 | <indexterm zone="ch-system-binutils ar">
|
|---|
| 184 | <primary sortas="b-ar">ar</primary>
|
|---|
| 185 | </indexterm>
|
|---|
| 186 | </listitem>
|
|---|
| 187 | </varlistentry>
|
|---|
| 188 |
|
|---|
| 189 | <varlistentry id="as">
|
|---|
| 190 | <term><command>as</command></term>
|
|---|
| 191 | <listitem>
|
|---|
| 192 | <para>An assembler that assembles the output of <command>gcc</command>
|
|---|
| 193 | into object files</para>
|
|---|
| 194 | <indexterm zone="ch-system-binutils as">
|
|---|
| 195 | <primary sortas="b-as">as</primary>
|
|---|
| 196 | </indexterm>
|
|---|
| 197 | </listitem>
|
|---|
| 198 | </varlistentry>
|
|---|
| 199 |
|
|---|
| 200 | <varlistentry id="c-filt">
|
|---|
| 201 | <term><command>c++filt</command></term>
|
|---|
| 202 | <listitem>
|
|---|
| 203 | <para>Used by the linker to de-mangle C++ and Java symbols and to keep
|
|---|
| 204 | overloaded functions from clashing</para>
|
|---|
| 205 | <indexterm zone="ch-system-binutils c-filt">
|
|---|
| 206 | <primary sortas="b-c++filt">c++filt</primary>
|
|---|
| 207 | </indexterm>
|
|---|
| 208 | </listitem>
|
|---|
| 209 | </varlistentry>
|
|---|
| 210 |
|
|---|
| 211 | <varlistentry id="dwp">
|
|---|
| 212 | <term><command>dwp</command></term>
|
|---|
| 213 | <listitem>
|
|---|
| 214 | <para>The DWARF packaging utility</para>
|
|---|
| 215 | <indexterm zone="ch-system-binutils dwp">
|
|---|
| 216 | <primary sortas="dwp">dwp</primary>
|
|---|
| 217 | </indexterm>
|
|---|
| 218 | </listitem>
|
|---|
| 219 | </varlistentry>
|
|---|
| 220 |
|
|---|
| 221 | <varlistentry id="elfedit">
|
|---|
| 222 | <term><command>elfedit</command></term>
|
|---|
| 223 | <listitem>
|
|---|
| 224 | <para>Updates the ELF headers of ELF files</para>
|
|---|
| 225 | <indexterm zone="ch-system-binutils elfedit">
|
|---|
| 226 | <primary sortas="b-elfedit">elfedit</primary>
|
|---|
| 227 | </indexterm>
|
|---|
| 228 | </listitem>
|
|---|
| 229 | </varlistentry>
|
|---|
| 230 |
|
|---|
| 231 | <varlistentry id="gprof">
|
|---|
| 232 | <term><command>gprof</command></term>
|
|---|
| 233 | <listitem>
|
|---|
| 234 | <para>Displays call graph profile data</para>
|
|---|
| 235 | <indexterm zone="ch-system-binutils gprof">
|
|---|
| 236 | <primary sortas="b-gprof">gprof</primary>
|
|---|
| 237 | </indexterm>
|
|---|
| 238 | </listitem>
|
|---|
| 239 | </varlistentry>
|
|---|
| 240 |
|
|---|
| 241 | <varlistentry id="gprofng">
|
|---|
| 242 | <term><command>gprofng</command></term>
|
|---|
| 243 | <listitem>
|
|---|
| 244 | <para>Gathers and analyzes performance data</para>
|
|---|
| 245 | <indexterm zone="ch-system-binutils gprofng">
|
|---|
| 246 | <primary sortas="b-gprofng">gprofng</primary>
|
|---|
| 247 | </indexterm>
|
|---|
| 248 | </listitem>
|
|---|
| 249 | </varlistentry>
|
|---|
| 250 |
|
|---|
| 251 | <varlistentry id="ld">
|
|---|
| 252 | <term><command>ld</command></term>
|
|---|
| 253 | <listitem>
|
|---|
| 254 | <para>A linker that combines a number of object and archive files
|
|---|
| 255 | into a single file, relocating their data and tying up symbol
|
|---|
| 256 | references</para>
|
|---|
| 257 | <indexterm zone="ch-system-binutils ld">
|
|---|
| 258 | <primary sortas="b-ld">ld</primary>
|
|---|
| 259 | </indexterm>
|
|---|
| 260 | </listitem>
|
|---|
| 261 | </varlistentry>
|
|---|
| 262 |
|
|---|
| 263 | <varlistentry id="ld.bfd">
|
|---|
| 264 | <term><command>ld.bfd</command></term>
|
|---|
| 265 | <listitem>
|
|---|
| 266 | <para>A hard link to <command>ld</command></para>
|
|---|
| 267 | <indexterm zone="ch-system-binutils ld.bfd">
|
|---|
| 268 | <primary sortas="b-ld.bfd">ld.bfd</primary>
|
|---|
| 269 | </indexterm>
|
|---|
| 270 | </listitem>
|
|---|
| 271 | </varlistentry>
|
|---|
| 272 |
|
|---|
| 273 | <varlistentry id="nm">
|
|---|
| 274 | <term><command>nm</command></term>
|
|---|
| 275 | <listitem>
|
|---|
| 276 | <para>Lists the symbols occurring in a given object file</para>
|
|---|
| 277 | <indexterm zone="ch-system-binutils nm">
|
|---|
| 278 | <primary sortas="b-nm">nm</primary>
|
|---|
| 279 | </indexterm>
|
|---|
| 280 | </listitem>
|
|---|
| 281 | </varlistentry>
|
|---|
| 282 |
|
|---|
| 283 | <varlistentry id="objcopy">
|
|---|
| 284 | <term><command>objcopy</command></term>
|
|---|
| 285 | <listitem>
|
|---|
| 286 | <para>Translates one type of object file into another</para>
|
|---|
| 287 | <indexterm zone="ch-system-binutils objcopy">
|
|---|
| 288 | <primary sortas="b-objcopy">objcopy</primary>
|
|---|
| 289 | </indexterm>
|
|---|
| 290 | </listitem>
|
|---|
| 291 | </varlistentry>
|
|---|
| 292 |
|
|---|
| 293 | <varlistentry id="objdump">
|
|---|
| 294 | <term><command>objdump</command></term>
|
|---|
| 295 | <listitem>
|
|---|
| 296 | <para>Displays information about the given object file, with options
|
|---|
| 297 | controlling the particular information to display; the information
|
|---|
| 298 | shown is useful to programmers who are working on the compilation
|
|---|
| 299 | tools</para>
|
|---|
| 300 | <indexterm zone="ch-system-binutils objdump">
|
|---|
| 301 | <primary sortas="b-objdump">objdump</primary>
|
|---|
| 302 | </indexterm>
|
|---|
| 303 | </listitem>
|
|---|
| 304 | </varlistentry>
|
|---|
| 305 |
|
|---|
| 306 | <varlistentry id="ranlib">
|
|---|
| 307 | <term><command>ranlib</command></term>
|
|---|
| 308 | <listitem>
|
|---|
| 309 | <para>Generates an index of the contents of an archive and stores it
|
|---|
| 310 | in the archive; the index lists all of the symbols defined by archive
|
|---|
| 311 | members that are relocatable object files</para>
|
|---|
| 312 | <indexterm zone="ch-system-binutils ranlib">
|
|---|
| 313 | <primary sortas="b-ranlib">ranlib</primary>
|
|---|
| 314 | </indexterm>
|
|---|
| 315 | </listitem>
|
|---|
| 316 | </varlistentry>
|
|---|
| 317 |
|
|---|
| 318 | <varlistentry id="readelf">
|
|---|
| 319 | <term><command>readelf</command></term>
|
|---|
| 320 | <listitem>
|
|---|
| 321 | <para>Displays information about ELF type binaries</para>
|
|---|
| 322 | <indexterm zone="ch-system-binutils readelf">
|
|---|
| 323 | <primary sortas="b-readelf">readelf</primary>
|
|---|
| 324 | </indexterm>
|
|---|
| 325 | </listitem>
|
|---|
| 326 | </varlistentry>
|
|---|
| 327 |
|
|---|
| 328 | <varlistentry id="size">
|
|---|
| 329 | <term><command>size</command></term>
|
|---|
| 330 | <listitem>
|
|---|
| 331 | <para>Lists the section sizes and the total size for the given
|
|---|
| 332 | object files</para>
|
|---|
| 333 | <indexterm zone="ch-system-binutils size">
|
|---|
| 334 | <primary sortas="b-size">size</primary>
|
|---|
| 335 | </indexterm>
|
|---|
| 336 | </listitem>
|
|---|
| 337 | </varlistentry>
|
|---|
| 338 |
|
|---|
| 339 | <varlistentry id="strings">
|
|---|
| 340 | <term><command>strings</command></term>
|
|---|
| 341 | <listitem>
|
|---|
| 342 | <para>Outputs, for each given file, the sequences of printable
|
|---|
| 343 | characters that are of at least the specified length (defaulting to
|
|---|
| 344 | four); for object files, it prints, by default, only the strings from
|
|---|
| 345 | the initializing and loading sections while for other types of files, it
|
|---|
| 346 | scans the entire file</para>
|
|---|
| 347 | <indexterm zone="ch-system-binutils strings">
|
|---|
| 348 | <primary sortas="b-strings">strings</primary>
|
|---|
| 349 | </indexterm>
|
|---|
| 350 | </listitem>
|
|---|
| 351 | </varlistentry>
|
|---|
| 352 |
|
|---|
| 353 | <varlistentry id="strip">
|
|---|
| 354 | <term><command>strip</command></term>
|
|---|
| 355 | <listitem>
|
|---|
| 356 | <para>Discards symbols from object files</para>
|
|---|
| 357 | <indexterm zone="ch-system-binutils strip">
|
|---|
| 358 | <primary sortas="b-strip">strip</primary>
|
|---|
| 359 | </indexterm>
|
|---|
| 360 | </listitem>
|
|---|
| 361 | </varlistentry>
|
|---|
| 362 |
|
|---|
| 363 | <varlistentry id="libbfd">
|
|---|
| 364 | <term><filename class="libraryfile">libbfd</filename></term>
|
|---|
| 365 | <listitem>
|
|---|
| 366 | <para>The Binary File Descriptor library</para>
|
|---|
| 367 | <indexterm zone="ch-system-binutils libbfd">
|
|---|
| 368 | <primary sortas="c-libbfd">libbfd</primary>
|
|---|
| 369 | </indexterm>
|
|---|
| 370 | </listitem>
|
|---|
| 371 | </varlistentry>
|
|---|
| 372 |
|
|---|
| 373 | <varlistentry id="libctf">
|
|---|
| 374 | <term><filename class="libraryfile">libctf</filename></term>
|
|---|
| 375 | <listitem>
|
|---|
| 376 | <para>The Compat ANSI-C Type Format debugging support library</para>
|
|---|
| 377 | <indexterm zone="ch-system-binutils libctf">
|
|---|
| 378 | <primary sortas="c-libctf">libctf</primary>
|
|---|
| 379 | </indexterm>
|
|---|
| 380 | </listitem>
|
|---|
| 381 | </varlistentry>
|
|---|
| 382 |
|
|---|
| 383 | <varlistentry id="libctf-nobfd">
|
|---|
| 384 | <term><filename class="libraryfile">libctf-nobfd</filename></term>
|
|---|
| 385 | <listitem>
|
|---|
| 386 | <para>A libctf variant which does not use libbfd functionality</para>
|
|---|
| 387 | <indexterm zone="ch-system-binutils libctf-nobfd">
|
|---|
| 388 | <primary sortas="c-libctf-nobfd">libctf-nobfd</primary>
|
|---|
| 389 | </indexterm>
|
|---|
| 390 | </listitem>
|
|---|
| 391 | </varlistentry>
|
|---|
| 392 |
|
|---|
| 393 | <varlistentry id="libopcodes">
|
|---|
| 394 | <term><filename class="libraryfile">libopcodes</filename></term>
|
|---|
| 395 | <listitem>
|
|---|
| 396 | <para>A library for dealing with opcodes—the <quote>readable
|
|---|
| 397 | text</quote> versions of instructions for the processor;
|
|---|
| 398 | it is used for building utilities like
|
|---|
| 399 | <command>objdump</command></para>
|
|---|
| 400 | <indexterm zone="ch-system-binutils libopcodes">
|
|---|
| 401 | <primary sortas="c-libopcodes">libopcodes</primary>
|
|---|
| 402 | </indexterm>
|
|---|
| 403 | </listitem>
|
|---|
| 404 | </varlistentry>
|
|---|
| 405 |
|
|---|
| 406 | <varlistentry id="libsframe">
|
|---|
| 407 | <term><filename class="libraryfile">libsframe</filename></term>
|
|---|
| 408 | <listitem>
|
|---|
| 409 | <para>A library to support online backtracing using a
|
|---|
| 410 | simple unwinder</para>
|
|---|
| 411 | <indexterm zone="ch-system-binutils libsframe">
|
|---|
| 412 | <primary sortas="c-libsframe">libsframe</primary>
|
|---|
| 413 | </indexterm>
|
|---|
| 414 | </listitem>
|
|---|
| 415 | </varlistentry>
|
|---|
| 416 |
|
|---|
| 417 | </variablelist>
|
|---|
| 418 |
|
|---|
| 419 | </sect2>
|
|---|
| 420 |
|
|---|
| 421 | </sect1>
|
|---|
