* bfd/elf32-arm.h (arm_print_private_bfd_data): Add EABI v3.
[deliverable/binutils-gdb.git] / gas / doc / as.texinfo
1 \input texinfo @c -*-Texinfo-*-
2 @c Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 @c 2001, 2002, 2003, 2004
4 @c Free Software Foundation, Inc.
5 @c UPDATE!! On future updates--
6 @c (1) check for new machine-dep cmdline options in
7 @c md_parse_option definitions in config/tc-*.c
8 @c (2) for platform-specific directives, examine md_pseudo_op
9 @c in config/tc-*.c
10 @c (3) for object-format specific directives, examine obj_pseudo_op
11 @c in config/obj-*.c
12 @c (4) portable directives in potable[] in read.c
13 @c %**start of header
14 @setfilename as.info
15 @c ---config---
16 @macro gcctabopt{body}
17 @code{\body\}
18 @end macro
19 @c defaults, config file may override:
20 @set have-stabs
21 @c ---
22 @c man begin NAME
23 @c ---
24 @include asconfig.texi
25 @include gasver.texi
26 @c ---
27 @c man end
28 @c ---
29 @c common OR combinations of conditions
30 @ifset COFF
31 @set COFF-ELF
32 @end ifset
33 @ifset ELF
34 @set COFF-ELF
35 @end ifset
36 @ifset AOUT
37 @set aout-bout
38 @end ifset
39 @ifset ARM/Thumb
40 @set ARM
41 @end ifset
42 @ifset BOUT
43 @set aout-bout
44 @end ifset
45 @ifset H8/300
46 @set H8
47 @end ifset
48 @ifset H8/500
49 @set H8
50 @end ifset
51 @ifset SH
52 @set H8
53 @end ifset
54 @ifset HPPA
55 @set abnormal-separator
56 @end ifset
57 @c ------------
58 @ifset GENERIC
59 @settitle Using @value{AS}
60 @end ifset
61 @ifclear GENERIC
62 @settitle Using @value{AS} (@value{TARGET})
63 @end ifclear
64 @setchapternewpage odd
65 @c %**end of header
66
67 @c @smallbook
68 @c @set SMALL
69 @c WARE! Some of the machine-dependent sections contain tables of machine
70 @c instructions. Except in multi-column format, these tables look silly.
71 @c Unfortunately, Texinfo doesn't have a general-purpose multi-col format, so
72 @c the multi-col format is faked within @example sections.
73 @c
74 @c Again unfortunately, the natural size that fits on a page, for these tables,
75 @c is different depending on whether or not smallbook is turned on.
76 @c This matters, because of order: text flow switches columns at each page
77 @c break.
78 @c
79 @c The format faked in this source works reasonably well for smallbook,
80 @c not well for the default large-page format. This manual expects that if you
81 @c turn on @smallbook, you will also uncomment the "@set SMALL" to enable the
82 @c tables in question. You can turn on one without the other at your
83 @c discretion, of course.
84 @ifinfo
85 @set SMALL
86 @c the insn tables look just as silly in info files regardless of smallbook,
87 @c might as well show 'em anyways.
88 @end ifinfo
89
90 @ifinfo
91 @format
92 START-INFO-DIR-ENTRY
93 * As: (as). The GNU assembler.
94 * Gas: (as). The GNU assembler.
95 END-INFO-DIR-ENTRY
96 @end format
97 @end ifinfo
98
99 @finalout
100 @syncodeindex ky cp
101
102 @ifinfo
103 This file documents the GNU Assembler "@value{AS}".
104
105 @c man begin COPYRIGHT
106 Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
107
108 Permission is granted to copy, distribute and/or modify this document
109 under the terms of the GNU Free Documentation License, Version 1.1
110 or any later version published by the Free Software Foundation;
111 with no Invariant Sections, with no Front-Cover Texts, and with no
112 Back-Cover Texts. A copy of the license is included in the
113 section entitled ``GNU Free Documentation License''.
114
115 @c man end
116
117 @ignore
118 Permission is granted to process this file through Tex and print the
119 results, provided the printed document carries copying permission
120 notice identical to this one except for the removal of this paragraph
121 (this paragraph not being relevant to the printed manual).
122
123 @end ignore
124 @end ifinfo
125
126 @titlepage
127 @title Using @value{AS}
128 @subtitle The @sc{gnu} Assembler
129 @ifclear GENERIC
130 @subtitle for the @value{TARGET} family
131 @end ifclear
132 @sp 1
133 @subtitle Version @value{VERSION}
134 @sp 1
135 @sp 13
136 The Free Software Foundation Inc. thanks The Nice Computer
137 Company of Australia for loaning Dean Elsner to write the
138 first (Vax) version of @command{as} for Project @sc{gnu}.
139 The proprietors, management and staff of TNCCA thank FSF for
140 distracting the boss while they got some work
141 done.
142 @sp 3
143 @author Dean Elsner, Jay Fenlason & friends
144 @page
145 @tex
146 {\parskip=0pt
147 \hfill {\it Using {\tt @value{AS}}}\par
148 \hfill Edited by Cygnus Support\par
149 }
150 %"boxit" macro for figures:
151 %Modified from Knuth's ``boxit'' macro from TeXbook (answer to exercise 21.3)
152 \gdef\boxit#1#2{\vbox{\hrule\hbox{\vrule\kern3pt
153 \vbox{\parindent=0pt\parskip=0pt\hsize=#1\kern3pt\strut\hfil
154 #2\hfil\strut\kern3pt}\kern3pt\vrule}\hrule}}%box with visible outline
155 \gdef\ibox#1#2{\hbox to #1{#2\hfil}\kern8pt}% invisible box
156 @end tex
157
158 @vskip 0pt plus 1filll
159 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
160
161 Permission is granted to copy, distribute and/or modify this document
162 under the terms of the GNU Free Documentation License, Version 1.1
163 or any later version published by the Free Software Foundation;
164 with no Invariant Sections, with no Front-Cover Texts, and with no
165 Back-Cover Texts. A copy of the license is included in the
166 section entitled ``GNU Free Documentation License''.
167
168 @end titlepage
169
170 @ifnottex
171 @node Top
172 @top Using @value{AS}
173
174 This file is a user guide to the @sc{gnu} assembler @command{@value{AS}} version
175 @value{VERSION}.
176 @ifclear GENERIC
177 This version of the file describes @command{@value{AS}} configured to generate
178 code for @value{TARGET} architectures.
179 @end ifclear
180
181 This document is distributed under the terms of the GNU Free
182 Documentation License. A copy of the license is included in the
183 section entitled ``GNU Free Documentation License''.
184
185 @menu
186 * Overview:: Overview
187 * Invoking:: Command-Line Options
188 * Syntax:: Syntax
189 * Sections:: Sections and Relocation
190 * Symbols:: Symbols
191 * Expressions:: Expressions
192 * Pseudo Ops:: Assembler Directives
193 * Machine Dependencies:: Machine Dependent Features
194 * Reporting Bugs:: Reporting Bugs
195 * Acknowledgements:: Who Did What
196 * GNU Free Documentation License:: GNU Free Documentation License
197 * Index:: Index
198 @end menu
199 @end ifnottex
200
201 @node Overview
202 @chapter Overview
203 @iftex
204 This manual is a user guide to the @sc{gnu} assembler @command{@value{AS}}.
205 @ifclear GENERIC
206 This version of the manual describes @command{@value{AS}} configured to generate
207 code for @value{TARGET} architectures.
208 @end ifclear
209 @end iftex
210
211 @cindex invocation summary
212 @cindex option summary
213 @cindex summary of options
214 Here is a brief summary of how to invoke @command{@value{AS}}. For details,
215 @pxref{Invoking,,Command-Line Options}.
216
217 @c man title AS the portable GNU assembler.
218
219 @ignore
220 @c man begin SEEALSO
221 gcc(1), ld(1), and the Info entries for @file{binutils} and @file{ld}.
222 @c man end
223 @end ignore
224
225 @c We don't use deffn and friends for the following because they seem
226 @c to be limited to one line for the header.
227 @smallexample
228 @c man begin SYNOPSIS
229 @value{AS} [@b{-a}[@b{cdhlns}][=@var{file}]] [@b{-D}] [@b{--defsym} @var{sym}=@var{val}]
230 [@b{-f}] [@b{--gstabs}] [@b{--gstabs+}] [@b{--gdwarf2}] [@b{--help}]
231 [@b{-I} @var{dir}] [@b{-J}] [@b{-K}] [@b{-L}]
232 [@b{--listing-lhs-width}=@var{NUM}] [@b{--listing-lhs-width2}=@var{NUM}]
233 [@b{--listing-rhs-width}=@var{NUM}] [@b{--listing-cont-lines}=@var{NUM}]
234 [@b{--keep-locals}] [@b{-o} @var{objfile}] [@b{-R}] [@b{--statistics}] [@b{-v}]
235 [@b{-version}] [@b{--version}] [@b{-W}] [@b{--warn}] [@b{--fatal-warnings}]
236 [@b{-w}] [@b{-x}] [@b{-Z}] [@b{--target-help}] [@var{target-options}]
237 [@b{--}|@var{files} @dots{}]
238 @c
239 @c Target dependent options are listed below. Keep the list sorted.
240 @c Add an empty line for separation.
241 @ifset A29K
242 @c am29k has no machine-dependent assembler options
243 @end ifset
244 @ifset ALPHA
245
246 @emph{Target Alpha options:}
247 [@b{-m@var{cpu}}]
248 [@b{-mdebug} | @b{-no-mdebug}]
249 [@b{-relax}] [@b{-g}] [@b{-G@var{size}}]
250 [@b{-F}] [@b{-32addr}]
251 @end ifset
252 @ifset ARC
253
254 @emph{Target ARC options:}
255 [@b{-marc[5|6|7|8]}]
256 [@b{-EB}|@b{-EL}]
257 @end ifset
258 @ifset ARM
259
260 @emph{Target ARM options:}
261 @c Don't document the deprecated options
262 [@b{-mcpu}=@var{processor}[+@var{extension}@dots{}]]
263 [@b{-march}=@var{architecture}[+@var{extension}@dots{}]]
264 [@b{-mfpu}=@var{floating-point-format}]
265 [@b{-mfloat-abi}=@var{abi}]
266 [@b{-meabi}=@var{ver}]
267 [@b{-mthumb}]
268 [@b{-EB}|@b{-EL}]
269 [@b{-mapcs-32}|@b{-mapcs-26}|@b{-mapcs-float}|
270 @b{-mapcs-reentrant}]
271 [@b{-mthumb-interwork}] [@b{-moabi}] [@b{-k}]
272 @end ifset
273 @ifset CRIS
274
275 @emph{Target CRIS options:}
276 [@b{--underscore} | @b{--no-underscore}]
277 [@b{--pic}] [@b{-N}]
278 [@b{--emulation=criself} | @b{--emulation=crisaout}]
279 @c Deprecated -- deliberately not documented.
280 @c [@b{-h}] [@b{-H}]
281 @end ifset
282 @ifset D10V
283
284 @emph{Target D10V options:}
285 [@b{-O}]
286 @end ifset
287 @ifset D30V
288
289 @emph{Target D30V options:}
290 [@b{-O}|@b{-n}|@b{-N}]
291 @end ifset
292 @ifset H8
293 @c Renesas family chips have no machine-dependent assembler options
294 @end ifset
295 @ifset HPPA
296 @c HPPA has no machine-dependent assembler options (yet).
297 @end ifset
298 @ifset I80386
299
300 @emph{Target i386 options:}
301 [@b{--32}|@b{--64}] [@b{-n}]
302 @end ifset
303 @ifset I960
304
305 @emph{Target i960 options:}
306 @c see md_parse_option in tc-i960.c
307 [@b{-ACA}|@b{-ACA_A}|@b{-ACB}|@b{-ACC}|@b{-AKA}|@b{-AKB}|
308 @b{-AKC}|@b{-AMC}]
309 [@b{-b}] [@b{-no-relax}]
310 @end ifset
311 @ifset IA64
312
313 @emph{Target IA-64 options:}
314 [@b{-mconstant-gp}|@b{-mauto-pic}]
315 [@b{-milp32}|@b{-milp64}|@b{-mlp64}|@b{-mp64}]
316 [@b{-mle}|@b{mbe}]
317 [@b{-x}|@b{-xexplicit}] [@b{-xauto}] [@b{-xdebug}]
318 @end ifset
319 @ifset IP2K
320
321 @emph{Target IP2K options:}
322 [@b{-mip2022}|@b{-mip2022ext}]
323 @end ifset
324 @ifset M32R
325
326 @emph{Target M32R options:}
327 [@b{--m32rx}|@b{--[no-]warn-explicit-parallel-conflicts}|
328 @b{--W[n]p}]
329 @end ifset
330 @ifset M680X0
331
332 @emph{Target M680X0 options:}
333 [@b{-l}] [@b{-m68000}|@b{-m68010}|@b{-m68020}|@dots{}]
334 @end ifset
335 @ifset M68HC11
336
337 @emph{Target M68HC11 options:}
338 [@b{-m68hc11}|@b{-m68hc12}|@b{-m68hcs12}]
339 [@b{-mshort}|@b{-mlong}]
340 [@b{-mshort-double}|@b{-mlong-double}]
341 [@b{--force-long-branchs}] [@b{--short-branchs}]
342 [@b{--strict-direct-mode}] [@b{--print-insn-syntax}]
343 [@b{--print-opcodes}] [@b{--generate-example}]
344 @end ifset
345 @ifset MCORE
346
347 @emph{Target MCORE options:}
348 [@b{-jsri2bsr}] [@b{-sifilter}] [@b{-relax}]
349 [@b{-mcpu=[210|340]}]
350 @end ifset
351 @ifset MIPS
352
353 @emph{Target MIPS options:}
354 [@b{-nocpp}] [@b{-EL}] [@b{-EB}] [@b{-O}[@var{optimization level}]]
355 [@b{-g}[@var{debug level}]] [@b{-G} @var{num}] [@b{-KPIC}] [@b{-call_shared}]
356 [@b{-non_shared}] [@b{-xgot}] [@b{--membedded-pic}]
357 [@b{-mabi}=@var{ABI}] [@b{-32}] [@b{-n32}] [@b{-64}] [@b{-mfp32}] [@b{-mgp32}]
358 [@b{-march}=@var{CPU}] [@b{-mtune}=@var{CPU}] [@b{-mips1}] [@b{-mips2}]
359 [@b{-mips3}] [@b{-mips4}] [@b{-mips5}] [@b{-mips32}] [@b{-mips32r2}]
360 [@b{-mips64}] [@b{-mips64r2}]
361 [@b{-construct-floats}] [@b{-no-construct-floats}]
362 [@b{-trap}] [@b{-no-break}] [@b{-break}] [@b{-no-trap}]
363 [@b{-mfix7000}] [@b{-mno-fix7000}]
364 [@b{-mips16}] [@b{-no-mips16}]
365 [@b{-mips3d}] [@b{-no-mips3d}]
366 [@b{-mdmx}] [@b{-no-mdmx}]
367 [@b{-mdebug}] [@b{-no-mdebug}]
368 [@b{-mpdr}] [@b{-mno-pdr}]
369 @end ifset
370 @ifset MMIX
371
372 @emph{Target MMIX options:}
373 [@b{--fixed-special-register-names}] [@b{--globalize-symbols}]
374 [@b{--gnu-syntax}] [@b{--relax}] [@b{--no-predefined-symbols}]
375 [@b{--no-expand}] [@b{--no-merge-gregs}] [@b{-x}]
376 [@b{--linker-allocated-gregs}]
377 @end ifset
378 @ifset PDP11
379
380 @emph{Target PDP11 options:}
381 [@b{-mpic}|@b{-mno-pic}] [@b{-mall}] [@b{-mno-extensions}]
382 [@b{-m}@var{extension}|@b{-mno-}@var{extension}]
383 [@b{-m}@var{cpu}] [@b{-m}@var{machine}]
384 @end ifset
385 @ifset PJ
386
387 @emph{Target picoJava options:}
388 [@b{-mb}|@b{-me}]
389 @end ifset
390 @ifset PPC
391
392 @emph{Target PowerPC options:}
393 [@b{-mpwrx}|@b{-mpwr2}|@b{-mpwr}|@b{-m601}|@b{-mppc}|@b{-mppc32}|@b{-m603}|@b{-m604}|
394 @b{-m403}|@b{-m405}|@b{-mppc64}|@b{-m620}|@b{-mppc64bridge}|@b{-mbooke}|
395 @b{-mbooke32}|@b{-mbooke64}]
396 [@b{-mcom}|@b{-many}|@b{-maltivec}] [@b{-memb}]
397 [@b{-mregnames}|@b{-mno-regnames}]
398 [@b{-mrelocatable}|@b{-mrelocatable-lib}]
399 [@b{-mlittle}|@b{-mlittle-endian}|@b{-mbig}|@b{-mbig-endian}]
400 [@b{-msolaris}|@b{-mno-solaris}]
401 @end ifset
402 @ifset SPARC
403
404 @emph{Target SPARC options:}
405 @c The order here is important. See c-sparc.texi.
406 [@b{-Av6}|@b{-Av7}|@b{-Av8}|@b{-Asparclet}|@b{-Asparclite}
407 @b{-Av8plus}|@b{-Av8plusa}|@b{-Av9}|@b{-Av9a}]
408 [@b{-xarch=v8plus}|@b{-xarch=v8plusa}] [@b{-bump}]
409 [@b{-32}|@b{-64}]
410 @end ifset
411 @ifset TIC54X
412
413 @emph{Target TIC54X options:}
414 [@b{-mcpu=54[123589]}|@b{-mcpu=54[56]lp}] [@b{-mfar-mode}|@b{-mf}]
415 [@b{-merrors-to-file} @var{<filename>}|@b{-me} @var{<filename>}]
416 @end ifset
417 @ifset Z8000
418 @c Z8000 has no machine-dependent assembler options
419 @end ifset
420 @ifset XTENSA
421
422 @emph{Target Xtensa options:}
423 [@b{--[no-]density}] [@b{--[no-]relax}] [@b{--[no-]generics}]
424 [@b{--[no-]text-section-literals}]
425 [@b{--[no-]target-align}] [@b{--[no-]longcalls}]
426 @end ifset
427 @c man end
428 @end smallexample
429
430 @c man begin OPTIONS
431
432 @table @gcctabopt
433 @item -a[cdhlmns]
434 Turn on listings, in any of a variety of ways:
435
436 @table @gcctabopt
437 @item -ac
438 omit false conditionals
439
440 @item -ad
441 omit debugging directives
442
443 @item -ah
444 include high-level source
445
446 @item -al
447 include assembly
448
449 @item -am
450 include macro expansions
451
452 @item -an
453 omit forms processing
454
455 @item -as
456 include symbols
457
458 @item =file
459 set the name of the listing file
460 @end table
461
462 You may combine these options; for example, use @samp{-aln} for assembly
463 listing without forms processing. The @samp{=file} option, if used, must be
464 the last one. By itself, @samp{-a} defaults to @samp{-ahls}.
465
466 @item -D
467 Ignored. This option is accepted for script compatibility with calls to
468 other assemblers.
469
470 @item --defsym @var{sym}=@var{value}
471 Define the symbol @var{sym} to be @var{value} before assembling the input file.
472 @var{value} must be an integer constant. As in C, a leading @samp{0x}
473 indicates a hexadecimal value, and a leading @samp{0} indicates an octal value.
474
475 @item -f
476 ``fast''---skip whitespace and comment preprocessing (assume source is
477 compiler output).
478
479 @item --gstabs
480 Generate stabs debugging information for each assembler line. This
481 may help debugging assembler code, if the debugger can handle it.
482
483 @item --gstabs+
484 Generate stabs debugging information for each assembler line, with GNU
485 extensions that probably only gdb can handle, and that could make other
486 debuggers crash or refuse to read your program. This
487 may help debugging assembler code. Currently the only GNU extension is
488 the location of the current working directory at assembling time.
489
490 @item --gdwarf2
491 Generate DWARF2 debugging information for each assembler line. This
492 may help debugging assembler code, if the debugger can handle it. Note---this
493 option is only supported by some targets, not all of them.
494
495 @item --help
496 Print a summary of the command line options and exit.
497
498 @item --target-help
499 Print a summary of all target specific options and exit.
500
501 @item -I @var{dir}
502 Add directory @var{dir} to the search list for @code{.include} directives.
503
504 @item -J
505 Don't warn about signed overflow.
506
507 @item -K
508 @ifclear DIFF-TBL-KLUGE
509 This option is accepted but has no effect on the @value{TARGET} family.
510 @end ifclear
511 @ifset DIFF-TBL-KLUGE
512 Issue warnings when difference tables altered for long displacements.
513 @end ifset
514
515 @item -L
516 @itemx --keep-locals
517 Keep (in the symbol table) local symbols. On traditional a.out systems
518 these start with @samp{L}, but different systems have different local
519 label prefixes.
520
521 @item --listing-lhs-width=@var{number}
522 Set the maximum width, in words, of the output data column for an assembler
523 listing to @var{number}.
524
525 @item --listing-lhs-width2=@var{number}
526 Set the maximum width, in words, of the output data column for continuation
527 lines in an assembler listing to @var{number}.
528
529 @item --listing-rhs-width=@var{number}
530 Set the maximum width of an input source line, as displayed in a listing, to
531 @var{number} bytes.
532
533 @item --listing-cont-lines=@var{number}
534 Set the maximum number of lines printed in a listing for a single line of input
535 to @var{number} + 1.
536
537 @item -o @var{objfile}
538 Name the object-file output from @command{@value{AS}} @var{objfile}.
539
540 @item -R
541 Fold the data section into the text section.
542
543 @item --statistics
544 Print the maximum space (in bytes) and total time (in seconds) used by
545 assembly.
546
547 @item --strip-local-absolute
548 Remove local absolute symbols from the outgoing symbol table.
549
550 @item -v
551 @itemx -version
552 Print the @command{as} version.
553
554 @item --version
555 Print the @command{as} version and exit.
556
557 @item -W
558 @itemx --no-warn
559 Suppress warning messages.
560
561 @item --fatal-warnings
562 Treat warnings as errors.
563
564 @item --warn
565 Don't suppress warning messages or treat them as errors.
566
567 @item -w
568 Ignored.
569
570 @item -x
571 Ignored.
572
573 @item -Z
574 Generate an object file even after errors.
575
576 @item -- | @var{files} @dots{}
577 Standard input, or source files to assemble.
578
579 @end table
580
581 @ifset ARC
582 The following options are available when @value{AS} is configured for
583 an ARC processor.
584
585 @table @gcctabopt
586 @item -marc[5|6|7|8]
587 This option selects the core processor variant.
588 @item -EB | -EL
589 Select either big-endian (-EB) or little-endian (-EL) output.
590 @end table
591 @end ifset
592
593 @ifset ARM
594 The following options are available when @value{AS} is configured for the ARM
595 processor family.
596
597 @table @gcctabopt
598 @item -mcpu=@var{processor}[+@var{extension}@dots{}]
599 Specify which ARM processor variant is the target.
600 @item -march=@var{architecture}[+@var{extension}@dots{}]
601 Specify which ARM architecture variant is used by the target.
602 @item -mfpu=@var{floating-point-format}
603 Select which Floating Point architecture is the target.
604 @item -mfloat-abi=@var{abi}
605 Select which floating point ABI is in use.
606 @item -mthumb
607 Enable Thumb only instruction decoding.
608 @item -mapcs-32 | -mapcs-26 | -mapcs-float | -mapcs-reentrant | -moabi
609 Select which procedure calling convention is in use.
610 @item -EB | -EL
611 Select either big-endian (-EB) or little-endian (-EL) output.
612 @item -mthumb-interwork
613 Specify that the code has been generated with interworking between Thumb and
614 ARM code in mind.
615 @item -k
616 Specify that PIC code has been generated.
617 @end table
618 @end ifset
619
620 @ifset CRIS
621 See the info pages for documentation of the CRIS-specific options.
622 @end ifset
623
624 @ifset D10V
625 The following options are available when @value{AS} is configured for
626 a D10V processor.
627 @table @gcctabopt
628 @cindex D10V optimization
629 @cindex optimization, D10V
630 @item -O
631 Optimize output by parallelizing instructions.
632 @end table
633 @end ifset
634
635 @ifset D30V
636 The following options are available when @value{AS} is configured for a D30V
637 processor.
638 @table @gcctabopt
639 @cindex D30V optimization
640 @cindex optimization, D30V
641 @item -O
642 Optimize output by parallelizing instructions.
643
644 @cindex D30V nops
645 @item -n
646 Warn when nops are generated.
647
648 @cindex D30V nops after 32-bit multiply
649 @item -N
650 Warn when a nop after a 32-bit multiply instruction is generated.
651 @end table
652 @end ifset
653
654 @ifset I960
655 The following options are available when @value{AS} is configured for the
656 Intel 80960 processor.
657
658 @table @gcctabopt
659 @item -ACA | -ACA_A | -ACB | -ACC | -AKA | -AKB | -AKC | -AMC
660 Specify which variant of the 960 architecture is the target.
661
662 @item -b
663 Add code to collect statistics about branches taken.
664
665 @item -no-relax
666 Do not alter compare-and-branch instructions for long displacements;
667 error if necessary.
668
669 @end table
670 @end ifset
671
672 @ifset IP2K
673 The following options are available when @value{AS} is configured for the
674 Ubicom IP2K series.
675
676 @table @gcctabopt
677
678 @item -mip2022ext
679 Specifies that the extended IP2022 instructions are allowed.
680
681 @item -mip2022
682 Restores the default behaviour, which restricts the permitted instructions to
683 just the basic IP2022 ones.
684
685 @end table
686 @end ifset
687
688 @ifset M32R
689 The following options are available when @value{AS} is configured for the
690 Renesas M32R (formerly Mitsubishi M32R) series.
691
692 @table @gcctabopt
693
694 @item --m32rx
695 Specify which processor in the M32R family is the target. The default
696 is normally the M32R, but this option changes it to the M32RX.
697
698 @item --warn-explicit-parallel-conflicts or --Wp
699 Produce warning messages when questionable parallel constructs are
700 encountered.
701
702 @item --no-warn-explicit-parallel-conflicts or --Wnp
703 Do not produce warning messages when questionable parallel constructs are
704 encountered.
705
706 @end table
707 @end ifset
708
709 @ifset M680X0
710 The following options are available when @value{AS} is configured for the
711 Motorola 68000 series.
712
713 @table @gcctabopt
714
715 @item -l
716 Shorten references to undefined symbols, to one word instead of two.
717
718 @item -m68000 | -m68008 | -m68010 | -m68020 | -m68030
719 @itemx | -m68040 | -m68060 | -m68302 | -m68331 | -m68332
720 @itemx | -m68333 | -m68340 | -mcpu32 | -m5200
721 Specify what processor in the 68000 family is the target. The default
722 is normally the 68020, but this can be changed at configuration time.
723
724 @item -m68881 | -m68882 | -mno-68881 | -mno-68882
725 The target machine does (or does not) have a floating-point coprocessor.
726 The default is to assume a coprocessor for 68020, 68030, and cpu32. Although
727 the basic 68000 is not compatible with the 68881, a combination of the
728 two can be specified, since it's possible to do emulation of the
729 coprocessor instructions with the main processor.
730
731 @item -m68851 | -mno-68851
732 The target machine does (or does not) have a memory-management
733 unit coprocessor. The default is to assume an MMU for 68020 and up.
734
735 @end table
736 @end ifset
737
738 @ifset PDP11
739
740 For details about the PDP-11 machine dependent features options,
741 see @ref{PDP-11-Options}.
742
743 @table @gcctabopt
744 @item -mpic | -mno-pic
745 Generate position-independent (or position-dependent) code. The
746 default is @option{-mpic}.
747
748 @item -mall
749 @itemx -mall-extensions
750 Enable all instruction set extensions. This is the default.
751
752 @item -mno-extensions
753 Disable all instruction set extensions.
754
755 @item -m@var{extension} | -mno-@var{extension}
756 Enable (or disable) a particular instruction set extension.
757
758 @item -m@var{cpu}
759 Enable the instruction set extensions supported by a particular CPU, and
760 disable all other extensions.
761
762 @item -m@var{machine}
763 Enable the instruction set extensions supported by a particular machine
764 model, and disable all other extensions.
765 @end table
766
767 @end ifset
768
769 @ifset PJ
770 The following options are available when @value{AS} is configured for
771 a picoJava processor.
772
773 @table @gcctabopt
774
775 @cindex PJ endianness
776 @cindex endianness, PJ
777 @cindex big endian output, PJ
778 @item -mb
779 Generate ``big endian'' format output.
780
781 @cindex little endian output, PJ
782 @item -ml
783 Generate ``little endian'' format output.
784
785 @end table
786 @end ifset
787
788 @ifset M68HC11
789 The following options are available when @value{AS} is configured for the
790 Motorola 68HC11 or 68HC12 series.
791
792 @table @gcctabopt
793
794 @item -m68hc11 | -m68hc12 | -m68hcs12
795 Specify what processor is the target. The default is
796 defined by the configuration option when building the assembler.
797
798 @item -mshort
799 Specify to use the 16-bit integer ABI.
800
801 @item -mlong
802 Specify to use the 32-bit integer ABI.
803
804 @item -mshort-double
805 Specify to use the 32-bit double ABI.
806
807 @item -mlong-double
808 Specify to use the 64-bit double ABI.
809
810 @item --force-long-branchs
811 Relative branches are turned into absolute ones. This concerns
812 conditional branches, unconditional branches and branches to a
813 sub routine.
814
815 @item -S | --short-branchs
816 Do not turn relative branchs into absolute ones
817 when the offset is out of range.
818
819 @item --strict-direct-mode
820 Do not turn the direct addressing mode into extended addressing mode
821 when the instruction does not support direct addressing mode.
822
823 @item --print-insn-syntax
824 Print the syntax of instruction in case of error.
825
826 @item --print-opcodes
827 print the list of instructions with syntax and then exit.
828
829 @item --generate-example
830 print an example of instruction for each possible instruction and then exit.
831 This option is only useful for testing @command{@value{AS}}.
832
833 @end table
834 @end ifset
835
836 @ifset SPARC
837 The following options are available when @command{@value{AS}} is configured
838 for the SPARC architecture:
839
840 @table @gcctabopt
841 @item -Av6 | -Av7 | -Av8 | -Asparclet | -Asparclite
842 @itemx -Av8plus | -Av8plusa | -Av9 | -Av9a
843 Explicitly select a variant of the SPARC architecture.
844
845 @samp{-Av8plus} and @samp{-Av8plusa} select a 32 bit environment.
846 @samp{-Av9} and @samp{-Av9a} select a 64 bit environment.
847
848 @samp{-Av8plusa} and @samp{-Av9a} enable the SPARC V9 instruction set with
849 UltraSPARC extensions.
850
851 @item -xarch=v8plus | -xarch=v8plusa
852 For compatibility with the Solaris v9 assembler. These options are
853 equivalent to -Av8plus and -Av8plusa, respectively.
854
855 @item -bump
856 Warn when the assembler switches to another architecture.
857 @end table
858 @end ifset
859
860 @ifset TIC54X
861 The following options are available when @value{AS} is configured for the 'c54x
862 architecture.
863
864 @table @gcctabopt
865 @item -mfar-mode
866 Enable extended addressing mode. All addresses and relocations will assume
867 extended addressing (usually 23 bits).
868 @item -mcpu=@var{CPU_VERSION}
869 Sets the CPU version being compiled for.
870 @item -merrors-to-file @var{FILENAME}
871 Redirect error output to a file, for broken systems which don't support such
872 behaviour in the shell.
873 @end table
874 @end ifset
875
876 @ifset MIPS
877 The following options are available when @value{AS} is configured for
878 a @sc{mips} processor.
879
880 @table @gcctabopt
881 @item -G @var{num}
882 This option sets the largest size of an object that can be referenced
883 implicitly with the @code{gp} register. It is only accepted for targets that
884 use ECOFF format, such as a DECstation running Ultrix. The default value is 8.
885
886 @cindex MIPS endianness
887 @cindex endianness, MIPS
888 @cindex big endian output, MIPS
889 @item -EB
890 Generate ``big endian'' format output.
891
892 @cindex little endian output, MIPS
893 @item -EL
894 Generate ``little endian'' format output.
895
896 @cindex MIPS ISA
897 @item -mips1
898 @itemx -mips2
899 @itemx -mips3
900 @itemx -mips4
901 @itemx -mips5
902 @itemx -mips32
903 @itemx -mips32r2
904 @itemx -mips64
905 @itemx -mips64r2
906 Generate code for a particular @sc{mips} Instruction Set Architecture level.
907 @samp{-mips1} is an alias for @samp{-march=r3000}, @samp{-mips2} is an
908 alias for @samp{-march=r6000}, @samp{-mips3} is an alias for
909 @samp{-march=r4000} and @samp{-mips4} is an alias for @samp{-march=r8000}.
910 @samp{-mips5}, @samp{-mips32}, @samp{-mips32r2}, @samp{-mips64}, and
911 @samp{-mips64r2}
912 correspond to generic
913 @samp{MIPS V}, @samp{MIPS32}, @samp{MIPS32 Release 2}, @samp{MIPS64},
914 and @samp{MIPS64 Release 2}
915 ISA processors, respectively.
916
917 @item -march=@var{CPU}
918 Generate code for a particular @sc{mips} cpu.
919
920 @item -mtune=@var{cpu}
921 Schedule and tune for a particular @sc{mips} cpu.
922
923 @item -mfix7000
924 @itemx -mno-fix7000
925 Cause nops to be inserted if the read of the destination register
926 of an mfhi or mflo instruction occurs in the following two instructions.
927
928 @item -mdebug
929 @itemx -no-mdebug
930 Cause stabs-style debugging output to go into an ECOFF-style .mdebug
931 section instead of the standard ELF .stabs sections.
932
933 @item -mpdr
934 @itemx -mno-pdr
935 Control generation of @code{.pdr} sections.
936
937 @item -mgp32
938 @itemx -mfp32
939 The register sizes are normally inferred from the ISA and ABI, but these
940 flags force a certain group of registers to be treated as 32 bits wide at
941 all times. @samp{-mgp32} controls the size of general-purpose registers
942 and @samp{-mfp32} controls the size of floating-point registers.
943
944 @item -mips16
945 @itemx -no-mips16
946 Generate code for the MIPS 16 processor. This is equivalent to putting
947 @code{.set mips16} at the start of the assembly file. @samp{-no-mips16}
948 turns off this option.
949
950 @item -mips3d
951 @itemx -no-mips3d
952 Generate code for the MIPS-3D Application Specific Extension.
953 This tells the assembler to accept MIPS-3D instructions.
954 @samp{-no-mips3d} turns off this option.
955
956 @item -mdmx
957 @itemx -no-mdmx
958 Generate code for the MDMX Application Specific Extension.
959 This tells the assembler to accept MDMX instructions.
960 @samp{-no-mdmx} turns off this option.
961
962 @item --construct-floats
963 @itemx --no-construct-floats
964 The @samp{--no-construct-floats} option disables the construction of
965 double width floating point constants by loading the two halves of the
966 value into the two single width floating point registers that make up
967 the double width register. By default @samp{--construct-floats} is
968 selected, allowing construction of these floating point constants.
969
970 @cindex emulation
971 @item --emulation=@var{name}
972 This option causes @command{@value{AS}} to emulate @command{@value{AS}} configured
973 for some other target, in all respects, including output format (choosing
974 between ELF and ECOFF only), handling of pseudo-opcodes which may generate
975 debugging information or store symbol table information, and default
976 endianness. The available configuration names are: @samp{mipsecoff},
977 @samp{mipself}, @samp{mipslecoff}, @samp{mipsbecoff}, @samp{mipslelf},
978 @samp{mipsbelf}. The first two do not alter the default endianness from that
979 of the primary target for which the assembler was configured; the others change
980 the default to little- or big-endian as indicated by the @samp{b} or @samp{l}
981 in the name. Using @samp{-EB} or @samp{-EL} will override the endianness
982 selection in any case.
983
984 This option is currently supported only when the primary target
985 @command{@value{AS}} is configured for is a @sc{mips} ELF or ECOFF target.
986 Furthermore, the primary target or others specified with
987 @samp{--enable-targets=@dots{}} at configuration time must include support for
988 the other format, if both are to be available. For example, the Irix 5
989 configuration includes support for both.
990
991 Eventually, this option will support more configurations, with more
992 fine-grained control over the assembler's behavior, and will be supported for
993 more processors.
994
995 @item -nocpp
996 @command{@value{AS}} ignores this option. It is accepted for compatibility with
997 the native tools.
998
999 @item --trap
1000 @itemx --no-trap
1001 @itemx --break
1002 @itemx --no-break
1003 Control how to deal with multiplication overflow and division by zero.
1004 @samp{--trap} or @samp{--no-break} (which are synonyms) take a trap exception
1005 (and only work for Instruction Set Architecture level 2 and higher);
1006 @samp{--break} or @samp{--no-trap} (also synonyms, and the default) take a
1007 break exception.
1008
1009 @item -n
1010 When this option is used, @command{@value{AS}} will issue a warning every
1011 time it generates a nop instruction from a macro.
1012 @end table
1013 @end ifset
1014
1015 @ifset MCORE
1016 The following options are available when @value{AS} is configured for
1017 an MCore processor.
1018
1019 @table @gcctabopt
1020 @item -jsri2bsr
1021 @itemx -nojsri2bsr
1022 Enable or disable the JSRI to BSR transformation. By default this is enabled.
1023 The command line option @samp{-nojsri2bsr} can be used to disable it.
1024
1025 @item -sifilter
1026 @itemx -nosifilter
1027 Enable or disable the silicon filter behaviour. By default this is disabled.
1028 The default can be overridden by the @samp{-sifilter} command line option.
1029
1030 @item -relax
1031 Alter jump instructions for long displacements.
1032
1033 @item -mcpu=[210|340]
1034 Select the cpu type on the target hardware. This controls which instructions
1035 can be assembled.
1036
1037 @item -EB
1038 Assemble for a big endian target.
1039
1040 @item -EL
1041 Assemble for a little endian target.
1042
1043 @end table
1044 @end ifset
1045
1046 @ifset MMIX
1047 See the info pages for documentation of the MMIX-specific options.
1048 @end ifset
1049
1050 @ifset XTENSA
1051 The following options are available when @value{AS} is configured for
1052 an Xtensa processor.
1053
1054 @table @gcctabopt
1055 @item --density | --no-density
1056 Enable or disable use of instructions from the Xtensa code density
1057 option. This is enabled by default when the Xtensa processor supports
1058 the code density option.
1059
1060 @item --relax | --no-relax
1061 Enable or disable instruction relaxation. This is enabled by default.
1062 Note: In the current implementation, these options also control whether
1063 assembler optimizations are performed, making these options equivalent
1064 to @option{--generics} and @option{--no-generics}.
1065
1066 @item --generics | --no-generics
1067 Enable or disable all assembler transformations of Xtensa instructions.
1068 The default is @option{--generics};
1069 @option{--no-generics} should be used only in the rare cases when the
1070 instructions must be exactly as specified in the assembly source.
1071
1072 @item --text-section-literals | --no-text-section-literals
1073 With @option{--text-@-section-@-literals}, literal pools are interspersed
1074 in the text section. The default is
1075 @option{--no-@-text-@-section-@-literals}, which places literals in a
1076 separate section in the output file.
1077
1078 @item --target-align | --no-target-align
1079 Enable or disable automatic alignment to reduce branch penalties at the
1080 expense of some code density. The default is @option{--target-@-align}.
1081
1082 @item --longcalls | --no-longcalls
1083 Enable or disable transformation of call instructions to allow calls
1084 across a greater range of addresses. The default is
1085 @option{--no-@-longcalls}.
1086 @end table
1087 @end ifset
1088
1089 @c man end
1090
1091 @menu
1092 * Manual:: Structure of this Manual
1093 * GNU Assembler:: The GNU Assembler
1094 * Object Formats:: Object File Formats
1095 * Command Line:: Command Line
1096 * Input Files:: Input Files
1097 * Object:: Output (Object) File
1098 * Errors:: Error and Warning Messages
1099 @end menu
1100
1101 @node Manual
1102 @section Structure of this Manual
1103
1104 @cindex manual, structure and purpose
1105 This manual is intended to describe what you need to know to use
1106 @sc{gnu} @command{@value{AS}}. We cover the syntax expected in source files, including
1107 notation for symbols, constants, and expressions; the directives that
1108 @command{@value{AS}} understands; and of course how to invoke @command{@value{AS}}.
1109
1110 @ifclear GENERIC
1111 We also cover special features in the @value{TARGET}
1112 configuration of @command{@value{AS}}, including assembler directives.
1113 @end ifclear
1114 @ifset GENERIC
1115 This manual also describes some of the machine-dependent features of
1116 various flavors of the assembler.
1117 @end ifset
1118
1119 @cindex machine instructions (not covered)
1120 On the other hand, this manual is @emph{not} intended as an introduction
1121 to programming in assembly language---let alone programming in general!
1122 In a similar vein, we make no attempt to introduce the machine
1123 architecture; we do @emph{not} describe the instruction set, standard
1124 mnemonics, registers or addressing modes that are standard to a
1125 particular architecture.
1126 @ifset GENERIC
1127 You may want to consult the manufacturer's
1128 machine architecture manual for this information.
1129 @end ifset
1130 @ifclear GENERIC
1131 @ifset H8/300
1132 For information on the H8/300 machine instruction set, see @cite{H8/300
1133 Series Programming Manual}. For the H8/300H, see @cite{H8/300H Series
1134 Programming Manual} (Renesas).
1135 @end ifset
1136 @ifset H8/500
1137 For information on the H8/500 machine instruction set, see @cite{H8/500
1138 Series Programming Manual} (Renesas M21T001).
1139 @end ifset
1140 @ifset SH
1141 For information on the Renesas (formerly Hitachi) / SuperH SH machine instruction set,
1142 see @cite{SH-Microcomputer User's Manual} (Renesas) or
1143 @cite{SH-4 32-bit CPU Core Architecture} (SuperH) and
1144 @cite{SuperH (SH) 64-Bit RISC Series} (SuperH).
1145 @end ifset
1146 @ifset Z8000
1147 For information on the Z8000 machine instruction set, see @cite{Z8000 CPU Technical Manual}
1148 @end ifset
1149 @end ifclear
1150
1151 @c I think this is premature---doc@cygnus.com, 17jan1991
1152 @ignore
1153 Throughout this manual, we assume that you are running @dfn{GNU},
1154 the portable operating system from the @dfn{Free Software
1155 Foundation, Inc.}. This restricts our attention to certain kinds of
1156 computer (in particular, the kinds of computers that @sc{gnu} can run on);
1157 once this assumption is granted examples and definitions need less
1158 qualification.
1159
1160 @command{@value{AS}} is part of a team of programs that turn a high-level
1161 human-readable series of instructions into a low-level
1162 computer-readable series of instructions. Different versions of
1163 @command{@value{AS}} are used for different kinds of computer.
1164 @end ignore
1165
1166 @c There used to be a section "Terminology" here, which defined
1167 @c "contents", "byte", "word", and "long". Defining "word" to any
1168 @c particular size is confusing when the .word directive may generate 16
1169 @c bits on one machine and 32 bits on another; in general, for the user
1170 @c version of this manual, none of these terms seem essential to define.
1171 @c They were used very little even in the former draft of the manual;
1172 @c this draft makes an effort to avoid them (except in names of
1173 @c directives).
1174
1175 @node GNU Assembler
1176 @section The GNU Assembler
1177
1178 @c man begin DESCRIPTION
1179
1180 @sc{gnu} @command{as} is really a family of assemblers.
1181 @ifclear GENERIC
1182 This manual describes @command{@value{AS}}, a member of that family which is
1183 configured for the @value{TARGET} architectures.
1184 @end ifclear
1185 If you use (or have used) the @sc{gnu} assembler on one architecture, you
1186 should find a fairly similar environment when you use it on another
1187 architecture. Each version has much in common with the others,
1188 including object file formats, most assembler directives (often called
1189 @dfn{pseudo-ops}) and assembler syntax.@refill
1190
1191 @cindex purpose of @sc{gnu} assembler
1192 @command{@value{AS}} is primarily intended to assemble the output of the
1193 @sc{gnu} C compiler @code{@value{GCC}} for use by the linker
1194 @code{@value{LD}}. Nevertheless, we've tried to make @command{@value{AS}}
1195 assemble correctly everything that other assemblers for the same
1196 machine would assemble.
1197 @ifset VAX
1198 Any exceptions are documented explicitly (@pxref{Machine Dependencies}).
1199 @end ifset
1200 @ifset M680X0
1201 @c This remark should appear in generic version of manual; assumption
1202 @c here is that generic version sets M680x0.
1203 This doesn't mean @command{@value{AS}} always uses the same syntax as another
1204 assembler for the same architecture; for example, we know of several
1205 incompatible versions of 680x0 assembly language syntax.
1206 @end ifset
1207
1208 @c man end
1209
1210 Unlike older assemblers, @command{@value{AS}} is designed to assemble a source
1211 program in one pass of the source file. This has a subtle impact on the
1212 @kbd{.org} directive (@pxref{Org,,@code{.org}}).
1213
1214 @node Object Formats
1215 @section Object File Formats
1216
1217 @cindex object file format
1218 The @sc{gnu} assembler can be configured to produce several alternative
1219 object file formats. For the most part, this does not affect how you
1220 write assembly language programs; but directives for debugging symbols
1221 are typically different in different file formats. @xref{Symbol
1222 Attributes,,Symbol Attributes}.
1223 @ifclear GENERIC
1224 @ifclear MULTI-OBJ
1225 For the @value{TARGET} target, @command{@value{AS}} is configured to produce
1226 @value{OBJ-NAME} format object files.
1227 @end ifclear
1228 @c The following should exhaust all configs that set MULTI-OBJ, ideally
1229 @ifset A29K
1230 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1231 @code{a.out} or COFF format object files.
1232 @end ifset
1233 @ifset I960
1234 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1235 @code{b.out} or COFF format object files.
1236 @end ifset
1237 @ifset HPPA
1238 On the @value{TARGET}, @command{@value{AS}} can be configured to produce either
1239 SOM or ELF format object files.
1240 @end ifset
1241 @end ifclear
1242
1243 @node Command Line
1244 @section Command Line
1245
1246 @cindex command line conventions
1247
1248 After the program name @command{@value{AS}}, the command line may contain
1249 options and file names. Options may appear in any order, and may be
1250 before, after, or between file names. The order of file names is
1251 significant.
1252
1253 @cindex standard input, as input file
1254 @kindex --
1255 @file{--} (two hyphens) by itself names the standard input file
1256 explicitly, as one of the files for @command{@value{AS}} to assemble.
1257
1258 @cindex options, command line
1259 Except for @samp{--} any command line argument that begins with a
1260 hyphen (@samp{-}) is an option. Each option changes the behavior of
1261 @command{@value{AS}}. No option changes the way another option works. An
1262 option is a @samp{-} followed by one or more letters; the case of
1263 the letter is important. All options are optional.
1264
1265 Some options expect exactly one file name to follow them. The file
1266 name may either immediately follow the option's letter (compatible
1267 with older assemblers) or it may be the next command argument (@sc{gnu}
1268 standard). These two command lines are equivalent:
1269
1270 @smallexample
1271 @value{AS} -o my-object-file.o mumble.s
1272 @value{AS} -omy-object-file.o mumble.s
1273 @end smallexample
1274
1275 @node Input Files
1276 @section Input Files
1277
1278 @cindex input
1279 @cindex source program
1280 @cindex files, input
1281 We use the phrase @dfn{source program}, abbreviated @dfn{source}, to
1282 describe the program input to one run of @command{@value{AS}}. The program may
1283 be in one or more files; how the source is partitioned into files
1284 doesn't change the meaning of the source.
1285
1286 @c I added "con" prefix to "catenation" just to prove I can overcome my
1287 @c APL training... doc@cygnus.com
1288 The source program is a concatenation of the text in all the files, in the
1289 order specified.
1290
1291 @c man begin DESCRIPTION
1292 Each time you run @command{@value{AS}} it assembles exactly one source
1293 program. The source program is made up of one or more files.
1294 (The standard input is also a file.)
1295
1296 You give @command{@value{AS}} a command line that has zero or more input file
1297 names. The input files are read (from left file name to right). A
1298 command line argument (in any position) that has no special meaning
1299 is taken to be an input file name.
1300
1301 If you give @command{@value{AS}} no file names it attempts to read one input file
1302 from the @command{@value{AS}} standard input, which is normally your terminal. You
1303 may have to type @key{ctl-D} to tell @command{@value{AS}} there is no more program
1304 to assemble.
1305
1306 Use @samp{--} if you need to explicitly name the standard input file
1307 in your command line.
1308
1309 If the source is empty, @command{@value{AS}} produces a small, empty object
1310 file.
1311
1312 @c man end
1313
1314 @subheading Filenames and Line-numbers
1315
1316 @cindex input file linenumbers
1317 @cindex line numbers, in input files
1318 There are two ways of locating a line in the input file (or files) and
1319 either may be used in reporting error messages. One way refers to a line
1320 number in a physical file; the other refers to a line number in a
1321 ``logical'' file. @xref{Errors, ,Error and Warning Messages}.
1322
1323 @dfn{Physical files} are those files named in the command line given
1324 to @command{@value{AS}}.
1325
1326 @dfn{Logical files} are simply names declared explicitly by assembler
1327 directives; they bear no relation to physical files. Logical file names help
1328 error messages reflect the original source file, when @command{@value{AS}} source
1329 is itself synthesized from other files. @command{@value{AS}} understands the
1330 @samp{#} directives emitted by the @code{@value{GCC}} preprocessor. See also
1331 @ref{File,,@code{.file}}.
1332
1333 @node Object
1334 @section Output (Object) File
1335
1336 @cindex object file
1337 @cindex output file
1338 @kindex a.out
1339 @kindex .o
1340 Every time you run @command{@value{AS}} it produces an output file, which is
1341 your assembly language program translated into numbers. This file
1342 is the object file. Its default name is
1343 @ifclear BOUT
1344 @code{a.out}.
1345 @end ifclear
1346 @ifset BOUT
1347 @ifset GENERIC
1348 @code{a.out}, or
1349 @end ifset
1350 @code{b.out} when @command{@value{AS}} is configured for the Intel 80960.
1351 @end ifset
1352 You can give it another name by using the @option{-o} option. Conventionally,
1353 object file names end with @file{.o}. The default name is used for historical
1354 reasons: older assemblers were capable of assembling self-contained programs
1355 directly into a runnable program. (For some formats, this isn't currently
1356 possible, but it can be done for the @code{a.out} format.)
1357
1358 @cindex linker
1359 @kindex ld
1360 The object file is meant for input to the linker @code{@value{LD}}. It contains
1361 assembled program code, information to help @code{@value{LD}} integrate
1362 the assembled program into a runnable file, and (optionally) symbolic
1363 information for the debugger.
1364
1365 @c link above to some info file(s) like the description of a.out.
1366 @c don't forget to describe @sc{gnu} info as well as Unix lossage.
1367
1368 @node Errors
1369 @section Error and Warning Messages
1370
1371 @c man begin DESCRIPTION
1372
1373 @cindex error messages
1374 @cindex warning messages
1375 @cindex messages from assembler
1376 @command{@value{AS}} may write warnings and error messages to the standard error
1377 file (usually your terminal). This should not happen when a compiler
1378 runs @command{@value{AS}} automatically. Warnings report an assumption made so
1379 that @command{@value{AS}} could keep assembling a flawed program; errors report a
1380 grave problem that stops the assembly.
1381
1382 @c man end
1383
1384 @cindex format of warning messages
1385 Warning messages have the format
1386
1387 @smallexample
1388 file_name:@b{NNN}:Warning Message Text
1389 @end smallexample
1390
1391 @noindent
1392 @cindex line numbers, in warnings/errors
1393 (where @b{NNN} is a line number). If a logical file name has been given
1394 (@pxref{File,,@code{.file}}) it is used for the filename, otherwise the name of
1395 the current input file is used. If a logical line number was given
1396 @ifset GENERIC
1397 (@pxref{Line,,@code{.line}})
1398 @end ifset
1399 @ifclear GENERIC
1400 @ifclear A29K
1401 (@pxref{Line,,@code{.line}})
1402 @end ifclear
1403 @ifset A29K
1404 (@pxref{Ln,,@code{.ln}})
1405 @end ifset
1406 @end ifclear
1407 then it is used to calculate the number printed,
1408 otherwise the actual line in the current source file is printed. The
1409 message text is intended to be self explanatory (in the grand Unix
1410 tradition).
1411
1412 @cindex format of error messages
1413 Error messages have the format
1414 @smallexample
1415 file_name:@b{NNN}:FATAL:Error Message Text
1416 @end smallexample
1417 The file name and line number are derived as for warning
1418 messages. The actual message text may be rather less explanatory
1419 because many of them aren't supposed to happen.
1420
1421 @node Invoking
1422 @chapter Command-Line Options
1423
1424 @cindex options, all versions of assembler
1425 This chapter describes command-line options available in @emph{all}
1426 versions of the @sc{gnu} assembler; @pxref{Machine Dependencies}, for options specific
1427 @ifclear GENERIC
1428 to the @value{TARGET} target.
1429 @end ifclear
1430 @ifset GENERIC
1431 to particular machine architectures.
1432 @end ifset
1433
1434 @c man begin DESCRIPTION
1435
1436 If you are invoking @command{@value{AS}} via the @sc{gnu} C compiler,
1437 you can use the @samp{-Wa} option to pass arguments through to the assembler.
1438 The assembler arguments must be separated from each other (and the @samp{-Wa})
1439 by commas. For example:
1440
1441 @smallexample
1442 gcc -c -g -O -Wa,-alh,-L file.c
1443 @end smallexample
1444
1445 @noindent
1446 This passes two options to the assembler: @samp{-alh} (emit a listing to
1447 standard output with high-level and assembly source) and @samp{-L} (retain
1448 local symbols in the symbol table).
1449
1450 Usually you do not need to use this @samp{-Wa} mechanism, since many compiler
1451 command-line options are automatically passed to the assembler by the compiler.
1452 (You can call the @sc{gnu} compiler driver with the @samp{-v} option to see
1453 precisely what options it passes to each compilation pass, including the
1454 assembler.)
1455
1456 @c man end
1457
1458 @menu
1459 * a:: -a[cdhlns] enable listings
1460 * D:: -D for compatibility
1461 * f:: -f to work faster
1462 * I:: -I for .include search path
1463 @ifclear DIFF-TBL-KLUGE
1464 * K:: -K for compatibility
1465 @end ifclear
1466 @ifset DIFF-TBL-KLUGE
1467 * K:: -K for difference tables
1468 @end ifset
1469
1470 * L:: -L to retain local labels
1471 * listing:: --listing-XXX to configure listing output
1472 * M:: -M or --mri to assemble in MRI compatibility mode
1473 * MD:: --MD for dependency tracking
1474 * o:: -o to name the object file
1475 * R:: -R to join data and text sections
1476 * statistics:: --statistics to see statistics about assembly
1477 * traditional-format:: --traditional-format for compatible output
1478 * v:: -v to announce version
1479 * W:: -W, --no-warn, --warn, --fatal-warnings to control warnings
1480 * Z:: -Z to make object file even after errors
1481 @end menu
1482
1483 @node a
1484 @section Enable Listings: @option{-a[cdhlns]}
1485
1486 @kindex -a
1487 @kindex -ac
1488 @kindex -ad
1489 @kindex -ah
1490 @kindex -al
1491 @kindex -an
1492 @kindex -as
1493 @cindex listings, enabling
1494 @cindex assembly listings, enabling
1495
1496 These options enable listing output from the assembler. By itself,
1497 @samp{-a} requests high-level, assembly, and symbols listing.
1498 You can use other letters to select specific options for the list:
1499 @samp{-ah} requests a high-level language listing,
1500 @samp{-al} requests an output-program assembly listing, and
1501 @samp{-as} requests a symbol table listing.
1502 High-level listings require that a compiler debugging option like
1503 @samp{-g} be used, and that assembly listings (@samp{-al}) be requested
1504 also.
1505
1506 Use the @samp{-ac} option to omit false conditionals from a listing. Any lines
1507 which are not assembled because of a false @code{.if} (or @code{.ifdef}, or any
1508 other conditional), or a true @code{.if} followed by an @code{.else}, will be
1509 omitted from the listing.
1510
1511 Use the @samp{-ad} option to omit debugging directives from the
1512 listing.
1513
1514 Once you have specified one of these options, you can further control
1515 listing output and its appearance using the directives @code{.list},
1516 @code{.nolist}, @code{.psize}, @code{.eject}, @code{.title}, and
1517 @code{.sbttl}.
1518 The @samp{-an} option turns off all forms processing.
1519 If you do not request listing output with one of the @samp{-a} options, the
1520 listing-control directives have no effect.
1521
1522 The letters after @samp{-a} may be combined into one option,
1523 @emph{e.g.}, @samp{-aln}.
1524
1525 Note if the assembler source is coming from the standard input (eg because it
1526 is being created by @code{@value{GCC}} and the @samp{-pipe} command line switch
1527 is being used) then the listing will not contain any comments or preprocessor
1528 directives. This is because the listing code buffers input source lines from
1529 stdin only after they have been preprocessed by the assembler. This reduces
1530 memory usage and makes the code more efficient.
1531
1532 @node D
1533 @section @option{-D}
1534
1535 @kindex -D
1536 This option has no effect whatsoever, but it is accepted to make it more
1537 likely that scripts written for other assemblers also work with
1538 @command{@value{AS}}.
1539
1540 @node f
1541 @section Work Faster: @option{-f}
1542
1543 @kindex -f
1544 @cindex trusted compiler
1545 @cindex faster processing (@option{-f})
1546 @samp{-f} should only be used when assembling programs written by a
1547 (trusted) compiler. @samp{-f} stops the assembler from doing whitespace
1548 and comment preprocessing on
1549 the input file(s) before assembling them. @xref{Preprocessing,
1550 ,Preprocessing}.
1551
1552 @quotation
1553 @emph{Warning:} if you use @samp{-f} when the files actually need to be
1554 preprocessed (if they contain comments, for example), @command{@value{AS}} does
1555 not work correctly.
1556 @end quotation
1557
1558 @node I
1559 @section @code{.include} Search Path: @option{-I} @var{path}
1560
1561 @kindex -I @var{path}
1562 @cindex paths for @code{.include}
1563 @cindex search path for @code{.include}
1564 @cindex @code{include} directive search path
1565 Use this option to add a @var{path} to the list of directories
1566 @command{@value{AS}} searches for files specified in @code{.include}
1567 directives (@pxref{Include,,@code{.include}}). You may use @option{-I} as
1568 many times as necessary to include a variety of paths. The current
1569 working directory is always searched first; after that, @command{@value{AS}}
1570 searches any @samp{-I} directories in the same order as they were
1571 specified (left to right) on the command line.
1572
1573 @node K
1574 @section Difference Tables: @option{-K}
1575
1576 @kindex -K
1577 @ifclear DIFF-TBL-KLUGE
1578 On the @value{TARGET} family, this option is allowed, but has no effect. It is
1579 permitted for compatibility with the @sc{gnu} assembler on other platforms,
1580 where it can be used to warn when the assembler alters the machine code
1581 generated for @samp{.word} directives in difference tables. The @value{TARGET}
1582 family does not have the addressing limitations that sometimes lead to this
1583 alteration on other platforms.
1584 @end ifclear
1585
1586 @ifset DIFF-TBL-KLUGE
1587 @cindex difference tables, warning
1588 @cindex warning for altered difference tables
1589 @command{@value{AS}} sometimes alters the code emitted for directives of the form
1590 @samp{.word @var{sym1}-@var{sym2}}; @pxref{Word,,@code{.word}}.
1591 You can use the @samp{-K} option if you want a warning issued when this
1592 is done.
1593 @end ifset
1594
1595 @node L
1596 @section Include Local Labels: @option{-L}
1597
1598 @kindex -L
1599 @cindex local labels, retaining in output
1600 Labels beginning with @samp{L} (upper case only) are called @dfn{local
1601 labels}. @xref{Symbol Names}. Normally you do not see such labels when
1602 debugging, because they are intended for the use of programs (like
1603 compilers) that compose assembler programs, not for your notice.
1604 Normally both @command{@value{AS}} and @code{@value{LD}} discard such labels, so you do not
1605 normally debug with them.
1606
1607 This option tells @command{@value{AS}} to retain those @samp{L@dots{}} symbols
1608 in the object file. Usually if you do this you also tell the linker
1609 @code{@value{LD}} to preserve symbols whose names begin with @samp{L}.
1610
1611 By default, a local label is any label beginning with @samp{L}, but each
1612 target is allowed to redefine the local label prefix.
1613 @ifset HPPA
1614 On the HPPA local labels begin with @samp{L$}.
1615 @end ifset
1616
1617 @node listing
1618 @section Configuring listing output: @option{--listing}
1619
1620 The listing feature of the assembler can be enabled via the command line switch
1621 @samp{-a} (@pxref{a}). This feature combines the input source file(s) with a
1622 hex dump of the corresponding locations in the output object file, and displays
1623 them as a listing file. The format of this listing can be controlled by pseudo
1624 ops inside the assembler source (@pxref{List} @pxref{Title} @pxref{Sbttl}
1625 @pxref{Psize} @pxref{Eject}) and also by the following switches:
1626
1627 @table @gcctabopt
1628 @item --listing-lhs-width=@samp{number}
1629 @kindex --listing-lhs-width
1630 @cindex Width of first line disassembly output
1631 Sets the maximum width, in words, of the first line of the hex byte dump. This
1632 dump appears on the left hand side of the listing output.
1633
1634 @item --listing-lhs-width2=@samp{number}
1635 @kindex --listing-lhs-width2
1636 @cindex Width of continuation lines of disassembly output
1637 Sets the maximum width, in words, of any further lines of the hex byte dump for
1638 a given input source line. If this value is not specified, it defaults to being
1639 the same as the value specified for @samp{--listing-lhs-width}. If neither
1640 switch is used the default is to one.
1641
1642 @item --listing-rhs-width=@samp{number}
1643 @kindex --listing-rhs-width
1644 @cindex Width of source line output
1645 Sets the maximum width, in characters, of the source line that is displayed
1646 alongside the hex dump. The default value for this parameter is 100. The
1647 source line is displayed on the right hand side of the listing output.
1648
1649 @item --listing-cont-lines=@samp{number}
1650 @kindex --listing-cont-lines
1651 @cindex Maximum number of continuation lines
1652 Sets the maximum number of continuation lines of hex dump that will be
1653 displayed for a given single line of source input. The default value is 4.
1654 @end table
1655
1656 @node M
1657 @section Assemble in MRI Compatibility Mode: @option{-M}
1658
1659 @kindex -M
1660 @cindex MRI compatibility mode
1661 The @option{-M} or @option{--mri} option selects MRI compatibility mode. This
1662 changes the syntax and pseudo-op handling of @command{@value{AS}} to make it
1663 compatible with the @code{ASM68K} or the @code{ASM960} (depending upon the
1664 configured target) assembler from Microtec Research. The exact nature of the
1665 MRI syntax will not be documented here; see the MRI manuals for more
1666 information. Note in particular that the handling of macros and macro
1667 arguments is somewhat different. The purpose of this option is to permit
1668 assembling existing MRI assembler code using @command{@value{AS}}.
1669
1670 The MRI compatibility is not complete. Certain operations of the MRI assembler
1671 depend upon its object file format, and can not be supported using other object
1672 file formats. Supporting these would require enhancing each object file format
1673 individually. These are:
1674
1675 @itemize @bullet
1676 @item global symbols in common section
1677
1678 The m68k MRI assembler supports common sections which are merged by the linker.
1679 Other object file formats do not support this. @command{@value{AS}} handles
1680 common sections by treating them as a single common symbol. It permits local
1681 symbols to be defined within a common section, but it can not support global
1682 symbols, since it has no way to describe them.
1683
1684 @item complex relocations
1685
1686 The MRI assemblers support relocations against a negated section address, and
1687 relocations which combine the start addresses of two or more sections. These
1688 are not support by other object file formats.
1689
1690 @item @code{END} pseudo-op specifying start address
1691
1692 The MRI @code{END} pseudo-op permits the specification of a start address.
1693 This is not supported by other object file formats. The start address may
1694 instead be specified using the @option{-e} option to the linker, or in a linker
1695 script.
1696
1697 @item @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops
1698
1699 The MRI @code{IDNT}, @code{.ident} and @code{NAME} pseudo-ops assign a module
1700 name to the output file. This is not supported by other object file formats.
1701
1702 @item @code{ORG} pseudo-op
1703
1704 The m68k MRI @code{ORG} pseudo-op begins an absolute section at a given
1705 address. This differs from the usual @command{@value{AS}} @code{.org} pseudo-op,
1706 which changes the location within the current section. Absolute sections are
1707 not supported by other object file formats. The address of a section may be
1708 assigned within a linker script.
1709 @end itemize
1710
1711 There are some other features of the MRI assembler which are not supported by
1712 @command{@value{AS}}, typically either because they are difficult or because they
1713 seem of little consequence. Some of these may be supported in future releases.
1714
1715 @itemize @bullet
1716
1717 @item EBCDIC strings
1718
1719 EBCDIC strings are not supported.
1720
1721 @item packed binary coded decimal
1722
1723 Packed binary coded decimal is not supported. This means that the @code{DC.P}
1724 and @code{DCB.P} pseudo-ops are not supported.
1725
1726 @item @code{FEQU} pseudo-op
1727
1728 The m68k @code{FEQU} pseudo-op is not supported.
1729
1730 @item @code{NOOBJ} pseudo-op
1731
1732 The m68k @code{NOOBJ} pseudo-op is not supported.
1733
1734 @item @code{OPT} branch control options
1735
1736 The m68k @code{OPT} branch control options---@code{B}, @code{BRS}, @code{BRB},
1737 @code{BRL}, and @code{BRW}---are ignored. @command{@value{AS}} automatically
1738 relaxes all branches, whether forward or backward, to an appropriate size, so
1739 these options serve no purpose.
1740
1741 @item @code{OPT} list control options
1742
1743 The following m68k @code{OPT} list control options are ignored: @code{C},
1744 @code{CEX}, @code{CL}, @code{CRE}, @code{E}, @code{G}, @code{I}, @code{M},
1745 @code{MEX}, @code{MC}, @code{MD}, @code{X}.
1746
1747 @item other @code{OPT} options
1748
1749 The following m68k @code{OPT} options are ignored: @code{NEST}, @code{O},
1750 @code{OLD}, @code{OP}, @code{P}, @code{PCO}, @code{PCR}, @code{PCS}, @code{R}.
1751
1752 @item @code{OPT} @code{D} option is default
1753
1754 The m68k @code{OPT} @code{D} option is the default, unlike the MRI assembler.
1755 @code{OPT NOD} may be used to turn it off.
1756
1757 @item @code{XREF} pseudo-op.
1758
1759 The m68k @code{XREF} pseudo-op is ignored.
1760
1761 @item @code{.debug} pseudo-op
1762
1763 The i960 @code{.debug} pseudo-op is not supported.
1764
1765 @item @code{.extended} pseudo-op
1766
1767 The i960 @code{.extended} pseudo-op is not supported.
1768
1769 @item @code{.list} pseudo-op.
1770
1771 The various options of the i960 @code{.list} pseudo-op are not supported.
1772
1773 @item @code{.optimize} pseudo-op
1774
1775 The i960 @code{.optimize} pseudo-op is not supported.
1776
1777 @item @code{.output} pseudo-op
1778
1779 The i960 @code{.output} pseudo-op is not supported.
1780
1781 @item @code{.setreal} pseudo-op
1782
1783 The i960 @code{.setreal} pseudo-op is not supported.
1784
1785 @end itemize
1786
1787 @node MD
1788 @section Dependency Tracking: @option{--MD}
1789
1790 @kindex --MD
1791 @cindex dependency tracking
1792 @cindex make rules
1793
1794 @command{@value{AS}} can generate a dependency file for the file it creates. This
1795 file consists of a single rule suitable for @code{make} describing the
1796 dependencies of the main source file.
1797
1798 The rule is written to the file named in its argument.
1799
1800 This feature is used in the automatic updating of makefiles.
1801
1802 @node o
1803 @section Name the Object File: @option{-o}
1804
1805 @kindex -o
1806 @cindex naming object file
1807 @cindex object file name
1808 There is always one object file output when you run @command{@value{AS}}. By
1809 default it has the name
1810 @ifset GENERIC
1811 @ifset I960
1812 @file{a.out} (or @file{b.out}, for Intel 960 targets only).
1813 @end ifset
1814 @ifclear I960
1815 @file{a.out}.
1816 @end ifclear
1817 @end ifset
1818 @ifclear GENERIC
1819 @ifset I960
1820 @file{b.out}.
1821 @end ifset
1822 @ifclear I960
1823 @file{a.out}.
1824 @end ifclear
1825 @end ifclear
1826 You use this option (which takes exactly one filename) to give the
1827 object file a different name.
1828
1829 Whatever the object file is called, @command{@value{AS}} overwrites any
1830 existing file of the same name.
1831
1832 @node R
1833 @section Join Data and Text Sections: @option{-R}
1834
1835 @kindex -R
1836 @cindex data and text sections, joining
1837 @cindex text and data sections, joining
1838 @cindex joining text and data sections
1839 @cindex merging text and data sections
1840 @option{-R} tells @command{@value{AS}} to write the object file as if all
1841 data-section data lives in the text section. This is only done at
1842 the very last moment: your binary data are the same, but data
1843 section parts are relocated differently. The data section part of
1844 your object file is zero bytes long because all its bytes are
1845 appended to the text section. (@xref{Sections,,Sections and Relocation}.)
1846
1847 When you specify @option{-R} it would be possible to generate shorter
1848 address displacements (because we do not have to cross between text and
1849 data section). We refrain from doing this simply for compatibility with
1850 older versions of @command{@value{AS}}. In future, @option{-R} may work this way.
1851
1852 @ifset COFF-ELF
1853 When @command{@value{AS}} is configured for COFF or ELF output,
1854 this option is only useful if you use sections named @samp{.text} and
1855 @samp{.data}.
1856 @end ifset
1857
1858 @ifset HPPA
1859 @option{-R} is not supported for any of the HPPA targets. Using
1860 @option{-R} generates a warning from @command{@value{AS}}.
1861 @end ifset
1862
1863 @node statistics
1864 @section Display Assembly Statistics: @option{--statistics}
1865
1866 @kindex --statistics
1867 @cindex statistics, about assembly
1868 @cindex time, total for assembly
1869 @cindex space used, maximum for assembly
1870 Use @samp{--statistics} to display two statistics about the resources used by
1871 @command{@value{AS}}: the maximum amount of space allocated during the assembly
1872 (in bytes), and the total execution time taken for the assembly (in @sc{cpu}
1873 seconds).
1874
1875 @node traditional-format
1876 @section Compatible Output: @option{--traditional-format}
1877
1878 @kindex --traditional-format
1879 For some targets, the output of @command{@value{AS}} is different in some ways
1880 from the output of some existing assembler. This switch requests
1881 @command{@value{AS}} to use the traditional format instead.
1882
1883 For example, it disables the exception frame optimizations which
1884 @command{@value{AS}} normally does by default on @code{@value{GCC}} output.
1885
1886 @node v
1887 @section Announce Version: @option{-v}
1888
1889 @kindex -v
1890 @kindex -version
1891 @cindex assembler version
1892 @cindex version of assembler
1893 You can find out what version of as is running by including the
1894 option @samp{-v} (which you can also spell as @samp{-version}) on the
1895 command line.
1896
1897 @node W
1898 @section Control Warnings: @option{-W}, @option{--warn}, @option{--no-warn}, @option{--fatal-warnings}
1899
1900 @command{@value{AS}} should never give a warning or error message when
1901 assembling compiler output. But programs written by people often
1902 cause @command{@value{AS}} to give a warning that a particular assumption was
1903 made. All such warnings are directed to the standard error file.
1904
1905 @kindex -W
1906 @kindex --no-warn
1907 @cindex suppressing warnings
1908 @cindex warnings, suppressing
1909 If you use the @option{-W} and @option{--no-warn} options, no warnings are issued.
1910 This only affects the warning messages: it does not change any particular of
1911 how @command{@value{AS}} assembles your file. Errors, which stop the assembly,
1912 are still reported.
1913
1914 @kindex --fatal-warnings
1915 @cindex errors, caused by warnings
1916 @cindex warnings, causing error
1917 If you use the @option{--fatal-warnings} option, @command{@value{AS}} considers
1918 files that generate warnings to be in error.
1919
1920 @kindex --warn
1921 @cindex warnings, switching on
1922 You can switch these options off again by specifying @option{--warn}, which
1923 causes warnings to be output as usual.
1924
1925 @node Z
1926 @section Generate Object File in Spite of Errors: @option{-Z}
1927 @cindex object file, after errors
1928 @cindex errors, continuing after
1929 After an error message, @command{@value{AS}} normally produces no output. If for
1930 some reason you are interested in object file output even after
1931 @command{@value{AS}} gives an error message on your program, use the @samp{-Z}
1932 option. If there are any errors, @command{@value{AS}} continues anyways, and
1933 writes an object file after a final warning message of the form @samp{@var{n}
1934 errors, @var{m} warnings, generating bad object file.}
1935
1936 @node Syntax
1937 @chapter Syntax
1938
1939 @cindex machine-independent syntax
1940 @cindex syntax, machine-independent
1941 This chapter describes the machine-independent syntax allowed in a
1942 source file. @command{@value{AS}} syntax is similar to what many other
1943 assemblers use; it is inspired by the BSD 4.2
1944 @ifclear VAX
1945 assembler.
1946 @end ifclear
1947 @ifset VAX
1948 assembler, except that @command{@value{AS}} does not assemble Vax bit-fields.
1949 @end ifset
1950
1951 @menu
1952 * Preprocessing:: Preprocessing
1953 * Whitespace:: Whitespace
1954 * Comments:: Comments
1955 * Symbol Intro:: Symbols
1956 * Statements:: Statements
1957 * Constants:: Constants
1958 @end menu
1959
1960 @node Preprocessing
1961 @section Preprocessing
1962
1963 @cindex preprocessing
1964 The @command{@value{AS}} internal preprocessor:
1965 @itemize @bullet
1966 @cindex whitespace, removed by preprocessor
1967 @item
1968 adjusts and removes extra whitespace. It leaves one space or tab before
1969 the keywords on a line, and turns any other whitespace on the line into
1970 a single space.
1971
1972 @cindex comments, removed by preprocessor
1973 @item
1974 removes all comments, replacing them with a single space, or an
1975 appropriate number of newlines.
1976
1977 @cindex constants, converted by preprocessor
1978 @item
1979 converts character constants into the appropriate numeric values.
1980 @end itemize
1981
1982 It does not do macro processing, include file handling, or
1983 anything else you may get from your C compiler's preprocessor. You can
1984 do include file processing with the @code{.include} directive
1985 (@pxref{Include,,@code{.include}}). You can use the @sc{gnu} C compiler driver
1986 to get other ``CPP'' style preprocessing by giving the input file a
1987 @samp{.S} suffix. @xref{Overall Options,, Options Controlling the Kind of
1988 Output, gcc.info, Using GNU CC}.
1989
1990 Excess whitespace, comments, and character constants
1991 cannot be used in the portions of the input text that are not
1992 preprocessed.
1993
1994 @cindex turning preprocessing on and off
1995 @cindex preprocessing, turning on and off
1996 @kindex #NO_APP
1997 @kindex #APP
1998 If the first line of an input file is @code{#NO_APP} or if you use the
1999 @samp{-f} option, whitespace and comments are not removed from the input file.
2000 Within an input file, you can ask for whitespace and comment removal in
2001 specific portions of the by putting a line that says @code{#APP} before the
2002 text that may contain whitespace or comments, and putting a line that says
2003 @code{#NO_APP} after this text. This feature is mainly intend to support
2004 @code{asm} statements in compilers whose output is otherwise free of comments
2005 and whitespace.
2006
2007 @node Whitespace
2008 @section Whitespace
2009
2010 @cindex whitespace
2011 @dfn{Whitespace} is one or more blanks or tabs, in any order.
2012 Whitespace is used to separate symbols, and to make programs neater for
2013 people to read. Unless within character constants
2014 (@pxref{Characters,,Character Constants}), any whitespace means the same
2015 as exactly one space.
2016
2017 @node Comments
2018 @section Comments
2019
2020 @cindex comments
2021 There are two ways of rendering comments to @command{@value{AS}}. In both
2022 cases the comment is equivalent to one space.
2023
2024 Anything from @samp{/*} through the next @samp{*/} is a comment.
2025 This means you may not nest these comments.
2026
2027 @smallexample
2028 /*
2029 The only way to include a newline ('\n') in a comment
2030 is to use this sort of comment.
2031 */
2032
2033 /* This sort of comment does not nest. */
2034 @end smallexample
2035
2036 @cindex line comment character
2037 Anything from the @dfn{line comment} character to the next newline
2038 is considered a comment and is ignored. The line comment character is
2039 @ifset A29K
2040 @samp{;} for the AMD 29K family;
2041 @end ifset
2042 @ifset ARC
2043 @samp{;} on the ARC;
2044 @end ifset
2045 @ifset ARM
2046 @samp{@@} on the ARM;
2047 @end ifset
2048 @ifset H8/300
2049 @samp{;} for the H8/300 family;
2050 @end ifset
2051 @ifset H8/500
2052 @samp{!} for the H8/500 family;
2053 @end ifset
2054 @ifset HPPA
2055 @samp{;} for the HPPA;
2056 @end ifset
2057 @ifset I80386
2058 @samp{#} on the i386 and x86-64;
2059 @end ifset
2060 @ifset I960
2061 @samp{#} on the i960;
2062 @end ifset
2063 @ifset PDP11
2064 @samp{;} for the PDP-11;
2065 @end ifset
2066 @ifset PJ
2067 @samp{;} for picoJava;
2068 @end ifset
2069 @ifset PPC
2070 @samp{#} for Motorola PowerPC;
2071 @end ifset
2072 @ifset SH
2073 @samp{!} for the Renesas / SuperH SH;
2074 @end ifset
2075 @ifset SPARC
2076 @samp{!} on the SPARC;
2077 @end ifset
2078 @ifset IP2K
2079 @samp{#} on the ip2k;
2080 @end ifset
2081 @ifset M32R
2082 @samp{#} on the m32r;
2083 @end ifset
2084 @ifset M680X0
2085 @samp{|} on the 680x0;
2086 @end ifset
2087 @ifset M68HC11
2088 @samp{#} on the 68HC11 and 68HC12;
2089 @end ifset
2090 @ifset M880X0
2091 @samp{;} on the M880x0;
2092 @end ifset
2093 @ifset VAX
2094 @samp{#} on the Vax;
2095 @end ifset
2096 @ifset Z8000
2097 @samp{!} for the Z8000;
2098 @end ifset
2099 @ifset V850
2100 @samp{#} on the V850;
2101 @end ifset
2102 @ifset XTENSA
2103 @samp{#} for Xtensa systems;
2104 @end ifset
2105 see @ref{Machine Dependencies}. @refill
2106 @c FIXME What about i860?
2107
2108 @ifset GENERIC
2109 On some machines there are two different line comment characters. One
2110 character only begins a comment if it is the first non-whitespace character on
2111 a line, while the other always begins a comment.
2112 @end ifset
2113
2114 @ifset V850
2115 The V850 assembler also supports a double dash as starting a comment that
2116 extends to the end of the line.
2117
2118 @samp{--};
2119 @end ifset
2120
2121 @kindex #
2122 @cindex lines starting with @code{#}
2123 @cindex logical line numbers
2124 To be compatible with past assemblers, lines that begin with @samp{#} have a
2125 special interpretation. Following the @samp{#} should be an absolute
2126 expression (@pxref{Expressions}): the logical line number of the @emph{next}
2127 line. Then a string (@pxref{Strings,, Strings}) is allowed: if present it is a
2128 new logical file name. The rest of the line, if any, should be whitespace.
2129
2130 If the first non-whitespace characters on the line are not numeric,
2131 the line is ignored. (Just like a comment.)
2132
2133 @smallexample
2134 # This is an ordinary comment.
2135 # 42-6 "new_file_name" # New logical file name
2136 # This is logical line # 36.
2137 @end smallexample
2138 This feature is deprecated, and may disappear from future versions
2139 of @command{@value{AS}}.
2140
2141 @node Symbol Intro
2142 @section Symbols
2143
2144 @cindex characters used in symbols
2145 @ifclear SPECIAL-SYMS
2146 A @dfn{symbol} is one or more characters chosen from the set of all
2147 letters (both upper and lower case), digits and the three characters
2148 @samp{_.$}.
2149 @end ifclear
2150 @ifset SPECIAL-SYMS
2151 @ifclear GENERIC
2152 @ifset H8
2153 A @dfn{symbol} is one or more characters chosen from the set of all
2154 letters (both upper and lower case), digits and the three characters
2155 @samp{._$}. (Save that, on the H8/300 only, you may not use @samp{$} in
2156 symbol names.)
2157 @end ifset
2158 @end ifclear
2159 @end ifset
2160 @ifset GENERIC
2161 On most machines, you can also use @code{$} in symbol names; exceptions
2162 are noted in @ref{Machine Dependencies}.
2163 @end ifset
2164 No symbol may begin with a digit. Case is significant.
2165 There is no length limit: all characters are significant. Symbols are
2166 delimited by characters not in that set, or by the beginning of a file
2167 (since the source program must end with a newline, the end of a file is
2168 not a possible symbol delimiter). @xref{Symbols}.
2169 @cindex length of symbols
2170
2171 @node Statements
2172 @section Statements
2173
2174 @cindex statements, structure of
2175 @cindex line separator character
2176 @cindex statement separator character
2177 @ifclear GENERIC
2178 @ifclear abnormal-separator
2179 A @dfn{statement} ends at a newline character (@samp{\n}) or at a
2180 semicolon (@samp{;}). The newline or semicolon is considered part of
2181 the preceding statement. Newlines and semicolons within character
2182 constants are an exception: they do not end statements.
2183 @end ifclear
2184 @ifset abnormal-separator
2185 @ifset A29K
2186 A @dfn{statement} ends at a newline character (@samp{\n}) or an ``at''
2187 sign (@samp{@@}). The newline or at sign is considered part of the
2188 preceding statement. Newlines and at signs within character constants
2189 are an exception: they do not end statements.
2190 @end ifset
2191 @ifset HPPA
2192 A @dfn{statement} ends at a newline character (@samp{\n}) or an exclamation
2193 point (@samp{!}). The newline or exclamation point is considered part of the
2194 preceding statement. Newlines and exclamation points within character
2195 constants are an exception: they do not end statements.
2196 @end ifset
2197 @ifset H8
2198 A @dfn{statement} ends at a newline character (@samp{\n}); or (for the
2199 H8/300) a dollar sign (@samp{$}); or (for the
2200 Renesas-SH or the
2201 H8/500) a semicolon
2202 (@samp{;}). The newline or separator character is considered part of
2203 the preceding statement. Newlines and separators within character
2204 constants are an exception: they do not end statements.
2205 @end ifset
2206 @end ifset
2207 @end ifclear
2208 @ifset GENERIC
2209 A @dfn{statement} ends at a newline character (@samp{\n}) or line
2210 separator character. (The line separator is usually @samp{;}, unless
2211 this conflicts with the comment character; @pxref{Machine Dependencies}.) The
2212 newline or separator character is considered part of the preceding
2213 statement. Newlines and separators within character constants are an
2214 exception: they do not end statements.
2215 @end ifset
2216
2217 @cindex newline, required at file end
2218 @cindex EOF, newline must precede
2219 It is an error to end any statement with end-of-file: the last
2220 character of any input file should be a newline.@refill
2221
2222 An empty statement is allowed, and may include whitespace. It is ignored.
2223
2224 @cindex instructions and directives
2225 @cindex directives and instructions
2226 @c "key symbol" is not used elsewhere in the document; seems pedantic to
2227 @c @defn{} it in that case, as was done previously... doc@cygnus.com,
2228 @c 13feb91.
2229 A statement begins with zero or more labels, optionally followed by a
2230 key symbol which determines what kind of statement it is. The key
2231 symbol determines the syntax of the rest of the statement. If the
2232 symbol begins with a dot @samp{.} then the statement is an assembler
2233 directive: typically valid for any computer. If the symbol begins with
2234 a letter the statement is an assembly language @dfn{instruction}: it
2235 assembles into a machine language instruction.
2236 @ifset GENERIC
2237 Different versions of @command{@value{AS}} for different computers
2238 recognize different instructions. In fact, the same symbol may
2239 represent a different instruction in a different computer's assembly
2240 language.@refill
2241 @end ifset
2242
2243 @cindex @code{:} (label)
2244 @cindex label (@code{:})
2245 A label is a symbol immediately followed by a colon (@code{:}).
2246 Whitespace before a label or after a colon is permitted, but you may not
2247 have whitespace between a label's symbol and its colon. @xref{Labels}.
2248
2249 @ifset HPPA
2250 For HPPA targets, labels need not be immediately followed by a colon, but
2251 the definition of a label must begin in column zero. This also implies that
2252 only one label may be defined on each line.
2253 @end ifset
2254
2255 @smallexample
2256 label: .directive followed by something
2257 another_label: # This is an empty statement.
2258 instruction operand_1, operand_2, @dots{}
2259 @end smallexample
2260
2261 @node Constants
2262 @section Constants
2263
2264 @cindex constants
2265 A constant is a number, written so that its value is known by
2266 inspection, without knowing any context. Like this:
2267 @smallexample
2268 @group
2269 .byte 74, 0112, 092, 0x4A, 0X4a, 'J, '\J # All the same value.
2270 .ascii "Ring the bell\7" # A string constant.
2271 .octa 0x123456789abcdef0123456789ABCDEF0 # A bignum.
2272 .float 0f-314159265358979323846264338327\
2273 95028841971.693993751E-40 # - pi, a flonum.
2274 @end group
2275 @end smallexample
2276
2277 @menu
2278 * Characters:: Character Constants
2279 * Numbers:: Number Constants
2280 @end menu
2281
2282 @node Characters
2283 @subsection Character Constants
2284
2285 @cindex character constants
2286 @cindex constants, character
2287 There are two kinds of character constants. A @dfn{character} stands
2288 for one character in one byte and its value may be used in
2289 numeric expressions. String constants (properly called string
2290 @emph{literals}) are potentially many bytes and their values may not be
2291 used in arithmetic expressions.
2292
2293 @menu
2294 * Strings:: Strings
2295 * Chars:: Characters
2296 @end menu
2297
2298 @node Strings
2299 @subsubsection Strings
2300
2301 @cindex string constants
2302 @cindex constants, string
2303 A @dfn{string} is written between double-quotes. It may contain
2304 double-quotes or null characters. The way to get special characters
2305 into a string is to @dfn{escape} these characters: precede them with
2306 a backslash @samp{\} character. For example @samp{\\} represents
2307 one backslash: the first @code{\} is an escape which tells
2308 @command{@value{AS}} to interpret the second character literally as a backslash
2309 (which prevents @command{@value{AS}} from recognizing the second @code{\} as an
2310 escape character). The complete list of escapes follows.
2311
2312 @cindex escape codes, character
2313 @cindex character escape codes
2314 @table @kbd
2315 @c @item \a
2316 @c Mnemonic for ACKnowledge; for ASCII this is octal code 007.
2317 @c
2318 @cindex @code{\b} (backspace character)
2319 @cindex backspace (@code{\b})
2320 @item \b
2321 Mnemonic for backspace; for ASCII this is octal code 010.
2322
2323 @c @item \e
2324 @c Mnemonic for EOText; for ASCII this is octal code 004.
2325 @c
2326 @cindex @code{\f} (formfeed character)
2327 @cindex formfeed (@code{\f})
2328 @item \f
2329 Mnemonic for FormFeed; for ASCII this is octal code 014.
2330
2331 @cindex @code{\n} (newline character)
2332 @cindex newline (@code{\n})
2333 @item \n
2334 Mnemonic for newline; for ASCII this is octal code 012.
2335
2336 @c @item \p
2337 @c Mnemonic for prefix; for ASCII this is octal code 033, usually known as @code{escape}.
2338 @c
2339 @cindex @code{\r} (carriage return character)
2340 @cindex carriage return (@code{\r})
2341 @item \r
2342 Mnemonic for carriage-Return; for ASCII this is octal code 015.
2343
2344 @c @item \s
2345 @c Mnemonic for space; for ASCII this is octal code 040. Included for compliance with
2346 @c other assemblers.
2347 @c
2348 @cindex @code{\t} (tab)
2349 @cindex tab (@code{\t})
2350 @item \t
2351 Mnemonic for horizontal Tab; for ASCII this is octal code 011.
2352
2353 @c @item \v
2354 @c Mnemonic for Vertical tab; for ASCII this is octal code 013.
2355 @c @item \x @var{digit} @var{digit} @var{digit}
2356 @c A hexadecimal character code. The numeric code is 3 hexadecimal digits.
2357 @c
2358 @cindex @code{\@var{ddd}} (octal character code)
2359 @cindex octal character code (@code{\@var{ddd}})
2360 @item \ @var{digit} @var{digit} @var{digit}
2361 An octal character code. The numeric code is 3 octal digits.
2362 For compatibility with other Unix systems, 8 and 9 are accepted as digits:
2363 for example, @code{\008} has the value 010, and @code{\009} the value 011.
2364
2365 @cindex @code{\@var{xd...}} (hex character code)
2366 @cindex hex character code (@code{\@var{xd...}})
2367 @item \@code{x} @var{hex-digits...}
2368 A hex character code. All trailing hex digits are combined. Either upper or
2369 lower case @code{x} works.
2370
2371 @cindex @code{\\} (@samp{\} character)
2372 @cindex backslash (@code{\\})
2373 @item \\
2374 Represents one @samp{\} character.
2375
2376 @c @item \'
2377 @c Represents one @samp{'} (accent acute) character.
2378 @c This is needed in single character literals
2379 @c (@xref{Characters,,Character Constants}.) to represent
2380 @c a @samp{'}.
2381 @c
2382 @cindex @code{\"} (doublequote character)
2383 @cindex doublequote (@code{\"})
2384 @item \"
2385 Represents one @samp{"} character. Needed in strings to represent
2386 this character, because an unescaped @samp{"} would end the string.
2387
2388 @item \ @var{anything-else}
2389 Any other character when escaped by @kbd{\} gives a warning, but
2390 assembles as if the @samp{\} was not present. The idea is that if
2391 you used an escape sequence you clearly didn't want the literal
2392 interpretation of the following character. However @command{@value{AS}} has no
2393 other interpretation, so @command{@value{AS}} knows it is giving you the wrong
2394 code and warns you of the fact.
2395 @end table
2396
2397 Which characters are escapable, and what those escapes represent,
2398 varies widely among assemblers. The current set is what we think
2399 the BSD 4.2 assembler recognizes, and is a subset of what most C
2400 compilers recognize. If you are in doubt, do not use an escape
2401 sequence.
2402
2403 @node Chars
2404 @subsubsection Characters
2405
2406 @cindex single character constant
2407 @cindex character, single
2408 @cindex constant, single character
2409 A single character may be written as a single quote immediately
2410 followed by that character. The same escapes apply to characters as
2411 to strings. So if you want to write the character backslash, you
2412 must write @kbd{'\\} where the first @code{\} escapes the second
2413 @code{\}. As you can see, the quote is an acute accent, not a
2414 grave accent. A newline
2415 @ifclear GENERIC
2416 @ifclear abnormal-separator
2417 (or semicolon @samp{;})
2418 @end ifclear
2419 @ifset abnormal-separator
2420 @ifset A29K
2421 (or at sign @samp{@@})
2422 @end ifset
2423 @ifset H8
2424 (or dollar sign @samp{$}, for the H8/300; or semicolon @samp{;} for the
2425 Renesas SH or H8/500)
2426 @end ifset
2427 @end ifset
2428 @end ifclear
2429 immediately following an acute accent is taken as a literal character
2430 and does not count as the end of a statement. The value of a character
2431 constant in a numeric expression is the machine's byte-wide code for
2432 that character. @command{@value{AS}} assumes your character code is ASCII:
2433 @kbd{'A} means 65, @kbd{'B} means 66, and so on. @refill
2434
2435 @node Numbers
2436 @subsection Number Constants
2437
2438 @cindex constants, number
2439 @cindex number constants
2440 @command{@value{AS}} distinguishes three kinds of numbers according to how they
2441 are stored in the target machine. @emph{Integers} are numbers that
2442 would fit into an @code{int} in the C language. @emph{Bignums} are
2443 integers, but they are stored in more than 32 bits. @emph{Flonums}
2444 are floating point numbers, described below.
2445
2446 @menu
2447 * Integers:: Integers
2448 * Bignums:: Bignums
2449 * Flonums:: Flonums
2450 @ifclear GENERIC
2451 @ifset I960
2452 * Bit Fields:: Bit Fields
2453 @end ifset
2454 @end ifclear
2455 @end menu
2456
2457 @node Integers
2458 @subsubsection Integers
2459 @cindex integers
2460 @cindex constants, integer
2461
2462 @cindex binary integers
2463 @cindex integers, binary
2464 A binary integer is @samp{0b} or @samp{0B} followed by zero or more of
2465 the binary digits @samp{01}.
2466
2467 @cindex octal integers
2468 @cindex integers, octal
2469 An octal integer is @samp{0} followed by zero or more of the octal
2470 digits (@samp{01234567}).
2471
2472 @cindex decimal integers
2473 @cindex integers, decimal
2474 A decimal integer starts with a non-zero digit followed by zero or
2475 more digits (@samp{0123456789}).
2476
2477 @cindex hexadecimal integers
2478 @cindex integers, hexadecimal
2479 A hexadecimal integer is @samp{0x} or @samp{0X} followed by one or
2480 more hexadecimal digits chosen from @samp{0123456789abcdefABCDEF}.
2481
2482 Integers have the usual values. To denote a negative integer, use
2483 the prefix operator @samp{-} discussed under expressions
2484 (@pxref{Prefix Ops,,Prefix Operators}).
2485
2486 @node Bignums
2487 @subsubsection Bignums
2488
2489 @cindex bignums
2490 @cindex constants, bignum
2491 A @dfn{bignum} has the same syntax and semantics as an integer
2492 except that the number (or its negative) takes more than 32 bits to
2493 represent in binary. The distinction is made because in some places
2494 integers are permitted while bignums are not.
2495
2496 @node Flonums
2497 @subsubsection Flonums
2498 @cindex flonums
2499 @cindex floating point numbers
2500 @cindex constants, floating point
2501
2502 @cindex precision, floating point
2503 A @dfn{flonum} represents a floating point number. The translation is
2504 indirect: a decimal floating point number from the text is converted by
2505 @command{@value{AS}} to a generic binary floating point number of more than
2506 sufficient precision. This generic floating point number is converted
2507 to a particular computer's floating point format (or formats) by a
2508 portion of @command{@value{AS}} specialized to that computer.
2509
2510 A flonum is written by writing (in order)
2511 @itemize @bullet
2512 @item
2513 The digit @samp{0}.
2514 @ifset HPPA
2515 (@samp{0} is optional on the HPPA.)
2516 @end ifset
2517
2518 @item
2519 A letter, to tell @command{@value{AS}} the rest of the number is a flonum.
2520 @ifset GENERIC
2521 @kbd{e} is recommended. Case is not important.
2522 @ignore
2523 @c FIXME: verify if flonum syntax really this vague for most cases
2524 (Any otherwise illegal letter works here, but that might be changed. Vax BSD
2525 4.2 assembler seems to allow any of @samp{defghDEFGH}.)
2526 @end ignore
2527
2528 On the H8/300, H8/500,
2529 Renesas / SuperH SH,
2530 and AMD 29K architectures, the letter must be
2531 one of the letters @samp{DFPRSX} (in upper or lower case).
2532
2533 On the ARC, the letter must be one of the letters @samp{DFRS}
2534 (in upper or lower case).
2535
2536 On the Intel 960 architecture, the letter must be
2537 one of the letters @samp{DFT} (in upper or lower case).
2538
2539 On the HPPA architecture, the letter must be @samp{E} (upper case only).
2540 @end ifset
2541 @ifclear GENERIC
2542 @ifset A29K
2543 One of the letters @samp{DFPRSX} (in upper or lower case).
2544 @end ifset
2545 @ifset ARC
2546 One of the letters @samp{DFRS} (in upper or lower case).
2547 @end ifset
2548 @ifset H8
2549 One of the letters @samp{DFPRSX} (in upper or lower case).
2550 @end ifset
2551 @ifset HPPA
2552 The letter @samp{E} (upper case only).
2553 @end ifset
2554 @ifset I960
2555 One of the letters @samp{DFT} (in upper or lower case).
2556 @end ifset
2557 @end ifclear
2558
2559 @item
2560 An optional sign: either @samp{+} or @samp{-}.
2561
2562 @item
2563 An optional @dfn{integer part}: zero or more decimal digits.
2564
2565 @item
2566 An optional @dfn{fractional part}: @samp{.} followed by zero
2567 or more decimal digits.
2568
2569 @item
2570 An optional exponent, consisting of:
2571
2572 @itemize @bullet
2573 @item
2574 An @samp{E} or @samp{e}.
2575 @c I can't find a config where "EXP_CHARS" is other than 'eE', but in
2576 @c principle this can perfectly well be different on different targets.
2577 @item
2578 Optional sign: either @samp{+} or @samp{-}.
2579 @item
2580 One or more decimal digits.
2581 @end itemize
2582
2583 @end itemize
2584
2585 At least one of the integer part or the fractional part must be
2586 present. The floating point number has the usual base-10 value.
2587
2588 @command{@value{AS}} does all processing using integers. Flonums are computed
2589 independently of any floating point hardware in the computer running
2590 @command{@value{AS}}.
2591
2592 @ifclear GENERIC
2593 @ifset I960
2594 @c Bit fields are written as a general facility but are also controlled
2595 @c by a conditional-compilation flag---which is as of now (21mar91)
2596 @c turned on only by the i960 config of GAS.
2597 @node Bit Fields
2598 @subsubsection Bit Fields
2599
2600 @cindex bit fields
2601 @cindex constants, bit field
2602 You can also define numeric constants as @dfn{bit fields}.
2603 specify two numbers separated by a colon---
2604 @example
2605 @var{mask}:@var{value}
2606 @end example
2607 @noindent
2608 @command{@value{AS}} applies a bitwise @sc{and} between @var{mask} and
2609 @var{value}.
2610
2611 The resulting number is then packed
2612 @ifset GENERIC
2613 @c this conditional paren in case bit fields turned on elsewhere than 960
2614 (in host-dependent byte order)
2615 @end ifset
2616 into a field whose width depends on which assembler directive has the
2617 bit-field as its argument. Overflow (a result from the bitwise and
2618 requiring more binary digits to represent) is not an error; instead,
2619 more constants are generated, of the specified width, beginning with the
2620 least significant digits.@refill
2621
2622 The directives @code{.byte}, @code{.hword}, @code{.int}, @code{.long},
2623 @code{.short}, and @code{.word} accept bit-field arguments.
2624 @end ifset
2625 @end ifclear
2626
2627 @node Sections
2628 @chapter Sections and Relocation
2629 @cindex sections
2630 @cindex relocation
2631
2632 @menu
2633 * Secs Background:: Background
2634 * Ld Sections:: Linker Sections
2635 * As Sections:: Assembler Internal Sections
2636 * Sub-Sections:: Sub-Sections
2637 * bss:: bss Section
2638 @end menu
2639
2640 @node Secs Background
2641 @section Background
2642
2643 Roughly, a section is a range of addresses, with no gaps; all data
2644 ``in'' those addresses is treated the same for some particular purpose.
2645 For example there may be a ``read only'' section.
2646
2647 @cindex linker, and assembler
2648 @cindex assembler, and linker
2649 The linker @code{@value{LD}} reads many object files (partial programs) and
2650 combines their contents to form a runnable program. When @command{@value{AS}}
2651 emits an object file, the partial program is assumed to start at address 0.
2652 @code{@value{LD}} assigns the final addresses for the partial program, so that
2653 different partial programs do not overlap. This is actually an
2654 oversimplification, but it suffices to explain how @command{@value{AS}} uses
2655 sections.
2656
2657 @code{@value{LD}} moves blocks of bytes of your program to their run-time
2658 addresses. These blocks slide to their run-time addresses as rigid
2659 units; their length does not change and neither does the order of bytes
2660 within them. Such a rigid unit is called a @emph{section}. Assigning
2661 run-time addresses to sections is called @dfn{relocation}. It includes
2662 the task of adjusting mentions of object-file addresses so they refer to
2663 the proper run-time addresses.
2664 @ifset H8
2665 For the H8/300 and H8/500,
2666 and for the Renesas / SuperH SH,
2667 @command{@value{AS}} pads sections if needed to
2668 ensure they end on a word (sixteen bit) boundary.
2669 @end ifset
2670
2671 @cindex standard assembler sections
2672 An object file written by @command{@value{AS}} has at least three sections, any
2673 of which may be empty. These are named @dfn{text}, @dfn{data} and
2674 @dfn{bss} sections.
2675
2676 @ifset COFF-ELF
2677 @ifset GENERIC
2678 When it generates COFF or ELF output,
2679 @end ifset
2680 @command{@value{AS}} can also generate whatever other named sections you specify
2681 using the @samp{.section} directive (@pxref{Section,,@code{.section}}).
2682 If you do not use any directives that place output in the @samp{.text}
2683 or @samp{.data} sections, these sections still exist, but are empty.
2684 @end ifset
2685
2686 @ifset HPPA
2687 @ifset GENERIC
2688 When @command{@value{AS}} generates SOM or ELF output for the HPPA,
2689 @end ifset
2690 @command{@value{AS}} can also generate whatever other named sections you
2691 specify using the @samp{.space} and @samp{.subspace} directives. See
2692 @cite{HP9000 Series 800 Assembly Language Reference Manual}
2693 (HP 92432-90001) for details on the @samp{.space} and @samp{.subspace}
2694 assembler directives.
2695
2696 @ifset SOM
2697 Additionally, @command{@value{AS}} uses different names for the standard
2698 text, data, and bss sections when generating SOM output. Program text
2699 is placed into the @samp{$CODE$} section, data into @samp{$DATA$}, and
2700 BSS into @samp{$BSS$}.
2701 @end ifset
2702 @end ifset
2703
2704 Within the object file, the text section starts at address @code{0}, the
2705 data section follows, and the bss section follows the data section.
2706
2707 @ifset HPPA
2708 When generating either SOM or ELF output files on the HPPA, the text
2709 section starts at address @code{0}, the data section at address
2710 @code{0x4000000}, and the bss section follows the data section.
2711 @end ifset
2712
2713 To let @code{@value{LD}} know which data changes when the sections are
2714 relocated, and how to change that data, @command{@value{AS}} also writes to the
2715 object file details of the relocation needed. To perform relocation
2716 @code{@value{LD}} must know, each time an address in the object
2717 file is mentioned:
2718 @itemize @bullet
2719 @item
2720 Where in the object file is the beginning of this reference to
2721 an address?
2722 @item
2723 How long (in bytes) is this reference?
2724 @item
2725 Which section does the address refer to? What is the numeric value of
2726 @display
2727 (@var{address}) @minus{} (@var{start-address of section})?
2728 @end display
2729 @item
2730 Is the reference to an address ``Program-Counter relative''?
2731 @end itemize
2732
2733 @cindex addresses, format of
2734 @cindex section-relative addressing
2735 In fact, every address @command{@value{AS}} ever uses is expressed as
2736 @display
2737 (@var{section}) + (@var{offset into section})
2738 @end display
2739 @noindent
2740 Further, most expressions @command{@value{AS}} computes have this section-relative
2741 nature.
2742 @ifset SOM
2743 (For some object formats, such as SOM for the HPPA, some expressions are
2744 symbol-relative instead.)
2745 @end ifset
2746
2747 In this manual we use the notation @{@var{secname} @var{N}@} to mean ``offset
2748 @var{N} into section @var{secname}.''
2749
2750 Apart from text, data and bss sections you need to know about the
2751 @dfn{absolute} section. When @code{@value{LD}} mixes partial programs,
2752 addresses in the absolute section remain unchanged. For example, address
2753 @code{@{absolute 0@}} is ``relocated'' to run-time address 0 by
2754 @code{@value{LD}}. Although the linker never arranges two partial programs'
2755 data sections with overlapping addresses after linking, @emph{by definition}
2756 their absolute sections must overlap. Address @code{@{absolute@ 239@}} in one
2757 part of a program is always the same address when the program is running as
2758 address @code{@{absolute@ 239@}} in any other part of the program.
2759
2760 The idea of sections is extended to the @dfn{undefined} section. Any
2761 address whose section is unknown at assembly time is by definition
2762 rendered @{undefined @var{U}@}---where @var{U} is filled in later.
2763 Since numbers are always defined, the only way to generate an undefined
2764 address is to mention an undefined symbol. A reference to a named
2765 common block would be such a symbol: its value is unknown at assembly
2766 time so it has section @emph{undefined}.
2767
2768 By analogy the word @emph{section} is used to describe groups of sections in
2769 the linked program. @code{@value{LD}} puts all partial programs' text
2770 sections in contiguous addresses in the linked program. It is
2771 customary to refer to the @emph{text section} of a program, meaning all
2772 the addresses of all partial programs' text sections. Likewise for
2773 data and bss sections.
2774
2775 Some sections are manipulated by @code{@value{LD}}; others are invented for
2776 use of @command{@value{AS}} and have no meaning except during assembly.
2777
2778 @node Ld Sections
2779 @section Linker Sections
2780 @code{@value{LD}} deals with just four kinds of sections, summarized below.
2781
2782 @table @strong
2783
2784 @ifset COFF-ELF
2785 @cindex named sections
2786 @cindex sections, named
2787 @item named sections
2788 @end ifset
2789 @ifset aout-bout
2790 @cindex text section
2791 @cindex data section
2792 @itemx text section
2793 @itemx data section
2794 @end ifset
2795 These sections hold your program. @command{@value{AS}} and @code{@value{LD}} treat them as
2796 separate but equal sections. Anything you can say of one section is
2797 true of another.
2798 @c @ifset aout-bout
2799 When the program is running, however, it is
2800 customary for the text section to be unalterable. The
2801 text section is often shared among processes: it contains
2802 instructions, constants and the like. The data section of a running
2803 program is usually alterable: for example, C variables would be stored
2804 in the data section.
2805 @c @end ifset
2806
2807 @cindex bss section
2808 @item bss section
2809 This section contains zeroed bytes when your program begins running. It
2810 is used to hold uninitialized variables or common storage. The length of
2811 each partial program's bss section is important, but because it starts
2812 out containing zeroed bytes there is no need to store explicit zero
2813 bytes in the object file. The bss section was invented to eliminate
2814 those explicit zeros from object files.
2815
2816 @cindex absolute section
2817 @item absolute section
2818 Address 0 of this section is always ``relocated'' to runtime address 0.
2819 This is useful if you want to refer to an address that @code{@value{LD}} must
2820 not change when relocating. In this sense we speak of absolute
2821 addresses being ``unrelocatable'': they do not change during relocation.
2822
2823 @cindex undefined section
2824 @item undefined section
2825 This ``section'' is a catch-all for address references to objects not in
2826 the preceding sections.
2827 @c FIXME: ref to some other doc on obj-file formats could go here.
2828 @end table
2829
2830 @cindex relocation example
2831 An idealized example of three relocatable sections follows.
2832 @ifset COFF-ELF
2833 The example uses the traditional section names @samp{.text} and @samp{.data}.
2834 @end ifset
2835 Memory addresses are on the horizontal axis.
2836
2837 @c TEXI2ROFF-KILL
2838 @ifnottex
2839 @c END TEXI2ROFF-KILL
2840 @smallexample
2841 +-----+----+--+
2842 partial program # 1: |ttttt|dddd|00|
2843 +-----+----+--+
2844
2845 text data bss
2846 seg. seg. seg.
2847
2848 +---+---+---+
2849 partial program # 2: |TTT|DDD|000|
2850 +---+---+---+
2851
2852 +--+---+-----+--+----+---+-----+~~
2853 linked program: | |TTT|ttttt| |dddd|DDD|00000|
2854 +--+---+-----+--+----+---+-----+~~
2855
2856 addresses: 0 @dots{}
2857 @end smallexample
2858 @c TEXI2ROFF-KILL
2859 @end ifnottex
2860 @need 5000
2861 @tex
2862 \bigskip
2863 \line{\it Partial program \#1: \hfil}
2864 \line{\ibox{2.5cm}{\tt text}\ibox{2cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2865 \line{\boxit{2.5cm}{\tt ttttt}\boxit{2cm}{\tt dddd}\boxit{1cm}{\tt 00}\hfil}
2866
2867 \line{\it Partial program \#2: \hfil}
2868 \line{\ibox{1cm}{\tt text}\ibox{1.5cm}{\tt data}\ibox{1cm}{\tt bss}\hfil}
2869 \line{\boxit{1cm}{\tt TTT}\boxit{1.5cm}{\tt DDDD}\boxit{1cm}{\tt 000}\hfil}
2870
2871 \line{\it linked program: \hfil}
2872 \line{\ibox{.5cm}{}\ibox{1cm}{\tt text}\ibox{2.5cm}{}\ibox{.75cm}{}\ibox{2cm}{\tt data}\ibox{1.5cm}{}\ibox{2cm}{\tt bss}\hfil}
2873 \line{\boxit{.5cm}{}\boxit{1cm}{\tt TTT}\boxit{2.5cm}{\tt
2874 ttttt}\boxit{.75cm}{}\boxit{2cm}{\tt dddd}\boxit{1.5cm}{\tt
2875 DDDD}\boxit{2cm}{\tt 00000}\ \dots\hfil}
2876
2877 \line{\it addresses: \hfil}
2878 \line{0\dots\hfil}
2879
2880 @end tex
2881 @c END TEXI2ROFF-KILL
2882
2883 @node As Sections
2884 @section Assembler Internal Sections
2885
2886 @cindex internal assembler sections
2887 @cindex sections in messages, internal
2888 These sections are meant only for the internal use of @command{@value{AS}}. They
2889 have no meaning at run-time. You do not really need to know about these
2890 sections for most purposes; but they can be mentioned in @command{@value{AS}}
2891 warning messages, so it might be helpful to have an idea of their
2892 meanings to @command{@value{AS}}. These sections are used to permit the
2893 value of every expression in your assembly language program to be a
2894 section-relative address.
2895
2896 @table @b
2897 @cindex assembler internal logic error
2898 @item ASSEMBLER-INTERNAL-LOGIC-ERROR!
2899 An internal assembler logic error has been found. This means there is a
2900 bug in the assembler.
2901
2902 @cindex expr (internal section)
2903 @item expr section
2904 The assembler stores complex expression internally as combinations of
2905 symbols. When it needs to represent an expression as a symbol, it puts
2906 it in the expr section.
2907 @c FIXME item debug
2908 @c FIXME item transfer[t] vector preload
2909 @c FIXME item transfer[t] vector postload
2910 @c FIXME item register
2911 @end table
2912
2913 @node Sub-Sections
2914 @section Sub-Sections
2915
2916 @cindex numbered subsections
2917 @cindex grouping data
2918 @ifset aout-bout
2919 Assembled bytes
2920 @ifset COFF-ELF
2921 conventionally
2922 @end ifset
2923 fall into two sections: text and data.
2924 @end ifset
2925 You may have separate groups of
2926 @ifset GENERIC
2927 data in named sections
2928 @end ifset
2929 @ifclear GENERIC
2930 @ifclear aout-bout
2931 data in named sections
2932 @end ifclear
2933 @ifset aout-bout
2934 text or data
2935 @end ifset
2936 @end ifclear
2937 that you want to end up near to each other in the object file, even though they
2938 are not contiguous in the assembler source. @command{@value{AS}} allows you to
2939 use @dfn{subsections} for this purpose. Within each section, there can be
2940 numbered subsections with values from 0 to 8192. Objects assembled into the
2941 same subsection go into the object file together with other objects in the same
2942 subsection. For example, a compiler might want to store constants in the text
2943 section, but might not want to have them interspersed with the program being
2944 assembled. In this case, the compiler could issue a @samp{.text 0} before each
2945 section of code being output, and a @samp{.text 1} before each group of
2946 constants being output.
2947
2948 Subsections are optional. If you do not use subsections, everything
2949 goes in subsection number zero.
2950
2951 @ifset GENERIC
2952 Each subsection is zero-padded up to a multiple of four bytes.
2953 (Subsections may be padded a different amount on different flavors
2954 of @command{@value{AS}}.)
2955 @end ifset
2956 @ifclear GENERIC
2957 @ifset H8
2958 On the H8/300 and H8/500 platforms, each subsection is zero-padded to a word
2959 boundary (two bytes).
2960 The same is true on the Renesas SH.
2961 @end ifset
2962 @ifset I960
2963 @c FIXME section padding (alignment)?
2964 @c Rich Pixley says padding here depends on target obj code format; that
2965 @c doesn't seem particularly useful to say without further elaboration,
2966 @c so for now I say nothing about it. If this is a generic BFD issue,
2967 @c these paragraphs might need to vanish from this manual, and be
2968 @c discussed in BFD chapter of binutils (or some such).
2969 @end ifset
2970 @ifset A29K
2971 On the AMD 29K family, no particular padding is added to section or
2972 subsection sizes; @value{AS} forces no alignment on this platform.
2973 @end ifset
2974 @end ifclear
2975
2976 Subsections appear in your object file in numeric order, lowest numbered
2977 to highest. (All this to be compatible with other people's assemblers.)
2978 The object file contains no representation of subsections; @code{@value{LD}} and
2979 other programs that manipulate object files see no trace of them.
2980 They just see all your text subsections as a text section, and all your
2981 data subsections as a data section.
2982
2983 To specify which subsection you want subsequent statements assembled
2984 into, use a numeric argument to specify it, in a @samp{.text
2985 @var{expression}} or a @samp{.data @var{expression}} statement.
2986 @ifset COFF-ELF
2987 @ifset GENERIC
2988 When generating COFF or ELF output, you
2989 @end ifset
2990 @ifclear GENERIC
2991 You
2992 @end ifclear
2993 can also use an extra subsection
2994 argument with arbitrary named sections: @samp{.section @var{name},
2995 @var{expression}}.
2996 @end ifset
2997 @var{Expression} should be an absolute expression.
2998 (@xref{Expressions}.) If you just say @samp{.text} then @samp{.text 0}
2999 is assumed. Likewise @samp{.data} means @samp{.data 0}. Assembly
3000 begins in @code{text 0}. For instance:
3001 @smallexample
3002 .text 0 # The default subsection is text 0 anyway.
3003 .ascii "This lives in the first text subsection. *"
3004 .text 1
3005 .ascii "But this lives in the second text subsection."
3006 .data 0
3007 .ascii "This lives in the data section,"
3008 .ascii "in the first data subsection."
3009 .text 0
3010 .ascii "This lives in the first text section,"
3011 .ascii "immediately following the asterisk (*)."
3012 @end smallexample
3013
3014 Each section has a @dfn{location counter} incremented by one for every byte
3015 assembled into that section. Because subsections are merely a convenience
3016 restricted to @command{@value{AS}} there is no concept of a subsection location
3017 counter. There is no way to directly manipulate a location counter---but the
3018 @code{.align} directive changes it, and any label definition captures its
3019 current value. The location counter of the section where statements are being
3020 assembled is said to be the @dfn{active} location counter.
3021
3022 @node bss
3023 @section bss Section
3024
3025 @cindex bss section
3026 @cindex common variable storage
3027 The bss section is used for local common variable storage.
3028 You may allocate address space in the bss section, but you may
3029 not dictate data to load into it before your program executes. When
3030 your program starts running, all the contents of the bss
3031 section are zeroed bytes.
3032
3033 The @code{.lcomm} pseudo-op defines a symbol in the bss section; see
3034 @ref{Lcomm,,@code{.lcomm}}.
3035
3036 The @code{.comm} pseudo-op may be used to declare a common symbol, which is
3037 another form of uninitialized symbol; see @xref{Comm,,@code{.comm}}.
3038
3039 @ifset GENERIC
3040 When assembling for a target which supports multiple sections, such as ELF or
3041 COFF, you may switch into the @code{.bss} section and define symbols as usual;
3042 see @ref{Section,,@code{.section}}. You may only assemble zero values into the
3043 section. Typically the section will only contain symbol definitions and
3044 @code{.skip} directives (@pxref{Skip,,@code{.skip}}).
3045 @end ifset
3046
3047 @node Symbols
3048 @chapter Symbols
3049
3050 @cindex symbols
3051 Symbols are a central concept: the programmer uses symbols to name
3052 things, the linker uses symbols to link, and the debugger uses symbols
3053 to debug.
3054
3055 @quotation
3056 @cindex debuggers, and symbol order
3057 @emph{Warning:} @command{@value{AS}} does not place symbols in the object file in
3058 the same order they were declared. This may break some debuggers.
3059 @end quotation
3060
3061 @menu
3062 * Labels:: Labels
3063 * Setting Symbols:: Giving Symbols Other Values
3064 * Symbol Names:: Symbol Names
3065 * Dot:: The Special Dot Symbol
3066 * Symbol Attributes:: Symbol Attributes
3067 @end menu
3068
3069 @node Labels
3070 @section Labels
3071
3072 @cindex labels
3073 A @dfn{label} is written as a symbol immediately followed by a colon
3074 @samp{:}. The symbol then represents the current value of the
3075 active location counter, and is, for example, a suitable instruction
3076 operand. You are warned if you use the same symbol to represent two
3077 different locations: the first definition overrides any other
3078 definitions.
3079
3080 @ifset HPPA
3081 On the HPPA, the usual form for a label need not be immediately followed by a
3082 colon, but instead must start in column zero. Only one label may be defined on
3083 a single line. To work around this, the HPPA version of @command{@value{AS}} also
3084 provides a special directive @code{.label} for defining labels more flexibly.
3085 @end ifset
3086
3087 @node Setting Symbols
3088 @section Giving Symbols Other Values
3089
3090 @cindex assigning values to symbols
3091 @cindex symbol values, assigning
3092 A symbol can be given an arbitrary value by writing a symbol, followed
3093 by an equals sign @samp{=}, followed by an expression
3094 (@pxref{Expressions}). This is equivalent to using the @code{.set}
3095 directive. @xref{Set,,@code{.set}}.
3096
3097 @node Symbol Names
3098 @section Symbol Names
3099
3100 @cindex symbol names
3101 @cindex names, symbol
3102 @ifclear SPECIAL-SYMS
3103 Symbol names begin with a letter or with one of @samp{._}. On most
3104 machines, you can also use @code{$} in symbol names; exceptions are
3105 noted in @ref{Machine Dependencies}. That character may be followed by any
3106 string of digits, letters, dollar signs (unless otherwise noted in
3107 @ref{Machine Dependencies}), and underscores.
3108 @end ifclear
3109 @ifset A29K
3110 For the AMD 29K family, @samp{?} is also allowed in the
3111 body of a symbol name, though not at its beginning.
3112 @end ifset
3113
3114 @ifset SPECIAL-SYMS
3115 @ifset H8
3116 Symbol names begin with a letter or with one of @samp{._}. On the
3117 Renesas SH or the H8/500, you can also use @code{$} in symbol names. That
3118 character may be followed by any string of digits, letters, dollar signs (save
3119 on the H8/300), and underscores.
3120 @end ifset
3121 @end ifset
3122
3123 Case of letters is significant: @code{foo} is a different symbol name
3124 than @code{Foo}.
3125
3126 Each symbol has exactly one name. Each name in an assembly language program
3127 refers to exactly one symbol. You may use that symbol name any number of times
3128 in a program.
3129
3130 @subheading Local Symbol Names
3131
3132 @cindex local symbol names
3133 @cindex symbol names, local
3134 @cindex temporary symbol names
3135 @cindex symbol names, temporary
3136 Local symbols help compilers and programmers use names temporarily.
3137 They create symbols which are guaranteed to be unique over the entire scope of
3138 the input source code and which can be referred to by a simple notation.
3139 To define a local symbol, write a label of the form @samp{@b{N}:} (where @b{N}
3140 represents any positive integer). To refer to the most recent previous
3141 definition of that symbol write @samp{@b{N}b}, using the same number as when
3142 you defined the label. To refer to the next definition of a local label, write
3143 @samp{@b{N}f}--- The @samp{b} stands for``backwards'' and the @samp{f} stands
3144 for ``forwards''.
3145
3146 There is no restriction on how you can use these labels, and you can reuse them
3147 too. So that it is possible to repeatedly define the same local label (using
3148 the same number @samp{@b{N}}), although you can only refer to the most recently
3149 defined local label of that number (for a backwards reference) or the next
3150 definition of a specific local label for a forward reference. It is also worth
3151 noting that the first 10 local labels (@samp{@b{0:}}@dots{}@samp{@b{9:}}) are
3152 implemented in a slightly more efficient manner than the others.
3153
3154 Here is an example:
3155
3156 @smallexample
3157 1: branch 1f
3158 2: branch 1b
3159 1: branch 2f
3160 2: branch 1b
3161 @end smallexample
3162
3163 Which is the equivalent of:
3164
3165 @smallexample
3166 label_1: branch label_3
3167 label_2: branch label_1
3168 label_3: branch label_4
3169 label_4: branch label_3
3170 @end smallexample
3171
3172 Local symbol names are only a notational device. They are immediately
3173 transformed into more conventional symbol names before the assembler uses them.
3174 The symbol names stored in the symbol table, appearing in error messages and
3175 optionally emitted to the object file. The names are constructed using these
3176 parts:
3177
3178 @table @code
3179 @item L
3180 All local labels begin with @samp{L}. Normally both @command{@value{AS}} and
3181 @code{@value{LD}} forget symbols that start with @samp{L}. These labels are
3182 used for symbols you are never intended to see. If you use the
3183 @samp{-L} option then @command{@value{AS}} retains these symbols in the
3184 object file. If you also instruct @code{@value{LD}} to retain these symbols,
3185 you may use them in debugging.
3186
3187 @item @var{number}
3188 This is the number that was used in the local label definition. So if the
3189 label is written @samp{55:} then the number is @samp{55}.
3190
3191 @item @kbd{C-B}
3192 This unusual character is included so you do not accidentally invent a symbol
3193 of the same name. The character has ASCII value of @samp{\002} (control-B).
3194
3195 @item @emph{ordinal number}
3196 This is a serial number to keep the labels distinct. The first definition of
3197 @samp{0:} gets the number @samp{1}. The 15th definition of @samp{0:} gets the
3198 number @samp{15}, and so on. Likewise the first definition of @samp{1:} gets
3199 the number @samp{1} and its 15th defintion gets @samp{15} as well.
3200 @end table
3201
3202 So for example, the first @code{1:} is named @code{L1@kbd{C-B}1}, the 44th
3203 @code{3:} is named @code{L3@kbd{C-B}44}.
3204
3205 @subheading Dollar Local Labels
3206 @cindex dollar local symbols
3207
3208 @code{@value{AS}} also supports an even more local form of local labels called
3209 dollar labels. These labels go out of scope (ie they become undefined) as soon
3210 as a non-local label is defined. Thus they remain valid for only a small
3211 region of the input source code. Normal local labels, by contrast, remain in
3212 scope for the entire file, or until they are redefined by another occurrence of
3213 the same local label.
3214
3215 Dollar labels are defined in exactly the same way as ordinary local labels,
3216 except that instead of being terminated by a colon, they are terminated by a
3217 dollar sign. eg @samp{@b{55$}}.
3218
3219 They can also be distinguished from ordinary local labels by their transformed
3220 name which uses ASCII character @samp{\001} (control-A) as the magic character
3221 to distinguish them from ordinary labels. Thus the 5th defintion of @samp{6$}
3222 is named @samp{L6@kbd{C-A}5}.
3223
3224 @node Dot
3225 @section The Special Dot Symbol
3226
3227 @cindex dot (symbol)
3228 @cindex @code{.} (symbol)
3229 @cindex current address
3230 @cindex location counter
3231 The special symbol @samp{.} refers to the current address that
3232 @command{@value{AS}} is assembling into. Thus, the expression @samp{melvin:
3233 .long .} defines @code{melvin} to contain its own address.
3234 Assigning a value to @code{.} is treated the same as a @code{.org}
3235 directive. Thus, the expression @samp{.=.+4} is the same as saying
3236 @ifclear no-space-dir
3237 @samp{.space 4}.
3238 @end ifclear
3239 @ifset no-space-dir
3240 @ifset A29K
3241 @samp{.block 4}.
3242 @end ifset
3243 @end ifset
3244
3245 @node Symbol Attributes
3246 @section Symbol Attributes
3247
3248 @cindex symbol attributes
3249 @cindex attributes, symbol
3250 Every symbol has, as well as its name, the attributes ``Value'' and
3251 ``Type''. Depending on output format, symbols can also have auxiliary
3252 attributes.
3253 @ifset INTERNALS
3254 The detailed definitions are in @file{a.out.h}.
3255 @end ifset
3256
3257 If you use a symbol without defining it, @command{@value{AS}} assumes zero for
3258 all these attributes, and probably won't warn you. This makes the
3259 symbol an externally defined symbol, which is generally what you
3260 would want.
3261
3262 @menu
3263 * Symbol Value:: Value
3264 * Symbol Type:: Type
3265 @ifset aout-bout
3266 @ifset GENERIC
3267 * a.out Symbols:: Symbol Attributes: @code{a.out}
3268 @end ifset
3269 @ifclear GENERIC
3270 @ifclear BOUT
3271 * a.out Symbols:: Symbol Attributes: @code{a.out}
3272 @end ifclear
3273 @ifset BOUT
3274 * a.out Symbols:: Symbol Attributes: @code{a.out}, @code{b.out}
3275 @end ifset
3276 @end ifclear
3277 @end ifset
3278 @ifset COFF
3279 * COFF Symbols:: Symbol Attributes for COFF
3280 @end ifset
3281 @ifset SOM
3282 * SOM Symbols:: Symbol Attributes for SOM
3283 @end ifset
3284 @end menu
3285
3286 @node Symbol Value
3287 @subsection Value
3288
3289 @cindex value of a symbol
3290 @cindex symbol value
3291 The value of a symbol is (usually) 32 bits. For a symbol which labels a
3292 location in the text, data, bss or absolute sections the value is the
3293 number of addresses from the start of that section to the label.
3294 Naturally for text, data and bss sections the value of a symbol changes
3295 as @code{@value{LD}} changes section base addresses during linking. Absolute
3296 symbols' values do not change during linking: that is why they are
3297 called absolute.
3298
3299 The value of an undefined symbol is treated in a special way. If it is
3300 0 then the symbol is not defined in this assembler source file, and
3301 @code{@value{LD}} tries to determine its value from other files linked into the
3302 same program. You make this kind of symbol simply by mentioning a symbol
3303 name without defining it. A non-zero value represents a @code{.comm}
3304 common declaration. The value is how much common storage to reserve, in
3305 bytes (addresses). The symbol refers to the first address of the
3306 allocated storage.
3307
3308 @node Symbol Type
3309 @subsection Type
3310
3311 @cindex type of a symbol
3312 @cindex symbol type
3313 The type attribute of a symbol contains relocation (section)
3314 information, any flag settings indicating that a symbol is external, and
3315 (optionally), other information for linkers and debuggers. The exact
3316 format depends on the object-code output format in use.
3317
3318 @ifset aout-bout
3319 @ifclear GENERIC
3320 @ifset BOUT
3321 @c The following avoids a "widow" subsection title. @group would be
3322 @c better if it were available outside examples.
3323 @need 1000
3324 @node a.out Symbols
3325 @subsection Symbol Attributes: @code{a.out}, @code{b.out}
3326
3327 @cindex @code{b.out} symbol attributes
3328 @cindex symbol attributes, @code{b.out}
3329 These symbol attributes appear only when @command{@value{AS}} is configured for
3330 one of the Berkeley-descended object output formats---@code{a.out} or
3331 @code{b.out}.
3332
3333 @end ifset
3334 @ifclear BOUT
3335 @node a.out Symbols
3336 @subsection Symbol Attributes: @code{a.out}
3337
3338 @cindex @code{a.out} symbol attributes
3339 @cindex symbol attributes, @code{a.out}
3340
3341 @end ifclear
3342 @end ifclear
3343 @ifset GENERIC
3344 @node a.out Symbols
3345 @subsection Symbol Attributes: @code{a.out}
3346
3347 @cindex @code{a.out} symbol attributes
3348 @cindex symbol attributes, @code{a.out}
3349
3350 @end ifset
3351 @menu
3352 * Symbol Desc:: Descriptor
3353 * Symbol Other:: Other
3354 @end menu
3355
3356 @node Symbol Desc
3357 @subsubsection Descriptor
3358
3359 @cindex descriptor, of @code{a.out} symbol
3360 This is an arbitrary 16-bit value. You may establish a symbol's
3361 descriptor value by using a @code{.desc} statement
3362 (@pxref{Desc,,@code{.desc}}). A descriptor value means nothing to
3363 @command{@value{AS}}.
3364
3365 @node Symbol Other
3366 @subsubsection Other
3367
3368 @cindex other attribute, of @code{a.out} symbol
3369 This is an arbitrary 8-bit value. It means nothing to @command{@value{AS}}.
3370 @end ifset
3371
3372 @ifset COFF
3373 @node COFF Symbols
3374 @subsection Symbol Attributes for COFF
3375
3376 @cindex COFF symbol attributes
3377 @cindex symbol attributes, COFF
3378
3379 The COFF format supports a multitude of auxiliary symbol attributes;
3380 like the primary symbol attributes, they are set between @code{.def} and
3381 @code{.endef} directives.
3382
3383 @subsubsection Primary Attributes
3384
3385 @cindex primary attributes, COFF symbols
3386 The symbol name is set with @code{.def}; the value and type,
3387 respectively, with @code{.val} and @code{.type}.
3388
3389 @subsubsection Auxiliary Attributes
3390
3391 @cindex auxiliary attributes, COFF symbols
3392 The @command{@value{AS}} directives @code{.dim}, @code{.line}, @code{.scl},
3393 @code{.size}, and @code{.tag} can generate auxiliary symbol table
3394 information for COFF.
3395 @end ifset
3396
3397 @ifset SOM
3398 @node SOM Symbols
3399 @subsection Symbol Attributes for SOM
3400
3401 @cindex SOM symbol attributes
3402 @cindex symbol attributes, SOM
3403
3404 The SOM format for the HPPA supports a multitude of symbol attributes set with
3405 the @code{.EXPORT} and @code{.IMPORT} directives.
3406
3407 The attributes are described in @cite{HP9000 Series 800 Assembly
3408 Language Reference Manual} (HP 92432-90001) under the @code{IMPORT} and
3409 @code{EXPORT} assembler directive documentation.
3410 @end ifset
3411
3412 @node Expressions
3413 @chapter Expressions
3414
3415 @cindex expressions
3416 @cindex addresses
3417 @cindex numeric values
3418 An @dfn{expression} specifies an address or numeric value.
3419 Whitespace may precede and/or follow an expression.
3420
3421 The result of an expression must be an absolute number, or else an offset into
3422 a particular section. If an expression is not absolute, and there is not
3423 enough information when @command{@value{AS}} sees the expression to know its
3424 section, a second pass over the source program might be necessary to interpret
3425 the expression---but the second pass is currently not implemented.
3426 @command{@value{AS}} aborts with an error message in this situation.
3427
3428 @menu
3429 * Empty Exprs:: Empty Expressions
3430 * Integer Exprs:: Integer Expressions
3431 @end menu
3432
3433 @node Empty Exprs
3434 @section Empty Expressions
3435
3436 @cindex empty expressions
3437 @cindex expressions, empty
3438 An empty expression has no value: it is just whitespace or null.
3439 Wherever an absolute expression is required, you may omit the
3440 expression, and @command{@value{AS}} assumes a value of (absolute) 0. This
3441 is compatible with other assemblers.
3442
3443 @node Integer Exprs
3444 @section Integer Expressions
3445
3446 @cindex integer expressions
3447 @cindex expressions, integer
3448 An @dfn{integer expression} is one or more @emph{arguments} delimited
3449 by @emph{operators}.
3450
3451 @menu
3452 * Arguments:: Arguments
3453 * Operators:: Operators
3454 * Prefix Ops:: Prefix Operators
3455 * Infix Ops:: Infix Operators
3456 @end menu
3457
3458 @node Arguments
3459 @subsection Arguments
3460
3461 @cindex expression arguments
3462 @cindex arguments in expressions
3463 @cindex operands in expressions
3464 @cindex arithmetic operands
3465 @dfn{Arguments} are symbols, numbers or subexpressions. In other
3466 contexts arguments are sometimes called ``arithmetic operands''. In
3467 this manual, to avoid confusing them with the ``instruction operands'' of
3468 the machine language, we use the term ``argument'' to refer to parts of
3469 expressions only, reserving the word ``operand'' to refer only to machine
3470 instruction operands.
3471
3472 Symbols are evaluated to yield @{@var{section} @var{NNN}@} where
3473 @var{section} is one of text, data, bss, absolute,
3474 or undefined. @var{NNN} is a signed, 2's complement 32 bit
3475 integer.
3476
3477 Numbers are usually integers.
3478
3479 A number can be a flonum or bignum. In this case, you are warned
3480 that only the low order 32 bits are used, and @command{@value{AS}} pretends
3481 these 32 bits are an integer. You may write integer-manipulating
3482 instructions that act on exotic constants, compatible with other
3483 assemblers.
3484
3485 @cindex subexpressions
3486 Subexpressions are a left parenthesis @samp{(} followed by an integer
3487 expression, followed by a right parenthesis @samp{)}; or a prefix
3488 operator followed by an argument.
3489
3490 @node Operators
3491 @subsection Operators
3492
3493 @cindex operators, in expressions
3494 @cindex arithmetic functions
3495 @cindex functions, in expressions
3496 @dfn{Operators} are arithmetic functions, like @code{+} or @code{%}. Prefix
3497 operators are followed by an argument. Infix operators appear
3498 between their arguments. Operators may be preceded and/or followed by
3499 whitespace.
3500
3501 @node Prefix Ops
3502 @subsection Prefix Operator
3503
3504 @cindex prefix operators
3505 @command{@value{AS}} has the following @dfn{prefix operators}. They each take
3506 one argument, which must be absolute.
3507
3508 @c the tex/end tex stuff surrounding this small table is meant to make
3509 @c it align, on the printed page, with the similar table in the next
3510 @c section (which is inside an enumerate).
3511 @tex
3512 \global\advance\leftskip by \itemindent
3513 @end tex
3514
3515 @table @code
3516 @item -
3517 @dfn{Negation}. Two's complement negation.
3518 @item ~
3519 @dfn{Complementation}. Bitwise not.
3520 @end table
3521
3522 @tex
3523 \global\advance\leftskip by -\itemindent
3524 @end tex
3525
3526 @node Infix Ops
3527 @subsection Infix Operators
3528
3529 @cindex infix operators
3530 @cindex operators, permitted arguments
3531 @dfn{Infix operators} take two arguments, one on either side. Operators
3532 have precedence, but operations with equal precedence are performed left
3533 to right. Apart from @code{+} or @option{-}, both arguments must be
3534 absolute, and the result is absolute.
3535
3536 @enumerate
3537 @cindex operator precedence
3538 @cindex precedence of operators
3539
3540 @item
3541 Highest Precedence
3542
3543 @table @code
3544 @item *
3545 @dfn{Multiplication}.
3546
3547 @item /
3548 @dfn{Division}. Truncation is the same as the C operator @samp{/}
3549
3550 @item %
3551 @dfn{Remainder}.
3552
3553 @item <
3554 @itemx <<
3555 @dfn{Shift Left}. Same as the C operator @samp{<<}.
3556
3557 @item >
3558 @itemx >>
3559 @dfn{Shift Right}. Same as the C operator @samp{>>}.
3560 @end table
3561
3562 @item
3563 Intermediate precedence
3564
3565 @table @code
3566 @item |
3567
3568 @dfn{Bitwise Inclusive Or}.
3569
3570 @item &
3571 @dfn{Bitwise And}.
3572
3573 @item ^
3574 @dfn{Bitwise Exclusive Or}.
3575
3576 @item !
3577 @dfn{Bitwise Or Not}.
3578 @end table
3579
3580 @item
3581 Low Precedence
3582
3583 @table @code
3584 @cindex addition, permitted arguments
3585 @cindex plus, permitted arguments
3586 @cindex arguments for addition
3587 @item +
3588 @dfn{Addition}. If either argument is absolute, the result has the section of
3589 the other argument. You may not add together arguments from different
3590 sections.
3591
3592 @cindex subtraction, permitted arguments
3593 @cindex minus, permitted arguments
3594 @cindex arguments for subtraction
3595 @item -
3596 @dfn{Subtraction}. If the right argument is absolute, the
3597 result has the section of the left argument.
3598 If both arguments are in the same section, the result is absolute.
3599 You may not subtract arguments from different sections.
3600 @c FIXME is there still something useful to say about undefined - undefined ?
3601
3602 @cindex comparison expressions
3603 @cindex expressions, comparison
3604 @item ==
3605 @dfn{Is Equal To}
3606 @item <>
3607 @dfn{Is Not Equal To}
3608 @item <
3609 @dfn{Is Less Than}
3610 @itemx >
3611 @dfn{Is Greater Than}
3612 @itemx >=
3613 @dfn{Is Greater Than Or Equal To}
3614 @itemx <=
3615 @dfn{Is Less Than Or Equal To}
3616
3617 The comparison operators can be used as infix operators. A true results has a
3618 value of -1 whereas a false result has a value of 0. Note, these operators
3619 perform signed comparisons.
3620 @end table
3621
3622 @item Lowest Precedence
3623
3624 @table @code
3625 @item &&
3626 @dfn{Logical And}.
3627
3628 @item ||
3629 @dfn{Logical Or}.
3630
3631 These two logical operations can be used to combine the results of sub
3632 expressions. Note, unlike the comparison operators a true result returns a
3633 value of 1 but a false results does still return 0. Also note that the logical
3634 or operator has a slightly lower precedence than logical and.
3635
3636 @end table
3637 @end enumerate
3638
3639 In short, it's only meaningful to add or subtract the @emph{offsets} in an
3640 address; you can only have a defined section in one of the two arguments.
3641
3642 @node Pseudo Ops
3643 @chapter Assembler Directives
3644
3645 @cindex directives, machine independent
3646 @cindex pseudo-ops, machine independent
3647 @cindex machine independent directives
3648 All assembler directives have names that begin with a period (@samp{.}).
3649 The rest of the name is letters, usually in lower case.
3650
3651 This chapter discusses directives that are available regardless of the
3652 target machine configuration for the @sc{gnu} assembler.
3653 @ifset GENERIC
3654 Some machine configurations provide additional directives.
3655 @xref{Machine Dependencies}.
3656 @end ifset
3657 @ifclear GENERIC
3658 @ifset machine-directives
3659 @xref{Machine Dependencies} for additional directives.
3660 @end ifset
3661 @end ifclear
3662
3663 @menu
3664 * Abort:: @code{.abort}
3665 @ifset COFF
3666 * ABORT:: @code{.ABORT}
3667 @end ifset
3668
3669 * Align:: @code{.align @var{abs-expr} , @var{abs-expr}}
3670 * Ascii:: @code{.ascii "@var{string}"}@dots{}
3671 * Asciz:: @code{.asciz "@var{string}"}@dots{}
3672 * Balign:: @code{.balign @var{abs-expr} , @var{abs-expr}}
3673 * Byte:: @code{.byte @var{expressions}}
3674 * Comm:: @code{.comm @var{symbol} , @var{length} }
3675
3676 * CFI directives:: @code{.cfi_startproc}, @code{.cfi_endproc}, etc.
3677
3678 * Data:: @code{.data @var{subsection}}
3679 @ifset COFF
3680 * Def:: @code{.def @var{name}}
3681 @end ifset
3682 @ifset aout-bout
3683 * Desc:: @code{.desc @var{symbol}, @var{abs-expression}}
3684 @end ifset
3685 @ifset COFF
3686 * Dim:: @code{.dim}
3687 @end ifset
3688
3689 * Double:: @code{.double @var{flonums}}
3690 * Eject:: @code{.eject}
3691 * Else:: @code{.else}
3692 * Elseif:: @code{.elseif}
3693 * End:: @code{.end}
3694 @ifset COFF
3695 * Endef:: @code{.endef}
3696 @end ifset
3697
3698 * Endfunc:: @code{.endfunc}
3699 * Endif:: @code{.endif}
3700 * Equ:: @code{.equ @var{symbol}, @var{expression}}
3701 * Equiv:: @code{.equiv @var{symbol}, @var{expression}}
3702 * Err:: @code{.err}
3703 * Exitm:: @code{.exitm}
3704 * Extern:: @code{.extern}
3705 * Fail:: @code{.fail}
3706 @ifclear no-file-dir
3707 * File:: @code{.file @var{string}}
3708 @end ifclear
3709
3710 * Fill:: @code{.fill @var{repeat} , @var{size} , @var{value}}
3711 * Float:: @code{.float @var{flonums}}
3712 * Func:: @code{.func}
3713 * Global:: @code{.global @var{symbol}}, @code{.globl @var{symbol}}
3714 @ifset ELF
3715 * Hidden:: @code{.hidden @var{names}}
3716 @end ifset
3717
3718 * hword:: @code{.hword @var{expressions}}
3719 * Ident:: @code{.ident}
3720 * If:: @code{.if @var{absolute expression}}
3721 * Incbin:: @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
3722 * Include:: @code{.include "@var{file}"}
3723 * Int:: @code{.int @var{expressions}}
3724 @ifset ELF
3725 * Internal:: @code{.internal @var{names}}
3726 @end ifset
3727
3728 * Irp:: @code{.irp @var{symbol},@var{values}}@dots{}
3729 * Irpc:: @code{.irpc @var{symbol},@var{values}}@dots{}
3730 * Lcomm:: @code{.lcomm @var{symbol} , @var{length}}
3731 * Lflags:: @code{.lflags}
3732 @ifclear no-line-dir
3733 * Line:: @code{.line @var{line-number}}
3734 @end ifclear
3735
3736 * Ln:: @code{.ln @var{line-number}}
3737 * Linkonce:: @code{.linkonce [@var{type}]}
3738 * List:: @code{.list}
3739 * Long:: @code{.long @var{expressions}}
3740 @ignore
3741 * Lsym:: @code{.lsym @var{symbol}, @var{expression}}
3742 @end ignore
3743
3744 * Macro:: @code{.macro @var{name} @var{args}}@dots{}
3745 * MRI:: @code{.mri @var{val}}
3746 * Nolist:: @code{.nolist}
3747 * Octa:: @code{.octa @var{bignums}}
3748 * Org:: @code{.org @var{new-lc} , @var{fill}}
3749 * P2align:: @code{.p2align @var{abs-expr} , @var{abs-expr}}
3750 @ifset ELF
3751 * PopSection:: @code{.popsection}
3752 * Previous:: @code{.previous}
3753 @end ifset
3754
3755 * Print:: @code{.print @var{string}}
3756 @ifset ELF
3757 * Protected:: @code{.protected @var{names}}
3758 @end ifset
3759
3760 * Psize:: @code{.psize @var{lines}, @var{columns}}
3761 * Purgem:: @code{.purgem @var{name}}
3762 @ifset ELF
3763 * PushSection:: @code{.pushsection @var{name}}
3764 @end ifset
3765
3766 * Quad:: @code{.quad @var{bignums}}
3767 * Rept:: @code{.rept @var{count}}
3768 * Sbttl:: @code{.sbttl "@var{subheading}"}
3769 @ifset COFF
3770 * Scl:: @code{.scl @var{class}}
3771 @end ifset
3772 @ifset COFF-ELF
3773 * Section:: @code{.section @var{name}}
3774 @end ifset
3775
3776 * Set:: @code{.set @var{symbol}, @var{expression}}
3777 * Short:: @code{.short @var{expressions}}
3778 * Single:: @code{.single @var{flonums}}
3779 @ifset COFF-ELF
3780 * Size:: @code{.size [@var{name} , @var{expression}]}
3781 @end ifset
3782
3783 * Skip:: @code{.skip @var{size} , @var{fill}}
3784 * Sleb128:: @code{.sleb128 @var{expressions}}
3785 * Space:: @code{.space @var{size} , @var{fill}}
3786 @ifset have-stabs
3787 * Stab:: @code{.stabd, .stabn, .stabs}
3788 @end ifset
3789
3790 * String:: @code{.string "@var{str}"}
3791 * Struct:: @code{.struct @var{expression}}
3792 @ifset ELF
3793 * SubSection:: @code{.subsection}
3794 * Symver:: @code{.symver @var{name},@var{name2@@nodename}}
3795 @end ifset
3796
3797 @ifset COFF
3798 * Tag:: @code{.tag @var{structname}}
3799 @end ifset
3800
3801 * Text:: @code{.text @var{subsection}}
3802 * Title:: @code{.title "@var{heading}"}
3803 @ifset COFF-ELF
3804 * Type:: @code{.type <@var{int} | @var{name} , @var{type description}>}
3805 @end ifset
3806
3807 * Uleb128:: @code{.uleb128 @var{expressions}}
3808 @ifset COFF
3809 * Val:: @code{.val @var{addr}}
3810 @end ifset
3811
3812 @ifset ELF
3813 * Version:: @code{.version "@var{string}"}
3814 * VTableEntry:: @code{.vtable_entry @var{table}, @var{offset}}
3815 * VTableInherit:: @code{.vtable_inherit @var{child}, @var{parent}}
3816 * Weak:: @code{.weak @var{names}}
3817 @end ifset
3818
3819 * Word:: @code{.word @var{expressions}}
3820 * Deprecated:: Deprecated Directives
3821 @end menu
3822
3823 @node Abort
3824 @section @code{.abort}
3825
3826 @cindex @code{abort} directive
3827 @cindex stopping the assembly
3828 This directive stops the assembly immediately. It is for
3829 compatibility with other assemblers. The original idea was that the
3830 assembly language source would be piped into the assembler. If the sender
3831 of the source quit, it could use this directive tells @command{@value{AS}} to
3832 quit also. One day @code{.abort} will not be supported.
3833
3834 @ifset COFF
3835 @node ABORT
3836 @section @code{.ABORT}
3837
3838 @cindex @code{ABORT} directive
3839 When producing COFF output, @command{@value{AS}} accepts this directive as a
3840 synonym for @samp{.abort}.
3841
3842 @ifset BOUT
3843 When producing @code{b.out} output, @command{@value{AS}} accepts this directive,
3844 but ignores it.
3845 @end ifset
3846 @end ifset
3847
3848 @node Align
3849 @section @code{.align @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3850
3851 @cindex padding the location counter
3852 @cindex @code{align} directive
3853 Pad the location counter (in the current subsection) to a particular storage
3854 boundary. The first expression (which must be absolute) is the alignment
3855 required, as described below.
3856
3857 The second expression (also absolute) gives the fill value to be stored in the
3858 padding bytes. It (and the comma) may be omitted. If it is omitted, the
3859 padding bytes are normally zero. However, on some systems, if the section is
3860 marked as containing code and the fill value is omitted, the space is filled
3861 with no-op instructions.
3862
3863 The third expression is also absolute, and is also optional. If it is present,
3864 it is the maximum number of bytes that should be skipped by this alignment
3865 directive. If doing the alignment would require skipping more bytes than the
3866 specified maximum, then the alignment is not done at all. You can omit the
3867 fill value (the second argument) entirely by simply using two commas after the
3868 required alignment; this can be useful if you want the alignment to be filled
3869 with no-op instructions when appropriate.
3870
3871 The way the required alignment is specified varies from system to system.
3872 For the a29k, arc, hppa, i386 using ELF, i860, iq2000, m68k, m88k, or32,
3873 s390, sparc, tic4x, tic80 and xtensa, the first expression is the
3874 alignment request in bytes. For example @samp{.align 8} advances
3875 the location counter until it is a multiple of 8. If the location counter
3876 is already a multiple of 8, no change is needed. For the tic54x, the
3877 first expression is the alignment request in words.
3878
3879 For other systems, including the i386 using a.out format, and the arm and
3880 strongarm, it is the
3881 number of low-order zero bits the location counter must have after
3882 advancement. For example @samp{.align 3} advances the location
3883 counter until it a multiple of 8. If the location counter is already a
3884 multiple of 8, no change is needed.
3885
3886 This inconsistency is due to the different behaviors of the various
3887 native assemblers for these systems which GAS must emulate.
3888 GAS also provides @code{.balign} and @code{.p2align} directives,
3889 described later, which have a consistent behavior across all
3890 architectures (but are specific to GAS).
3891
3892 @node Ascii
3893 @section @code{.ascii "@var{string}"}@dots{}
3894
3895 @cindex @code{ascii} directive
3896 @cindex string literals
3897 @code{.ascii} expects zero or more string literals (@pxref{Strings})
3898 separated by commas. It assembles each string (with no automatic
3899 trailing zero byte) into consecutive addresses.
3900
3901 @node Asciz
3902 @section @code{.asciz "@var{string}"}@dots{}
3903
3904 @cindex @code{asciz} directive
3905 @cindex zero-terminated strings
3906 @cindex null-terminated strings
3907 @code{.asciz} is just like @code{.ascii}, but each string is followed by
3908 a zero byte. The ``z'' in @samp{.asciz} stands for ``zero''.
3909
3910 @node Balign
3911 @section @code{.balign[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
3912
3913 @cindex padding the location counter given number of bytes
3914 @cindex @code{balign} directive
3915 Pad the location counter (in the current subsection) to a particular
3916 storage boundary. The first expression (which must be absolute) is the
3917 alignment request in bytes. For example @samp{.balign 8} advances
3918 the location counter until it is a multiple of 8. If the location counter
3919 is already a multiple of 8, no change is needed.
3920
3921 The second expression (also absolute) gives the fill value to be stored in the
3922 padding bytes. It (and the comma) may be omitted. If it is omitted, the
3923 padding bytes are normally zero. However, on some systems, if the section is
3924 marked as containing code and the fill value is omitted, the space is filled
3925 with no-op instructions.
3926
3927 The third expression is also absolute, and is also optional. If it is present,
3928 it is the maximum number of bytes that should be skipped by this alignment
3929 directive. If doing the alignment would require skipping more bytes than the
3930 specified maximum, then the alignment is not done at all. You can omit the
3931 fill value (the second argument) entirely by simply using two commas after the
3932 required alignment; this can be useful if you want the alignment to be filled
3933 with no-op instructions when appropriate.
3934
3935 @cindex @code{balignw} directive
3936 @cindex @code{balignl} directive
3937 The @code{.balignw} and @code{.balignl} directives are variants of the
3938 @code{.balign} directive. The @code{.balignw} directive treats the fill
3939 pattern as a two byte word value. The @code{.balignl} directives treats the
3940 fill pattern as a four byte longword value. For example, @code{.balignw
3941 4,0x368d} will align to a multiple of 4. If it skips two bytes, they will be
3942 filled in with the value 0x368d (the exact placement of the bytes depends upon
3943 the endianness of the processor). If it skips 1 or 3 bytes, the fill value is
3944 undefined.
3945
3946 @node Byte
3947 @section @code{.byte @var{expressions}}
3948
3949 @cindex @code{byte} directive
3950 @cindex integers, one byte
3951 @code{.byte} expects zero or more expressions, separated by commas.
3952 Each expression is assembled into the next byte.
3953
3954 @node Comm
3955 @section @code{.comm @var{symbol} , @var{length} }
3956
3957 @cindex @code{comm} directive
3958 @cindex symbol, common
3959 @code{.comm} declares a common symbol named @var{symbol}. When linking, a
3960 common symbol in one object file may be merged with a defined or common symbol
3961 of the same name in another object file. If @code{@value{LD}} does not see a
3962 definition for the symbol--just one or more common symbols--then it will
3963 allocate @var{length} bytes of uninitialized memory. @var{length} must be an
3964 absolute expression. If @code{@value{LD}} sees multiple common symbols with
3965 the same name, and they do not all have the same size, it will allocate space
3966 using the largest size.
3967
3968 @ifset ELF
3969 When using ELF, the @code{.comm} directive takes an optional third argument.
3970 This is the desired alignment of the symbol, specified as a byte boundary (for
3971 example, an alignment of 16 means that the least significant 4 bits of the
3972 address should be zero). The alignment must be an absolute expression, and it
3973 must be a power of two. If @code{@value{LD}} allocates uninitialized memory
3974 for the common symbol, it will use the alignment when placing the symbol. If
3975 no alignment is specified, @command{@value{AS}} will set the alignment to the
3976 largest power of two less than or equal to the size of the symbol, up to a
3977 maximum of 16.
3978 @end ifset
3979
3980 @ifset HPPA
3981 The syntax for @code{.comm} differs slightly on the HPPA. The syntax is
3982 @samp{@var{symbol} .comm, @var{length}}; @var{symbol} is optional.
3983 @end ifset
3984
3985 @node CFI directives
3986 @section @code{.cfi_startproc}
3987 @cindex @code{cfi_startproc} directive
3988 @code{.cfi_startproc} is used at the beginning of each function that
3989 should have an entry in @code{.eh_frame}. It initializes some internal
3990 data structures and emits architecture dependent initial CFI instructions.
3991 Don't forget to close the function by
3992 @code{.cfi_endproc}.
3993
3994 @section @code{.cfi_endproc}
3995 @cindex @code{cfi_endproc} directive
3996 @code{.cfi_endproc} is used at the end of a function where it closes its
3997 unwind entry previously opened by
3998 @code{.cfi_startproc}. and emits it to @code{.eh_frame}.
3999
4000 @section @code{.cfi_def_cfa @var{register}, @var{offset}}
4001 @code{.cfi_def_cfa} defines a rule for computing CFA as: @i{take
4002 address from @var{register} and add @var{offset} to it}.
4003
4004 @section @code{.cfi_def_cfa_register @var{register}}
4005 @code{.cfi_def_cfa_register} modifies a rule for computing CFA. From
4006 now on @var{register} will be used instead of the old one. Offset
4007 remains the same.
4008
4009 @section @code{.cfi_def_cfa_offset @var{offset}}
4010 @code{.cfi_def_cfa_offset} modifies a rule for computing CFA. Register
4011 remains the same, but @var{offset} is new. Note that it is the
4012 absolute offset that will be added to a defined register to compute
4013 CFA address.
4014
4015 @section @code{.cfi_adjust_cfa_offset @var{offset}}
4016 Same as @code{.cfi_def_cfa_offset} but @var{offset} is a relative
4017 value that is added/substracted from the previous offset.
4018
4019 @section @code{.cfi_offset @var{register}, @var{offset}}
4020 Previous value of @var{register} is saved at offset @var{offset} from
4021 CFA.
4022
4023 @section @code{.cfi_rel_offset @var{register}, @var{offset}}
4024 Previous value of @var{register} is saved at offset @var{offset} from
4025 the current CFA register. This is transformed to @code{.cfi_offset}
4026 using the known displacement of the CFA register from the CFA.
4027 This is often easier to use, because the number will match the
4028 code it's annotating.
4029
4030 @section @code{.cfi_window_save}
4031 SPARC register window has been saved.
4032
4033 @section @code{.cfi_escape} @var{expression}[, @dots{}]
4034 Allows the user to add arbitrary bytes to the unwind info. One
4035 might use this to add OS-specific CFI opcodes, or generic CFI
4036 opcodes that GAS does not yet support.
4037
4038 @node Data
4039 @section @code{.data @var{subsection}}
4040
4041 @cindex @code{data} directive
4042 @code{.data} tells @command{@value{AS}} to assemble the following statements onto the
4043 end of the data subsection numbered @var{subsection} (which is an
4044 absolute expression). If @var{subsection} is omitted, it defaults
4045 to zero.
4046
4047 @ifset COFF
4048 @node Def
4049 @section @code{.def @var{name}}
4050
4051 @cindex @code{def} directive
4052 @cindex COFF symbols, debugging
4053 @cindex debugging COFF symbols
4054 Begin defining debugging information for a symbol @var{name}; the
4055 definition extends until the @code{.endef} directive is encountered.
4056 @ifset BOUT
4057
4058 This directive is only observed when @command{@value{AS}} is configured for COFF
4059 format output; when producing @code{b.out}, @samp{.def} is recognized,
4060 but ignored.
4061 @end ifset
4062 @end ifset
4063
4064 @ifset aout-bout
4065 @node Desc
4066 @section @code{.desc @var{symbol}, @var{abs-expression}}
4067
4068 @cindex @code{desc} directive
4069 @cindex COFF symbol descriptor
4070 @cindex symbol descriptor, COFF
4071 This directive sets the descriptor of the symbol (@pxref{Symbol Attributes})
4072 to the low 16 bits of an absolute expression.
4073
4074 @ifset COFF
4075 The @samp{.desc} directive is not available when @command{@value{AS}} is
4076 configured for COFF output; it is only for @code{a.out} or @code{b.out}
4077 object format. For the sake of compatibility, @command{@value{AS}} accepts
4078 it, but produces no output, when configured for COFF.
4079 @end ifset
4080 @end ifset
4081
4082 @ifset COFF
4083 @node Dim
4084 @section @code{.dim}
4085
4086 @cindex @code{dim} directive
4087 @cindex COFF auxiliary symbol information
4088 @cindex auxiliary symbol information, COFF
4089 This directive is generated by compilers to include auxiliary debugging
4090 information in the symbol table. It is only permitted inside
4091 @code{.def}/@code{.endef} pairs.
4092 @ifset BOUT
4093
4094 @samp{.dim} is only meaningful when generating COFF format output; when
4095 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
4096 ignores it.
4097 @end ifset
4098 @end ifset
4099
4100 @node Double
4101 @section @code{.double @var{flonums}}
4102
4103 @cindex @code{double} directive
4104 @cindex floating point numbers (double)
4105 @code{.double} expects zero or more flonums, separated by commas. It
4106 assembles floating point numbers.
4107 @ifset GENERIC
4108 The exact kind of floating point numbers emitted depends on how
4109 @command{@value{AS}} is configured. @xref{Machine Dependencies}.
4110 @end ifset
4111 @ifclear GENERIC
4112 @ifset IEEEFLOAT
4113 On the @value{TARGET} family @samp{.double} emits 64-bit floating-point numbers
4114 in @sc{ieee} format.
4115 @end ifset
4116 @end ifclear
4117
4118 @node Eject
4119 @section @code{.eject}
4120
4121 @cindex @code{eject} directive
4122 @cindex new page, in listings
4123 @cindex page, in listings
4124 @cindex listing control: new page
4125 Force a page break at this point, when generating assembly listings.
4126
4127 @node Else
4128 @section @code{.else}
4129
4130 @cindex @code{else} directive
4131 @code{.else} is part of the @command{@value{AS}} support for conditional
4132 assembly; @pxref{If,,@code{.if}}. It marks the beginning of a section
4133 of code to be assembled if the condition for the preceding @code{.if}
4134 was false.
4135
4136 @node Elseif
4137 @section @code{.elseif}
4138
4139 @cindex @code{elseif} directive
4140 @code{.elseif} is part of the @command{@value{AS}} support for conditional
4141 assembly; @pxref{If,,@code{.if}}. It is shorthand for beginning a new
4142 @code{.if} block that would otherwise fill the entire @code{.else} section.
4143
4144 @node End
4145 @section @code{.end}
4146
4147 @cindex @code{end} directive
4148 @code{.end} marks the end of the assembly file. @command{@value{AS}} does not
4149 process anything in the file past the @code{.end} directive.
4150
4151 @ifset COFF
4152 @node Endef
4153 @section @code{.endef}
4154
4155 @cindex @code{endef} directive
4156 This directive flags the end of a symbol definition begun with
4157 @code{.def}.
4158 @ifset BOUT
4159
4160 @samp{.endef} is only meaningful when generating COFF format output; if
4161 @command{@value{AS}} is configured to generate @code{b.out}, it accepts this
4162 directive but ignores it.
4163 @end ifset
4164 @end ifset
4165
4166 @node Endfunc
4167 @section @code{.endfunc}
4168 @cindex @code{endfunc} directive
4169 @code{.endfunc} marks the end of a function specified with @code{.func}.
4170
4171 @node Endif
4172 @section @code{.endif}
4173
4174 @cindex @code{endif} directive
4175 @code{.endif} is part of the @command{@value{AS}} support for conditional assembly;
4176 it marks the end of a block of code that is only assembled
4177 conditionally. @xref{If,,@code{.if}}.
4178
4179 @node Equ
4180 @section @code{.equ @var{symbol}, @var{expression}}
4181
4182 @cindex @code{equ} directive
4183 @cindex assigning values to symbols
4184 @cindex symbols, assigning values to
4185 This directive sets the value of @var{symbol} to @var{expression}.
4186 It is synonymous with @samp{.set}; @pxref{Set,,@code{.set}}.
4187
4188 @ifset HPPA
4189 The syntax for @code{equ} on the HPPA is
4190 @samp{@var{symbol} .equ @var{expression}}.
4191 @end ifset
4192
4193 @node Equiv
4194 @section @code{.equiv @var{symbol}, @var{expression}}
4195 @cindex @code{equiv} directive
4196 The @code{.equiv} directive is like @code{.equ} and @code{.set}, except that
4197 the assembler will signal an error if @var{symbol} is already defined. Note a
4198 symbol which has been referenced but not actually defined is considered to be
4199 undefined.
4200
4201 Except for the contents of the error message, this is roughly equivalent to
4202 @smallexample
4203 .ifdef SYM
4204 .err
4205 .endif
4206 .equ SYM,VAL
4207 @end smallexample
4208
4209 @node Err
4210 @section @code{.err}
4211 @cindex @code{err} directive
4212 If @command{@value{AS}} assembles a @code{.err} directive, it will print an error
4213 message and, unless the @option{-Z} option was used, it will not generate an
4214 object file. This can be used to signal error an conditionally compiled code.
4215
4216 @node Exitm
4217 @section @code{.exitm}
4218 Exit early from the current macro definition. @xref{Macro}.
4219
4220 @node Extern
4221 @section @code{.extern}
4222
4223 @cindex @code{extern} directive
4224 @code{.extern} is accepted in the source program---for compatibility
4225 with other assemblers---but it is ignored. @command{@value{AS}} treats
4226 all undefined symbols as external.
4227
4228 @node Fail
4229 @section @code{.fail @var{expression}}
4230
4231 @cindex @code{fail} directive
4232 Generates an error or a warning. If the value of the @var{expression} is 500
4233 or more, @command{@value{AS}} will print a warning message. If the value is less
4234 than 500, @command{@value{AS}} will print an error message. The message will
4235 include the value of @var{expression}. This can occasionally be useful inside
4236 complex nested macros or conditional assembly.
4237
4238 @ifclear no-file-dir
4239 @node File
4240 @section @code{.file @var{string}}
4241
4242 @cindex @code{file} directive
4243 @cindex logical file name
4244 @cindex file name, logical
4245 @code{.file} tells @command{@value{AS}} that we are about to start a new logical
4246 file. @var{string} is the new file name. In general, the filename is
4247 recognized whether or not it is surrounded by quotes @samp{"}; but if you wish
4248 to specify an empty file name, you must give the quotes--@code{""}. This
4249 statement may go away in future: it is only recognized to be compatible with
4250 old @command{@value{AS}} programs.
4251 @ifset A29K
4252 In some configurations of @command{@value{AS}}, @code{.file} has already been
4253 removed to avoid conflicts with other assemblers. @xref{Machine Dependencies}.
4254 @end ifset
4255 @end ifclear
4256
4257 @node Fill
4258 @section @code{.fill @var{repeat} , @var{size} , @var{value}}
4259
4260 @cindex @code{fill} directive
4261 @cindex writing patterns in memory
4262 @cindex patterns, writing in memory
4263 @var{repeat}, @var{size} and @var{value} are absolute expressions.
4264 This emits @var{repeat} copies of @var{size} bytes. @var{Repeat}
4265 may be zero or more. @var{Size} may be zero or more, but if it is
4266 more than 8, then it is deemed to have the value 8, compatible with
4267 other people's assemblers. The contents of each @var{repeat} bytes
4268 is taken from an 8-byte number. The highest order 4 bytes are
4269 zero. The lowest order 4 bytes are @var{value} rendered in the
4270 byte-order of an integer on the computer @command{@value{AS}} is assembling for.
4271 Each @var{size} bytes in a repetition is taken from the lowest order
4272 @var{size} bytes of this number. Again, this bizarre behavior is
4273 compatible with other people's assemblers.
4274
4275 @var{size} and @var{value} are optional.
4276 If the second comma and @var{value} are absent, @var{value} is
4277 assumed zero. If the first comma and following tokens are absent,
4278 @var{size} is assumed to be 1.
4279
4280 @node Float
4281 @section @code{.float @var{flonums}}
4282
4283 @cindex floating point numbers (single)
4284 @cindex @code{float} directive
4285 This directive assembles zero or more flonums, separated by commas. It
4286 has the same effect as @code{.single}.
4287 @ifset GENERIC
4288 The exact kind of floating point numbers emitted depends on how
4289 @command{@value{AS}} is configured.
4290 @xref{Machine Dependencies}.
4291 @end ifset
4292 @ifclear GENERIC
4293 @ifset IEEEFLOAT
4294 On the @value{TARGET} family, @code{.float} emits 32-bit floating point numbers
4295 in @sc{ieee} format.
4296 @end ifset
4297 @end ifclear
4298
4299 @node Func
4300 @section @code{.func @var{name}[,@var{label}]}
4301 @cindex @code{func} directive
4302 @code{.func} emits debugging information to denote function @var{name}, and
4303 is ignored unless the file is assembled with debugging enabled.
4304 Only @samp{--gstabs[+]} is currently supported.
4305 @var{label} is the entry point of the function and if omitted @var{name}
4306 prepended with the @samp{leading char} is used.
4307 @samp{leading char} is usually @code{_} or nothing, depending on the target.
4308 All functions are currently defined to have @code{void} return type.
4309 The function must be terminated with @code{.endfunc}.
4310
4311 @node Global
4312 @section @code{.global @var{symbol}}, @code{.globl @var{symbol}}
4313
4314 @cindex @code{global} directive
4315 @cindex symbol, making visible to linker
4316 @code{.global} makes the symbol visible to @code{@value{LD}}. If you define
4317 @var{symbol} in your partial program, its value is made available to
4318 other partial programs that are linked with it. Otherwise,
4319 @var{symbol} takes its attributes from a symbol of the same name
4320 from another file linked into the same program.
4321
4322 Both spellings (@samp{.globl} and @samp{.global}) are accepted, for
4323 compatibility with other assemblers.
4324
4325 @ifset HPPA
4326 On the HPPA, @code{.global} is not always enough to make it accessible to other
4327 partial programs. You may need the HPPA-only @code{.EXPORT} directive as well.
4328 @xref{HPPA Directives,, HPPA Assembler Directives}.
4329 @end ifset
4330
4331 @ifset ELF
4332 @node Hidden
4333 @section @code{.hidden @var{names}}
4334
4335 @cindex @code{hidden} directive
4336 @cindex visibility
4337 This one of the ELF visibility directives. The other two are
4338 @code{.internal} (@pxref{Internal,,@code{.internal}}) and
4339 @code{.protected} (@pxref{Protected,,@code{.protected}}).
4340
4341 This directive overrides the named symbols default visibility (which is set by
4342 their binding: local, global or weak). The directive sets the visibility to
4343 @code{hidden} which means that the symbols are not visible to other components.
4344 Such symbols are always considered to be @code{protected} as well.
4345 @end ifset
4346
4347 @node hword
4348 @section @code{.hword @var{expressions}}
4349
4350 @cindex @code{hword} directive
4351 @cindex integers, 16-bit
4352 @cindex numbers, 16-bit
4353 @cindex sixteen bit integers
4354 This expects zero or more @var{expressions}, and emits
4355 a 16 bit number for each.
4356
4357 @ifset GENERIC
4358 This directive is a synonym for @samp{.short}; depending on the target
4359 architecture, it may also be a synonym for @samp{.word}.
4360 @end ifset
4361 @ifclear GENERIC
4362 @ifset W32
4363 This directive is a synonym for @samp{.short}.
4364 @end ifset
4365 @ifset W16
4366 This directive is a synonym for both @samp{.short} and @samp{.word}.
4367 @end ifset
4368 @end ifclear
4369
4370 @node Ident
4371 @section @code{.ident}
4372
4373 @cindex @code{ident} directive
4374 This directive is used by some assemblers to place tags in object files.
4375 @command{@value{AS}} simply accepts the directive for source-file
4376 compatibility with such assemblers, but does not actually emit anything
4377 for it.
4378
4379 @node If
4380 @section @code{.if @var{absolute expression}}
4381
4382 @cindex conditional assembly
4383 @cindex @code{if} directive
4384 @code{.if} marks the beginning of a section of code which is only
4385 considered part of the source program being assembled if the argument
4386 (which must be an @var{absolute expression}) is non-zero. The end of
4387 the conditional section of code must be marked by @code{.endif}
4388 (@pxref{Endif,,@code{.endif}}); optionally, you may include code for the
4389 alternative condition, flagged by @code{.else} (@pxref{Else,,@code{.else}}).
4390 If you have several conditions to check, @code{.elseif} may be used to avoid
4391 nesting blocks if/else within each subsequent @code{.else} block.
4392
4393 The following variants of @code{.if} are also supported:
4394 @table @code
4395 @cindex @code{ifdef} directive
4396 @item .ifdef @var{symbol}
4397 Assembles the following section of code if the specified @var{symbol}
4398 has been defined. Note a symbol which has been referenced but not yet defined
4399 is considered to be undefined.
4400
4401 @cindex @code{ifc} directive
4402 @item .ifc @var{string1},@var{string2}
4403 Assembles the following section of code if the two strings are the same. The
4404 strings may be optionally quoted with single quotes. If they are not quoted,
4405 the first string stops at the first comma, and the second string stops at the
4406 end of the line. Strings which contain whitespace should be quoted. The
4407 string comparison is case sensitive.
4408
4409 @cindex @code{ifeq} directive
4410 @item .ifeq @var{absolute expression}
4411 Assembles the following section of code if the argument is zero.
4412
4413 @cindex @code{ifeqs} directive
4414 @item .ifeqs @var{string1},@var{string2}
4415 Another form of @code{.ifc}. The strings must be quoted using double quotes.
4416
4417 @cindex @code{ifge} directive
4418 @item .ifge @var{absolute expression}
4419 Assembles the following section of code if the argument is greater than or
4420 equal to zero.
4421
4422 @cindex @code{ifgt} directive
4423 @item .ifgt @var{absolute expression}
4424 Assembles the following section of code if the argument is greater than zero.
4425
4426 @cindex @code{ifle} directive
4427 @item .ifle @var{absolute expression}
4428 Assembles the following section of code if the argument is less than or equal
4429 to zero.
4430
4431 @cindex @code{iflt} directive
4432 @item .iflt @var{absolute expression}
4433 Assembles the following section of code if the argument is less than zero.
4434
4435 @cindex @code{ifnc} directive
4436 @item .ifnc @var{string1},@var{string2}.
4437 Like @code{.ifc}, but the sense of the test is reversed: this assembles the
4438 following section of code if the two strings are not the same.
4439
4440 @cindex @code{ifndef} directive
4441 @cindex @code{ifnotdef} directive
4442 @item .ifndef @var{symbol}
4443 @itemx .ifnotdef @var{symbol}
4444 Assembles the following section of code if the specified @var{symbol}
4445 has not been defined. Both spelling variants are equivalent. Note a symbol
4446 which has been referenced but not yet defined is considered to be undefined.
4447
4448 @cindex @code{ifne} directive
4449 @item .ifne @var{absolute expression}
4450 Assembles the following section of code if the argument is not equal to zero
4451 (in other words, this is equivalent to @code{.if}).
4452
4453 @cindex @code{ifnes} directive
4454 @item .ifnes @var{string1},@var{string2}
4455 Like @code{.ifeqs}, but the sense of the test is reversed: this assembles the
4456 following section of code if the two strings are not the same.
4457 @end table
4458
4459 @node Incbin
4460 @section @code{.incbin "@var{file}"[,@var{skip}[,@var{count}]]}
4461
4462 @cindex @code{incbin} directive
4463 @cindex binary files, including
4464 The @code{incbin} directive includes @var{file} verbatim at the current
4465 location. You can control the search paths used with the @samp{-I} command-line
4466 option (@pxref{Invoking,,Command-Line Options}). Quotation marks are required
4467 around @var{file}.
4468
4469 The @var{skip} argument skips a number of bytes from the start of the
4470 @var{file}. The @var{count} argument indicates the maximum number of bytes to
4471 read. Note that the data is not aligned in any way, so it is the user's
4472 responsibility to make sure that proper alignment is provided both before and
4473 after the @code{incbin} directive.
4474
4475 @node Include
4476 @section @code{.include "@var{file}"}
4477
4478 @cindex @code{include} directive
4479 @cindex supporting files, including
4480 @cindex files, including
4481 This directive provides a way to include supporting files at specified
4482 points in your source program. The code from @var{file} is assembled as
4483 if it followed the point of the @code{.include}; when the end of the
4484 included file is reached, assembly of the original file continues. You
4485 can control the search paths used with the @samp{-I} command-line option
4486 (@pxref{Invoking,,Command-Line Options}). Quotation marks are required
4487 around @var{file}.
4488
4489 @node Int
4490 @section @code{.int @var{expressions}}
4491
4492 @cindex @code{int} directive
4493 @cindex integers, 32-bit
4494 Expect zero or more @var{expressions}, of any section, separated by commas.
4495 For each expression, emit a number that, at run time, is the value of that
4496 expression. The byte order and bit size of the number depends on what kind
4497 of target the assembly is for.
4498
4499 @ifclear GENERIC
4500 @ifset H8
4501 On the H8/500 and most forms of the H8/300, @code{.int} emits 16-bit
4502 integers. On the H8/300H and the Renesas SH, however, @code{.int} emits
4503 32-bit integers.
4504 @end ifset
4505 @end ifclear
4506
4507 @ifset ELF
4508 @node Internal
4509 @section @code{.internal @var{names}}
4510
4511 @cindex @code{internal} directive
4512 @cindex visibility
4513 This one of the ELF visibility directives. The other two are
4514 @code{.hidden} (@pxref{Hidden,,@code{.hidden}}) and
4515 @code{.protected} (@pxref{Protected,,@code{.protected}}).
4516
4517 This directive overrides the named symbols default visibility (which is set by
4518 their binding: local, global or weak). The directive sets the visibility to
4519 @code{internal} which means that the symbols are considered to be @code{hidden}
4520 (i.e., not visible to other components), and that some extra, processor specific
4521 processing must also be performed upon the symbols as well.
4522 @end ifset
4523
4524 @node Irp
4525 @section @code{.irp @var{symbol},@var{values}}@dots{}
4526
4527 @cindex @code{irp} directive
4528 Evaluate a sequence of statements assigning different values to @var{symbol}.
4529 The sequence of statements starts at the @code{.irp} directive, and is
4530 terminated by an @code{.endr} directive. For each @var{value}, @var{symbol} is
4531 set to @var{value}, and the sequence of statements is assembled. If no
4532 @var{value} is listed, the sequence of statements is assembled once, with
4533 @var{symbol} set to the null string. To refer to @var{symbol} within the
4534 sequence of statements, use @var{\symbol}.
4535
4536 For example, assembling
4537
4538 @example
4539 .irp param,1,2,3
4540 move d\param,sp@@-
4541 .endr
4542 @end example
4543
4544 is equivalent to assembling
4545
4546 @example
4547 move d1,sp@@-
4548 move d2,sp@@-
4549 move d3,sp@@-
4550 @end example
4551
4552 @node Irpc
4553 @section @code{.irpc @var{symbol},@var{values}}@dots{}
4554
4555 @cindex @code{irpc} directive
4556 Evaluate a sequence of statements assigning different values to @var{symbol}.
4557 The sequence of statements starts at the @code{.irpc} directive, and is
4558 terminated by an @code{.endr} directive. For each character in @var{value},
4559 @var{symbol} is set to the character, and the sequence of statements is
4560 assembled. If no @var{value} is listed, the sequence of statements is
4561 assembled once, with @var{symbol} set to the null string. To refer to
4562 @var{symbol} within the sequence of statements, use @var{\symbol}.
4563
4564 For example, assembling
4565
4566 @example
4567 .irpc param,123
4568 move d\param,sp@@-
4569 .endr
4570 @end example
4571
4572 is equivalent to assembling
4573
4574 @example
4575 move d1,sp@@-
4576 move d2,sp@@-
4577 move d3,sp@@-
4578 @end example
4579
4580 @node Lcomm
4581 @section @code{.lcomm @var{symbol} , @var{length}}
4582
4583 @cindex @code{lcomm} directive
4584 @cindex local common symbols
4585 @cindex symbols, local common
4586 Reserve @var{length} (an absolute expression) bytes for a local common
4587 denoted by @var{symbol}. The section and value of @var{symbol} are
4588 those of the new local common. The addresses are allocated in the bss
4589 section, so that at run-time the bytes start off zeroed. @var{Symbol}
4590 is not declared global (@pxref{Global,,@code{.global}}), so is normally
4591 not visible to @code{@value{LD}}.
4592
4593 @ifset GENERIC
4594 Some targets permit a third argument to be used with @code{.lcomm}. This
4595 argument specifies the desired alignment of the symbol in the bss section.
4596 @end ifset
4597
4598 @ifset HPPA
4599 The syntax for @code{.lcomm} differs slightly on the HPPA. The syntax is
4600 @samp{@var{symbol} .lcomm, @var{length}}; @var{symbol} is optional.
4601 @end ifset
4602
4603 @node Lflags
4604 @section @code{.lflags}
4605
4606 @cindex @code{lflags} directive (ignored)
4607 @command{@value{AS}} accepts this directive, for compatibility with other
4608 assemblers, but ignores it.
4609
4610 @ifclear no-line-dir
4611 @node Line
4612 @section @code{.line @var{line-number}}
4613
4614 @cindex @code{line} directive
4615 @end ifclear
4616 @ifset no-line-dir
4617 @node Ln
4618 @section @code{.ln @var{line-number}}
4619
4620 @cindex @code{ln} directive
4621 @end ifset
4622 @cindex logical line number
4623 @ifset aout-bout
4624 Change the logical line number. @var{line-number} must be an absolute
4625 expression. The next line has that logical line number. Therefore any other
4626 statements on the current line (after a statement separator character) are
4627 reported as on logical line number @var{line-number} @minus{} 1. One day
4628 @command{@value{AS}} will no longer support this directive: it is recognized only
4629 for compatibility with existing assembler programs.
4630
4631 @ifset GENERIC
4632 @ifset A29K
4633 @emph{Warning:} In the AMD29K configuration of @value{AS}, this command is
4634 not available; use the synonym @code{.ln} in that context.
4635 @end ifset
4636 @end ifset
4637 @end ifset
4638
4639 @ifclear no-line-dir
4640 Even though this is a directive associated with the @code{a.out} or
4641 @code{b.out} object-code formats, @command{@value{AS}} still recognizes it
4642 when producing COFF output, and treats @samp{.line} as though it
4643 were the COFF @samp{.ln} @emph{if} it is found outside a
4644 @code{.def}/@code{.endef} pair.
4645
4646 Inside a @code{.def}, @samp{.line} is, instead, one of the directives
4647 used by compilers to generate auxiliary symbol information for
4648 debugging.
4649 @end ifclear
4650
4651 @node Linkonce
4652 @section @code{.linkonce [@var{type}]}
4653 @cindex COMDAT
4654 @cindex @code{linkonce} directive
4655 @cindex common sections
4656 Mark the current section so that the linker only includes a single copy of it.
4657 This may be used to include the same section in several different object files,
4658 but ensure that the linker will only include it once in the final output file.
4659 The @code{.linkonce} pseudo-op must be used for each instance of the section.
4660 Duplicate sections are detected based on the section name, so it should be
4661 unique.
4662
4663 This directive is only supported by a few object file formats; as of this
4664 writing, the only object file format which supports it is the Portable
4665 Executable format used on Windows NT.
4666
4667 The @var{type} argument is optional. If specified, it must be one of the
4668 following strings. For example:
4669 @smallexample
4670 .linkonce same_size
4671 @end smallexample
4672 Not all types may be supported on all object file formats.
4673
4674 @table @code
4675 @item discard
4676 Silently discard duplicate sections. This is the default.
4677
4678 @item one_only
4679 Warn if there are duplicate sections, but still keep only one copy.
4680
4681 @item same_size
4682 Warn if any of the duplicates have different sizes.
4683
4684 @item same_contents
4685 Warn if any of the duplicates do not have exactly the same contents.
4686 @end table
4687
4688 @node Ln
4689 @section @code{.ln @var{line-number}}
4690
4691 @cindex @code{ln} directive
4692 @ifclear no-line-dir
4693 @samp{.ln} is a synonym for @samp{.line}.
4694 @end ifclear
4695 @ifset no-line-dir
4696 Tell @command{@value{AS}} to change the logical line number. @var{line-number}
4697 must be an absolute expression. The next line has that logical
4698 line number, so any other statements on the current line (after a
4699 statement separator character @code{;}) are reported as on logical
4700 line number @var{line-number} @minus{} 1.
4701 @ifset BOUT
4702
4703 This directive is accepted, but ignored, when @command{@value{AS}} is
4704 configured for @code{b.out}; its effect is only associated with COFF
4705 output format.
4706 @end ifset
4707 @end ifset
4708
4709 @node MRI
4710 @section @code{.mri @var{val}}
4711
4712 @cindex @code{mri} directive
4713 @cindex MRI mode, temporarily
4714 If @var{val} is non-zero, this tells @command{@value{AS}} to enter MRI mode. If
4715 @var{val} is zero, this tells @command{@value{AS}} to exit MRI mode. This change
4716 affects code assembled until the next @code{.mri} directive, or until the end
4717 of the file. @xref{M, MRI mode, MRI mode}.
4718
4719 @node List
4720 @section @code{.list}
4721
4722 @cindex @code{list} directive
4723 @cindex listing control, turning on
4724 Control (in conjunction with the @code{.nolist} directive) whether or
4725 not assembly listings are generated. These two directives maintain an
4726 internal counter (which is zero initially). @code{.list} increments the
4727 counter, and @code{.nolist} decrements it. Assembly listings are
4728 generated whenever the counter is greater than zero.
4729
4730 By default, listings are disabled. When you enable them (with the
4731 @samp{-a} command line option; @pxref{Invoking,,Command-Line Options}),
4732 the initial value of the listing counter is one.
4733
4734 @node Long
4735 @section @code{.long @var{expressions}}
4736
4737 @cindex @code{long} directive
4738 @code{.long} is the same as @samp{.int}, @pxref{Int,,@code{.int}}.
4739
4740 @ignore
4741 @c no one seems to know what this is for or whether this description is
4742 @c what it really ought to do
4743 @node Lsym
4744 @section @code{.lsym @var{symbol}, @var{expression}}
4745
4746 @cindex @code{lsym} directive
4747 @cindex symbol, not referenced in assembly
4748 @code{.lsym} creates a new symbol named @var{symbol}, but does not put it in
4749 the hash table, ensuring it cannot be referenced by name during the
4750 rest of the assembly. This sets the attributes of the symbol to be
4751 the same as the expression value:
4752 @smallexample
4753 @var{other} = @var{descriptor} = 0
4754 @var{type} = @r{(section of @var{expression})}
4755 @var{value} = @var{expression}
4756 @end smallexample
4757 @noindent
4758 The new symbol is not flagged as external.
4759 @end ignore
4760
4761 @node Macro
4762 @section @code{.macro}
4763
4764 @cindex macros
4765 The commands @code{.macro} and @code{.endm} allow you to define macros that
4766 generate assembly output. For example, this definition specifies a macro
4767 @code{sum} that puts a sequence of numbers into memory:
4768
4769 @example
4770 .macro sum from=0, to=5
4771 .long \from
4772 .if \to-\from
4773 sum "(\from+1)",\to
4774 .endif
4775 .endm
4776 @end example
4777
4778 @noindent
4779 With that definition, @samp{SUM 0,5} is equivalent to this assembly input:
4780
4781 @example
4782 .long 0
4783 .long 1
4784 .long 2
4785 .long 3
4786 .long 4
4787 .long 5
4788 @end example
4789
4790 @ftable @code
4791 @item .macro @var{macname}
4792 @itemx .macro @var{macname} @var{macargs} @dots{}
4793 @cindex @code{macro} directive
4794 Begin the definition of a macro called @var{macname}. If your macro
4795 definition requires arguments, specify their names after the macro name,
4796 separated by commas or spaces. You can supply a default value for any
4797 macro argument by following the name with @samp{=@var{deflt}}. For
4798 example, these are all valid @code{.macro} statements:
4799
4800 @table @code
4801 @item .macro comm
4802 Begin the definition of a macro called @code{comm}, which takes no
4803 arguments.
4804
4805 @item .macro plus1 p, p1
4806 @itemx .macro plus1 p p1
4807 Either statement begins the definition of a macro called @code{plus1},
4808 which takes two arguments; within the macro definition, write
4809 @samp{\p} or @samp{\p1} to evaluate the arguments.
4810
4811 @item .macro reserve_str p1=0 p2
4812 Begin the definition of a macro called @code{reserve_str}, with two
4813 arguments. The first argument has a default value, but not the second.
4814 After the definition is complete, you can call the macro either as
4815 @samp{reserve_str @var{a},@var{b}} (with @samp{\p1} evaluating to
4816 @var{a} and @samp{\p2} evaluating to @var{b}), or as @samp{reserve_str
4817 ,@var{b}} (with @samp{\p1} evaluating as the default, in this case
4818 @samp{0}, and @samp{\p2} evaluating to @var{b}).
4819 @end table
4820
4821 When you call a macro, you can specify the argument values either by
4822 position, or by keyword. For example, @samp{sum 9,17} is equivalent to
4823 @samp{sum to=17, from=9}.
4824
4825 @item .endm
4826 @cindex @code{endm} directive
4827 Mark the end of a macro definition.
4828
4829 @item .exitm
4830 @cindex @code{exitm} directive
4831 Exit early from the current macro definition.
4832
4833 @cindex number of macros executed
4834 @cindex macros, count executed
4835 @item \@@
4836 @command{@value{AS}} maintains a counter of how many macros it has
4837 executed in this pseudo-variable; you can copy that number to your
4838 output with @samp{\@@}, but @emph{only within a macro definition}.
4839
4840 @ignore
4841 @item LOCAL @var{name} [ , @dots{} ]
4842 @emph{Warning: @code{LOCAL} is only available if you select ``alternate
4843 macro syntax'' with @samp{-a} or @samp{--alternate}.} @xref{Alternate,,
4844 Alternate macro syntax}.
4845
4846 Generate a string replacement for each of the @var{name} arguments, and
4847 replace any instances of @var{name} in each macro expansion. The
4848 replacement string is unique in the assembly, and different for each
4849 separate macro expansion. @code{LOCAL} allows you to write macros that
4850 define symbols, without fear of conflict between separate macro expansions.
4851 @end ignore
4852 @end ftable
4853
4854 @node Nolist
4855 @section @code{.nolist}
4856
4857 @cindex @code{nolist} directive
4858 @cindex listing control, turning off
4859 Control (in conjunction with the @code{.list} directive) whether or
4860 not assembly listings are generated. These two directives maintain an
4861 internal counter (which is zero initially). @code{.list} increments the
4862 counter, and @code{.nolist} decrements it. Assembly listings are
4863 generated whenever the counter is greater than zero.
4864
4865 @node Octa
4866 @section @code{.octa @var{bignums}}
4867
4868 @c FIXME: double size emitted for "octa" on i960, others? Or warn?
4869 @cindex @code{octa} directive
4870 @cindex integer, 16-byte
4871 @cindex sixteen byte integer
4872 This directive expects zero or more bignums, separated by commas. For each
4873 bignum, it emits a 16-byte integer.
4874
4875 The term ``octa'' comes from contexts in which a ``word'' is two bytes;
4876 hence @emph{octa}-word for 16 bytes.
4877
4878 @node Org
4879 @section @code{.org @var{new-lc} , @var{fill}}
4880
4881 @cindex @code{org} directive
4882 @cindex location counter, advancing
4883 @cindex advancing location counter
4884 @cindex current address, advancing
4885 Advance the location counter of the current section to
4886 @var{new-lc}. @var{new-lc} is either an absolute expression or an
4887 expression with the same section as the current subsection. That is,
4888 you can't use @code{.org} to cross sections: if @var{new-lc} has the
4889 wrong section, the @code{.org} directive is ignored. To be compatible
4890 with former assemblers, if the section of @var{new-lc} is absolute,
4891 @command{@value{AS}} issues a warning, then pretends the section of @var{new-lc}
4892 is the same as the current subsection.
4893
4894 @code{.org} may only increase the location counter, or leave it
4895 unchanged; you cannot use @code{.org} to move the location counter
4896 backwards.
4897
4898 @c double negative used below "not undefined" because this is a specific
4899 @c reference to "undefined" (as SEG_UNKNOWN is called in this manual)
4900 @c section. doc@cygnus.com 18feb91
4901 Because @command{@value{AS}} tries to assemble programs in one pass, @var{new-lc}
4902 may not be undefined. If you really detest this restriction we eagerly await
4903 a chance to share your improved assembler.
4904
4905 Beware that the origin is relative to the start of the section, not
4906 to the start of the subsection. This is compatible with other
4907 people's assemblers.
4908
4909 When the location counter (of the current subsection) is advanced, the
4910 intervening bytes are filled with @var{fill} which should be an
4911 absolute expression. If the comma and @var{fill} are omitted,
4912 @var{fill} defaults to zero.
4913
4914 @node P2align
4915 @section @code{.p2align[wl] @var{abs-expr}, @var{abs-expr}, @var{abs-expr}}
4916
4917 @cindex padding the location counter given a power of two
4918 @cindex @code{p2align} directive
4919 Pad the location counter (in the current subsection) to a particular
4920 storage boundary. The first expression (which must be absolute) is the
4921 number of low-order zero bits the location counter must have after
4922 advancement. For example @samp{.p2align 3} advances the location
4923 counter until it a multiple of 8. If the location counter is already a
4924 multiple of 8, no change is needed.
4925
4926 The second expression (also absolute) gives the fill value to be stored in the
4927 padding bytes. It (and the comma) may be omitted. If it is omitted, the
4928 padding bytes are normally zero. However, on some systems, if the section is
4929 marked as containing code and the fill value is omitted, the space is filled
4930 with no-op instructions.
4931
4932 The third expression is also absolute, and is also optional. If it is present,
4933 it is the maximum number of bytes that should be skipped by this alignment
4934 directive. If doing the alignment would require skipping more bytes than the
4935 specified maximum, then the alignment is not done at all. You can omit the
4936 fill value (the second argument) entirely by simply using two commas after the
4937 required alignment; this can be useful if you want the alignment to be filled
4938 with no-op instructions when appropriate.
4939
4940 @cindex @code{p2alignw} directive
4941 @cindex @code{p2alignl} directive
4942 The @code{.p2alignw} and @code{.p2alignl} directives are variants of the
4943 @code{.p2align} directive. The @code{.p2alignw} directive treats the fill
4944 pattern as a two byte word value. The @code{.p2alignl} directives treats the
4945 fill pattern as a four byte longword value. For example, @code{.p2alignw
4946 2,0x368d} will align to a multiple of 4. If it skips two bytes, they will be
4947 filled in with the value 0x368d (the exact placement of the bytes depends upon
4948 the endianness of the processor). If it skips 1 or 3 bytes, the fill value is
4949 undefined.
4950
4951 @ifset ELF
4952 @node Previous
4953 @section @code{.previous}
4954
4955 @cindex @code{previous} directive
4956 @cindex Section Stack
4957 This is one of the ELF section stack manipulation directives. The others are
4958 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
4959 @code{.pushsection} (@pxref{PushSection}), and @code{.popsection}
4960 (@pxref{PopSection}).
4961
4962 This directive swaps the current section (and subsection) with most recently
4963 referenced section (and subsection) prior to this one. Multiple
4964 @code{.previous} directives in a row will flip between two sections (and their
4965 subsections).
4966
4967 In terms of the section stack, this directive swaps the current section with
4968 the top section on the section stack.
4969 @end ifset
4970
4971 @ifset ELF
4972 @node PopSection
4973 @section @code{.popsection}
4974
4975 @cindex @code{popsection} directive
4976 @cindex Section Stack
4977 This is one of the ELF section stack manipulation directives. The others are
4978 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
4979 @code{.pushsection} (@pxref{PushSection}), and @code{.previous}
4980 (@pxref{Previous}).
4981
4982 This directive replaces the current section (and subsection) with the top
4983 section (and subsection) on the section stack. This section is popped off the
4984 stack.
4985 @end ifset
4986
4987 @node Print
4988 @section @code{.print @var{string}}
4989
4990 @cindex @code{print} directive
4991 @command{@value{AS}} will print @var{string} on the standard output during
4992 assembly. You must put @var{string} in double quotes.
4993
4994 @ifset ELF
4995 @node Protected
4996 @section @code{.protected @var{names}}
4997
4998 @cindex @code{protected} directive
4999 @cindex visibility
5000 This one of the ELF visibility directives. The other two are
5001 @code{.hidden} (@pxref{Hidden}) and @code{.internal} (@pxref{Internal}).
5002
5003 This directive overrides the named symbols default visibility (which is set by
5004 their binding: local, global or weak). The directive sets the visibility to
5005 @code{protected} which means that any references to the symbols from within the
5006 components that defines them must be resolved to the definition in that
5007 component, even if a definition in another component would normally preempt
5008 this.
5009 @end ifset
5010
5011 @node Psize
5012 @section @code{.psize @var{lines} , @var{columns}}
5013
5014 @cindex @code{psize} directive
5015 @cindex listing control: paper size
5016 @cindex paper size, for listings
5017 Use this directive to declare the number of lines---and, optionally, the
5018 number of columns---to use for each page, when generating listings.
5019
5020 If you do not use @code{.psize}, listings use a default line-count
5021 of 60. You may omit the comma and @var{columns} specification; the
5022 default width is 200 columns.
5023
5024 @command{@value{AS}} generates formfeeds whenever the specified number of
5025 lines is exceeded (or whenever you explicitly request one, using
5026 @code{.eject}).
5027
5028 If you specify @var{lines} as @code{0}, no formfeeds are generated save
5029 those explicitly specified with @code{.eject}.
5030
5031 @node Purgem
5032 @section @code{.purgem @var{name}}
5033
5034 @cindex @code{purgem} directive
5035 Undefine the macro @var{name}, so that later uses of the string will not be
5036 expanded. @xref{Macro}.
5037
5038 @ifset ELF
5039 @node PushSection
5040 @section @code{.pushsection @var{name} , @var{subsection}}
5041
5042 @cindex @code{pushsection} directive
5043 @cindex Section Stack
5044 This is one of the ELF section stack manipulation directives. The others are
5045 @code{.section} (@pxref{Section}), @code{.subsection} (@pxref{SubSection}),
5046 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
5047 (@pxref{Previous}).
5048
5049 This directive is a synonym for @code{.section}. It pushes the current section
5050 (and subsection) onto the top of the section stack, and then replaces the
5051 current section and subsection with @code{name} and @code{subsection}.
5052 @end ifset
5053
5054 @node Quad
5055 @section @code{.quad @var{bignums}}
5056
5057 @cindex @code{quad} directive
5058 @code{.quad} expects zero or more bignums, separated by commas. For
5059 each bignum, it emits
5060 @ifclear bignum-16
5061 an 8-byte integer. If the bignum won't fit in 8 bytes, it prints a
5062 warning message; and just takes the lowest order 8 bytes of the bignum.
5063 @cindex eight-byte integer
5064 @cindex integer, 8-byte
5065
5066 The term ``quad'' comes from contexts in which a ``word'' is two bytes;
5067 hence @emph{quad}-word for 8 bytes.
5068 @end ifclear
5069 @ifset bignum-16
5070 a 16-byte integer. If the bignum won't fit in 16 bytes, it prints a
5071 warning message; and just takes the lowest order 16 bytes of the bignum.
5072 @cindex sixteen-byte integer
5073 @cindex integer, 16-byte
5074 @end ifset
5075
5076 @node Rept
5077 @section @code{.rept @var{count}}
5078
5079 @cindex @code{rept} directive
5080 Repeat the sequence of lines between the @code{.rept} directive and the next
5081 @code{.endr} directive @var{count} times.
5082
5083 For example, assembling
5084
5085 @example
5086 .rept 3
5087 .long 0
5088 .endr
5089 @end example
5090
5091 is equivalent to assembling
5092
5093 @example
5094 .long 0
5095 .long 0
5096 .long 0
5097 @end example
5098
5099 @node Sbttl
5100 @section @code{.sbttl "@var{subheading}"}
5101
5102 @cindex @code{sbttl} directive
5103 @cindex subtitles for listings
5104 @cindex listing control: subtitle
5105 Use @var{subheading} as the title (third line, immediately after the
5106 title line) when generating assembly listings.
5107
5108 This directive affects subsequent pages, as well as the current page if
5109 it appears within ten lines of the top of a page.
5110
5111 @ifset COFF
5112 @node Scl
5113 @section @code{.scl @var{class}}
5114
5115 @cindex @code{scl} directive
5116 @cindex symbol storage class (COFF)
5117 @cindex COFF symbol storage class
5118 Set the storage-class value for a symbol. This directive may only be
5119 used inside a @code{.def}/@code{.endef} pair. Storage class may flag
5120 whether a symbol is static or external, or it may record further
5121 symbolic debugging information.
5122 @ifset BOUT
5123
5124 The @samp{.scl} directive is primarily associated with COFF output; when
5125 configured to generate @code{b.out} output format, @command{@value{AS}}
5126 accepts this directive but ignores it.
5127 @end ifset
5128 @end ifset
5129
5130 @ifset COFF-ELF
5131 @node Section
5132 @section @code{.section @var{name}}
5133
5134 @cindex named section
5135 Use the @code{.section} directive to assemble the following code into a section
5136 named @var{name}.
5137
5138 This directive is only supported for targets that actually support arbitrarily
5139 named sections; on @code{a.out} targets, for example, it is not accepted, even
5140 with a standard @code{a.out} section name.
5141
5142 @ifset COFF
5143 @ifset ELF
5144 @c only print the extra heading if both COFF and ELF are set
5145 @subheading COFF Version
5146 @end ifset
5147
5148 @cindex @code{section} directive (COFF version)
5149 For COFF targets, the @code{.section} directive is used in one of the following
5150 ways:
5151
5152 @smallexample
5153 .section @var{name}[, "@var{flags}"]
5154 .section @var{name}[, @var{subsegment}]
5155 @end smallexample
5156
5157 If the optional argument is quoted, it is taken as flags to use for the
5158 section. Each flag is a single character. The following flags are recognized:
5159 @table @code
5160 @item b
5161 bss section (uninitialized data)
5162 @item n
5163 section is not loaded
5164 @item w
5165 writable section
5166 @item d
5167 data section
5168 @item r
5169 read-only section
5170 @item x
5171 executable section
5172 @item s
5173 shared section (meaningful for PE targets)
5174 @item a
5175 ignored. (For compatibility with the ELF version)
5176 @end table
5177
5178 If no flags are specified, the default flags depend upon the section name. If
5179 the section name is not recognized, the default will be for the section to be
5180 loaded and writable. Note the @code{n} and @code{w} flags remove attributes
5181 from the section, rather than adding them, so if they are used on their own it
5182 will be as if no flags had been specified at all.
5183
5184 If the optional argument to the @code{.section} directive is not quoted, it is
5185 taken as a subsegment number (@pxref{Sub-Sections}).
5186 @end ifset
5187
5188 @ifset ELF
5189 @ifset COFF
5190 @c only print the extra heading if both COFF and ELF are set
5191 @subheading ELF Version
5192 @end ifset
5193
5194 @cindex Section Stack
5195 This is one of the ELF section stack manipulation directives. The others are
5196 @code{.subsection} (@pxref{SubSection}), @code{.pushsection}
5197 (@pxref{PushSection}), @code{.popsection} (@pxref{PopSection}), and
5198 @code{.previous} (@pxref{Previous}).
5199
5200 @cindex @code{section} directive (ELF version)
5201 For ELF targets, the @code{.section} directive is used like this:
5202
5203 @smallexample
5204 .section @var{name} [, "@var{flags}"[, @@@var{type}[, @@@var{entsize}]]]
5205 @end smallexample
5206
5207 The optional @var{flags} argument is a quoted string which may contain any
5208 combination of the following characters:
5209 @table @code
5210 @item a
5211 section is allocatable
5212 @item w
5213 section is writable
5214 @item x
5215 section is executable
5216 @item M
5217 section is mergeable
5218 @item S
5219 section contains zero terminated strings
5220 @end table
5221
5222 The optional @var{type} argument may contain one of the following constants:
5223 @table @code
5224 @item @@progbits
5225 section contains data
5226 @item @@nobits
5227 section does not contain data (i.e., section only occupies space)
5228 @end table
5229
5230 Note on targets where the @code{@@} character is the start of a comment (eg
5231 ARM) then another character is used instead. For example the ARM port uses the
5232 @code{%} character.
5233
5234 If @var{flags} contains @code{M} flag, @var{type} argument must be specified
5235 as well as @var{entsize} argument. Sections with @code{M} flag but not
5236 @code{S} flag must contain fixed size constants, each @var{entsize} octets
5237 long. Sections with both @code{M} and @code{S} must contain zero terminated
5238 strings where each character is @var{entsize} bytes long. The linker may remove
5239 duplicates within sections with the same name, same entity size and same flags.
5240
5241 If no flags are specified, the default flags depend upon the section name. If
5242 the section name is not recognized, the default will be for the section to have
5243 none of the above flags: it will not be allocated in memory, nor writable, nor
5244 executable. The section will contain data.
5245
5246 For ELF targets, the assembler supports another type of @code{.section}
5247 directive for compatibility with the Solaris assembler:
5248
5249 @smallexample
5250 .section "@var{name}"[, @var{flags}...]
5251 @end smallexample
5252
5253 Note that the section name is quoted. There may be a sequence of comma
5254 separated flags:
5255 @table @code
5256 @item #alloc
5257 section is allocatable
5258 @item #write
5259 section is writable
5260 @item #execinstr
5261 section is executable
5262 @end table
5263
5264 This directive replaces the current section and subsection. The replaced
5265 section and subsection are pushed onto the section stack. See the contents of
5266 the gas testsuite directory @code{gas/testsuite/gas/elf} for some examples of
5267 how this directive and the other section stack directives work.
5268 @end ifset
5269 @end ifset
5270
5271 @node Set
5272 @section @code{.set @var{symbol}, @var{expression}}
5273
5274 @cindex @code{set} directive
5275 @cindex symbol value, setting
5276 Set the value of @var{symbol} to @var{expression}. This
5277 changes @var{symbol}'s value and type to conform to
5278 @var{expression}. If @var{symbol} was flagged as external, it remains
5279 flagged (@pxref{Symbol Attributes}).
5280
5281 You may @code{.set} a symbol many times in the same assembly.
5282
5283 If you @code{.set} a global symbol, the value stored in the object
5284 file is the last value stored into it.
5285
5286 @ifset HPPA
5287 The syntax for @code{set} on the HPPA is
5288 @samp{@var{symbol} .set @var{expression}}.
5289 @end ifset
5290
5291 @node Short
5292 @section @code{.short @var{expressions}}
5293
5294 @cindex @code{short} directive
5295 @ifset GENERIC
5296 @code{.short} is normally the same as @samp{.word}.
5297 @xref{Word,,@code{.word}}.
5298
5299 In some configurations, however, @code{.short} and @code{.word} generate
5300 numbers of different lengths; @pxref{Machine Dependencies}.
5301 @end ifset
5302 @ifclear GENERIC
5303 @ifset W16
5304 @code{.short} is the same as @samp{.word}. @xref{Word,,@code{.word}}.
5305 @end ifset
5306 @ifset W32
5307 This expects zero or more @var{expressions}, and emits
5308 a 16 bit number for each.
5309 @end ifset
5310 @end ifclear
5311
5312 @node Single
5313 @section @code{.single @var{flonums}}
5314
5315 @cindex @code{single} directive
5316 @cindex floating point numbers (single)
5317 This directive assembles zero or more flonums, separated by commas. It
5318 has the same effect as @code{.float}.
5319 @ifset GENERIC
5320 The exact kind of floating point numbers emitted depends on how
5321 @command{@value{AS}} is configured. @xref{Machine Dependencies}.
5322 @end ifset
5323 @ifclear GENERIC
5324 @ifset IEEEFLOAT
5325 On the @value{TARGET} family, @code{.single} emits 32-bit floating point
5326 numbers in @sc{ieee} format.
5327 @end ifset
5328 @end ifclear
5329
5330 @ifset COFF-ELF
5331 @node Size
5332 @section @code{.size}
5333
5334 This directive is used to set the size associated with a symbol.
5335
5336 @ifset COFF
5337 @ifset ELF
5338 @c only print the extra heading if both COFF and ELF are set
5339 @subheading COFF Version
5340 @end ifset
5341
5342 @cindex @code{size} directive (COFF version)
5343 For COFF targets, the @code{.size} directive is only permitted inside
5344 @code{.def}/@code{.endef} pairs. It is used like this:
5345
5346 @smallexample
5347 .size @var{expression}
5348 @end smallexample
5349
5350 @ifset BOUT
5351 @samp{.size} is only meaningful when generating COFF format output; when
5352 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
5353 ignores it.
5354 @end ifset
5355 @end ifset
5356
5357 @ifset ELF
5358 @ifset COFF
5359 @c only print the extra heading if both COFF and ELF are set
5360 @subheading ELF Version
5361 @end ifset
5362
5363 @cindex @code{size} directive (ELF version)
5364 For ELF targets, the @code{.size} directive is used like this:
5365
5366 @smallexample
5367 .size @var{name} , @var{expression}
5368 @end smallexample
5369
5370 This directive sets the size associated with a symbol @var{name}.
5371 The size in bytes is computed from @var{expression} which can make use of label
5372 arithmetic. This directive is typically used to set the size of function
5373 symbols.
5374 @end ifset
5375 @end ifset
5376
5377 @node Sleb128
5378 @section @code{.sleb128 @var{expressions}}
5379
5380 @cindex @code{sleb128} directive
5381 @var{sleb128} stands for ``signed little endian base 128.'' This is a
5382 compact, variable length representation of numbers used by the DWARF
5383 symbolic debugging format. @xref{Uleb128,@code{.uleb128}}.
5384
5385 @ifclear no-space-dir
5386 @node Skip
5387 @section @code{.skip @var{size} , @var{fill}}
5388
5389 @cindex @code{skip} directive
5390 @cindex filling memory
5391 This directive emits @var{size} bytes, each of value @var{fill}. Both
5392 @var{size} and @var{fill} are absolute expressions. If the comma and
5393 @var{fill} are omitted, @var{fill} is assumed to be zero. This is the same as
5394 @samp{.space}.
5395
5396 @node Space
5397 @section @code{.space @var{size} , @var{fill}}
5398
5399 @cindex @code{space} directive
5400 @cindex filling memory
5401 This directive emits @var{size} bytes, each of value @var{fill}. Both
5402 @var{size} and @var{fill} are absolute expressions. If the comma
5403 and @var{fill} are omitted, @var{fill} is assumed to be zero. This is the same
5404 as @samp{.skip}.
5405
5406 @ifset HPPA
5407 @quotation
5408 @emph{Warning:} @code{.space} has a completely different meaning for HPPA
5409 targets; use @code{.block} as a substitute. See @cite{HP9000 Series 800
5410 Assembly Language Reference Manual} (HP 92432-90001) for the meaning of the
5411 @code{.space} directive. @xref{HPPA Directives,,HPPA Assembler Directives},
5412 for a summary.
5413 @end quotation
5414 @end ifset
5415 @end ifclear
5416
5417 @ifset A29K
5418 @ifclear GENERIC
5419 @node Space
5420 @section @code{.space}
5421 @cindex @code{space} directive
5422 @end ifclear
5423 On the AMD 29K, this directive is ignored; it is accepted for
5424 compatibility with other AMD 29K assemblers.
5425
5426 @quotation
5427 @emph{Warning:} In most versions of the @sc{gnu} assembler, the directive
5428 @code{.space} has the effect of @code{.block} @xref{Machine Dependencies}.
5429 @end quotation
5430 @end ifset
5431
5432 @ifset have-stabs
5433 @node Stab
5434 @section @code{.stabd, .stabn, .stabs}
5435
5436 @cindex symbolic debuggers, information for
5437 @cindex @code{stab@var{x}} directives
5438 There are three directives that begin @samp{.stab}.
5439 All emit symbols (@pxref{Symbols}), for use by symbolic debuggers.
5440 The symbols are not entered in the @command{@value{AS}} hash table: they
5441 cannot be referenced elsewhere in the source file.
5442 Up to five fields are required:
5443
5444 @table @var
5445 @item string
5446 This is the symbol's name. It may contain any character except
5447 @samp{\000}, so is more general than ordinary symbol names. Some
5448 debuggers used to code arbitrarily complex structures into symbol names
5449 using this field.
5450
5451 @item type
5452 An absolute expression. The symbol's type is set to the low 8 bits of
5453 this expression. Any bit pattern is permitted, but @code{@value{LD}}
5454 and debuggers choke on silly bit patterns.
5455
5456 @item other
5457 An absolute expression. The symbol's ``other'' attribute is set to the
5458 low 8 bits of this expression.
5459
5460 @item desc
5461 An absolute expression. The symbol's descriptor is set to the low 16
5462 bits of this expression.
5463
5464 @item value
5465 An absolute expression which becomes the symbol's value.
5466 @end table
5467
5468 If a warning is detected while reading a @code{.stabd}, @code{.stabn},
5469 or @code{.stabs} statement, the symbol has probably already been created;
5470 you get a half-formed symbol in your object file. This is
5471 compatible with earlier assemblers!
5472
5473 @table @code
5474 @cindex @code{stabd} directive
5475 @item .stabd @var{type} , @var{other} , @var{desc}
5476
5477 The ``name'' of the symbol generated is not even an empty string.
5478 It is a null pointer, for compatibility. Older assemblers used a
5479 null pointer so they didn't waste space in object files with empty
5480 strings.
5481
5482 The symbol's value is set to the location counter,
5483 relocatably. When your program is linked, the value of this symbol
5484 is the address of the location counter when the @code{.stabd} was
5485 assembled.
5486
5487 @cindex @code{stabn} directive
5488 @item .stabn @var{type} , @var{other} , @var{desc} , @var{value}
5489 The name of the symbol is set to the empty string @code{""}.
5490
5491 @cindex @code{stabs} directive
5492 @item .stabs @var{string} , @var{type} , @var{other} , @var{desc} , @var{value}
5493 All five fields are specified.
5494 @end table
5495 @end ifset
5496 @c end have-stabs
5497
5498 @node String
5499 @section @code{.string} "@var{str}"
5500
5501 @cindex string, copying to object file
5502 @cindex @code{string} directive
5503
5504 Copy the characters in @var{str} to the object file. You may specify more than
5505 one string to copy, separated by commas. Unless otherwise specified for a
5506 particular machine, the assembler marks the end of each string with a 0 byte.
5507 You can use any of the escape sequences described in @ref{Strings,,Strings}.
5508
5509 @node Struct
5510 @section @code{.struct @var{expression}}
5511
5512 @cindex @code{struct} directive
5513 Switch to the absolute section, and set the section offset to @var{expression},
5514 which must be an absolute expression. You might use this as follows:
5515 @smallexample
5516 .struct 0
5517 field1:
5518 .struct field1 + 4
5519 field2:
5520 .struct field2 + 4
5521 field3:
5522 @end smallexample
5523 This would define the symbol @code{field1} to have the value 0, the symbol
5524 @code{field2} to have the value 4, and the symbol @code{field3} to have the
5525 value 8. Assembly would be left in the absolute section, and you would need to
5526 use a @code{.section} directive of some sort to change to some other section
5527 before further assembly.
5528
5529 @ifset ELF
5530 @node SubSection
5531 @section @code{.subsection @var{name}}
5532
5533 @cindex @code{subsection} directive
5534 @cindex Section Stack
5535 This is one of the ELF section stack manipulation directives. The others are
5536 @code{.section} (@pxref{Section}), @code{.pushsection} (@pxref{PushSection}),
5537 @code{.popsection} (@pxref{PopSection}), and @code{.previous}
5538 (@pxref{Previous}).
5539
5540 This directive replaces the current subsection with @code{name}. The current
5541 section is not changed. The replaced subsection is put onto the section stack
5542 in place of the then current top of stack subsection.
5543 @end ifset
5544
5545 @ifset ELF
5546 @node Symver
5547 @section @code{.symver}
5548 @cindex @code{symver} directive
5549 @cindex symbol versioning
5550 @cindex versions of symbols
5551 Use the @code{.symver} directive to bind symbols to specific version nodes
5552 within a source file. This is only supported on ELF platforms, and is
5553 typically used when assembling files to be linked into a shared library.
5554 There are cases where it may make sense to use this in objects to be bound
5555 into an application itself so as to override a versioned symbol from a
5556 shared library.
5557
5558 For ELF targets, the @code{.symver} directive can be used like this:
5559 @smallexample
5560 .symver @var{name}, @var{name2@@nodename}
5561 @end smallexample
5562 If the symbol @var{name} is defined within the file
5563 being assembled, the @code{.symver} directive effectively creates a symbol
5564 alias with the name @var{name2@@nodename}, and in fact the main reason that we
5565 just don't try and create a regular alias is that the @var{@@} character isn't
5566 permitted in symbol names. The @var{name2} part of the name is the actual name
5567 of the symbol by which it will be externally referenced. The name @var{name}
5568 itself is merely a name of convenience that is used so that it is possible to
5569 have definitions for multiple versions of a function within a single source
5570 file, and so that the compiler can unambiguously know which version of a
5571 function is being mentioned. The @var{nodename} portion of the alias should be
5572 the name of a node specified in the version script supplied to the linker when
5573 building a shared library. If you are attempting to override a versioned
5574 symbol from a shared library, then @var{nodename} should correspond to the
5575 nodename of the symbol you are trying to override.
5576
5577 If the symbol @var{name} is not defined within the file being assembled, all
5578 references to @var{name} will be changed to @var{name2@@nodename}. If no
5579 reference to @var{name} is made, @var{name2@@nodename} will be removed from the
5580 symbol table.
5581
5582 Another usage of the @code{.symver} directive is:
5583 @smallexample
5584 .symver @var{name}, @var{name2@@@@nodename}
5585 @end smallexample
5586 In this case, the symbol @var{name} must exist and be defined within
5587 the file being assembled. It is similar to @var{name2@@nodename}. The
5588 difference is @var{name2@@@@nodename} will also be used to resolve
5589 references to @var{name2} by the linker.
5590
5591 The third usage of the @code{.symver} directive is:
5592 @smallexample
5593 .symver @var{name}, @var{name2@@@@@@nodename}
5594 @end smallexample
5595 When @var{name} is not defined within the
5596 file being assembled, it is treated as @var{name2@@nodename}. When
5597 @var{name} is defined within the file being assembled, the symbol
5598 name, @var{name}, will be changed to @var{name2@@@@nodename}.
5599 @end ifset
5600
5601 @ifset COFF
5602 @node Tag
5603 @section @code{.tag @var{structname}}
5604
5605 @cindex COFF structure debugging
5606 @cindex structure debugging, COFF
5607 @cindex @code{tag} directive
5608 This directive is generated by compilers to include auxiliary debugging
5609 information in the symbol table. It is only permitted inside
5610 @code{.def}/@code{.endef} pairs. Tags are used to link structure
5611 definitions in the symbol table with instances of those structures.
5612 @ifset BOUT
5613
5614 @samp{.tag} is only used when generating COFF format output; when
5615 @command{@value{AS}} is generating @code{b.out}, it accepts this directive but
5616 ignores it.
5617 @end ifset
5618 @end ifset
5619
5620 @node Text
5621 @section @code{.text @var{subsection}}
5622
5623 @cindex @code{text} directive
5624 Tells @command{@value{AS}} to assemble the following statements onto the end of
5625 the text subsection numbered @var{subsection}, which is an absolute
5626 expression. If @var{subsection} is omitted, subsection number zero
5627 is used.
5628
5629 @node Title
5630 @section @code{.title "@var{heading}"}
5631
5632 @cindex @code{title} directive
5633 @cindex listing control: title line
5634 Use @var{heading} as the title (second line, immediately after the
5635 source file name and pagenumber) when generating assembly listings.
5636
5637 This directive affects subsequent pages, as well as the current page if
5638 it appears within ten lines of the top of a page.
5639
5640 @ifset COFF-ELF
5641 @node Type
5642 @section @code{.type}
5643
5644 This directive is used to set the type of a symbol.
5645
5646 @ifset COFF
5647 @ifset ELF
5648 @c only print the extra heading if both COFF and ELF are set
5649 @subheading COFF Version
5650 @end ifset
5651
5652 @cindex COFF symbol type
5653 @cindex symbol type, COFF
5654 @cindex @code{type} directive (COFF version)
5655 For COFF targets, this directive is permitted only within
5656 @code{.def}/@code{.endef} pairs. It is used like this:
5657
5658 @smallexample
5659 .type @var{int}
5660 @end smallexample
5661
5662 This records the integer @var{int} as the type attribute of a symbol table
5663 entry.
5664
5665 @ifset BOUT
5666 @samp{.type} is associated only with COFF format output; when
5667 @command{@value{AS}} is configured for @code{b.out} output, it accepts this
5668 directive but ignores it.
5669 @end ifset
5670 @end ifset
5671
5672 @ifset ELF
5673 @ifset COFF
5674 @c only print the extra heading if both COFF and ELF are set
5675 @subheading ELF Version
5676 @end ifset
5677
5678 @cindex ELF symbol type
5679 @cindex symbol type, ELF
5680 @cindex @code{type} directive (ELF version)
5681 For ELF targets, the @code{.type} directive is used like this:
5682
5683 @smallexample
5684 .type @var{name} , @var{type description}
5685 @end smallexample
5686
5687 This sets the type of symbol @var{name} to be either a
5688 function symbol or an object symbol. There are five different syntaxes
5689 supported for the @var{type description} field, in order to provide
5690 compatibility with various other assemblers. The syntaxes supported are:
5691
5692 @smallexample
5693 .type <name>,#function
5694 .type <name>,#object
5695
5696 .type <name>,@@function
5697 .type <name>,@@object
5698
5699 .type <name>,%function
5700 .type <name>,%object
5701
5702 .type <name>,"function"
5703 .type <name>,"object"
5704
5705 .type <name> STT_FUNCTION
5706 .type <name> STT_OBJECT
5707 @end smallexample
5708 @end ifset
5709 @end ifset
5710
5711 @node Uleb128
5712 @section @code{.uleb128 @var{expressions}}
5713
5714 @cindex @code{uleb128} directive
5715 @var{uleb128} stands for ``unsigned little endian base 128.'' This is a
5716 compact, variable length representation of numbers used by the DWARF
5717 symbolic debugging format. @xref{Sleb128,@code{.sleb128}}.
5718
5719 @ifset COFF
5720 @node Val
5721 @section @code{.val @var{addr}}
5722
5723 @cindex @code{val} directive
5724 @cindex COFF value attribute
5725 @cindex value attribute, COFF
5726 This directive, permitted only within @code{.def}/@code{.endef} pairs,
5727 records the address @var{addr} as the value attribute of a symbol table
5728 entry.
5729 @ifset BOUT
5730
5731 @samp{.val} is used only for COFF output; when @command{@value{AS}} is
5732 configured for @code{b.out}, it accepts this directive but ignores it.
5733 @end ifset
5734 @end ifset
5735
5736 @ifset ELF
5737 @node Version
5738 @section @code{.version "@var{string}"}
5739
5740 @cindex @code{version} directive
5741 This directive creates a @code{.note} section and places into it an ELF
5742 formatted note of type NT_VERSION. The note's name is set to @code{string}.
5743 @end ifset
5744
5745 @ifset ELF
5746 @node VTableEntry
5747 @section @code{.vtable_entry @var{table}, @var{offset}}
5748
5749 @cindex @code{vtable_entry}
5750 This directive finds or creates a symbol @code{table} and creates a
5751 @code{VTABLE_ENTRY} relocation for it with an addend of @code{offset}.
5752
5753 @node VTableInherit
5754 @section @code{.vtable_inherit @var{child}, @var{parent}}
5755
5756 @cindex @code{vtable_inherit}
5757 This directive finds the symbol @code{child} and finds or creates the symbol
5758 @code{parent} and then creates a @code{VTABLE_INHERIT} relocation for the
5759 parent whose addend is the value of the child symbol. As a special case the
5760 parent name of @code{0} is treated as refering the @code{*ABS*} section.
5761 @end ifset
5762
5763 @ifset ELF
5764 @node Weak
5765 @section @code{.weak @var{names}}
5766
5767 @cindex @code{weak} directive
5768 This directive sets the weak attribute on the comma separated list of symbol
5769 @code{names}. If the symbols do not already exist, they will be created.
5770 @end ifset
5771
5772 @node Word
5773 @section @code{.word @var{expressions}}
5774
5775 @cindex @code{word} directive
5776 This directive expects zero or more @var{expressions}, of any section,
5777 separated by commas.
5778 @ifclear GENERIC
5779 @ifset W32
5780 For each expression, @command{@value{AS}} emits a 32-bit number.
5781 @end ifset
5782 @ifset W16
5783 For each expression, @command{@value{AS}} emits a 16-bit number.
5784 @end ifset
5785 @end ifclear
5786 @ifset GENERIC
5787
5788 The size of the number emitted, and its byte order,
5789 depend on what target computer the assembly is for.
5790 @end ifset
5791
5792 @c on amd29k, i960, sparc the "special treatment to support compilers" doesn't
5793 @c happen---32-bit addressability, period; no long/short jumps.
5794 @ifset DIFF-TBL-KLUGE
5795 @cindex difference tables altered
5796 @cindex altered difference tables
5797 @quotation
5798 @emph{Warning: Special Treatment to support Compilers}
5799 @end quotation
5800
5801 @ifset GENERIC
5802 Machines with a 32-bit address space, but that do less than 32-bit
5803 addressing, require the following special treatment. If the machine of
5804 interest to you does 32-bit addressing (or doesn't require it;
5805 @pxref{Machine Dependencies}), you can ignore this issue.
5806
5807 @end ifset
5808 In order to assemble compiler output into something that works,
5809 @command{@value{AS}} occasionally does strange things to @samp{.word} directives.
5810 Directives of the form @samp{.word sym1-sym2} are often emitted by
5811 compilers as part of jump tables. Therefore, when @command{@value{AS}} assembles a
5812 directive of the form @samp{.word sym1-sym2}, and the difference between
5813 @code{sym1} and @code{sym2} does not fit in 16 bits, @command{@value{AS}}
5814 creates a @dfn{secondary jump table}, immediately before the next label.
5815 This secondary jump table is preceded by a short-jump to the
5816 first byte after the secondary table. This short-jump prevents the flow
5817 of control from accidentally falling into the new table. Inside the
5818 table is a long-jump to @code{sym2}. The original @samp{.word}
5819 contains @code{sym1} minus the address of the long-jump to
5820 @code{sym2}.
5821
5822 If there were several occurrences of @samp{.word sym1-sym2} before the
5823 secondary jump table, all of them are adjusted. If there was a
5824 @samp{.word sym3-sym4}, that also did not fit in sixteen bits, a
5825 long-jump to @code{sym4} is included in the secondary jump table,
5826 and the @code{.word} directives are adjusted to contain @code{sym3}
5827 minus the address of the long-jump to @code{sym4}; and so on, for as many
5828 entries in the original jump table as necessary.
5829
5830 @ifset INTERNALS
5831 @emph{This feature may be disabled by compiling @command{@value{AS}} with the
5832 @samp{-DWORKING_DOT_WORD} option.} This feature is likely to confuse
5833 assembly language programmers.
5834 @end ifset
5835 @end ifset
5836 @c end DIFF-TBL-KLUGE
5837
5838 @node Deprecated
5839 @section Deprecated Directives
5840
5841 @cindex deprecated directives
5842 @cindex obsolescent directives
5843 One day these directives won't work.
5844 They are included for compatibility with older assemblers.
5845 @table @t
5846 @item .abort
5847 @item .line
5848 @end table
5849
5850 @ifset GENERIC
5851 @node Machine Dependencies
5852 @chapter Machine Dependent Features
5853
5854 @cindex machine dependencies
5855 The machine instruction sets are (almost by definition) different on
5856 each machine where @command{@value{AS}} runs. Floating point representations
5857 vary as well, and @command{@value{AS}} often supports a few additional
5858 directives or command-line options for compatibility with other
5859 assemblers on a particular platform. Finally, some versions of
5860 @command{@value{AS}} support special pseudo-instructions for branch
5861 optimization.
5862
5863 This chapter discusses most of these differences, though it does not
5864 include details on any machine's instruction set. For details on that
5865 subject, see the hardware manufacturer's manual.
5866
5867 @menu
5868 @ifset A29K
5869 * AMD29K-Dependent:: AMD 29K Dependent Features
5870 @end ifset
5871 @ifset ALPHA
5872 * Alpha-Dependent:: Alpha Dependent Features
5873 @end ifset
5874 @ifset ARC
5875 * ARC-Dependent:: ARC Dependent Features
5876 @end ifset
5877 @ifset ARM
5878 * ARM-Dependent:: ARM Dependent Features
5879 @end ifset
5880 @ifset CRIS
5881 * CRIS-Dependent:: CRIS Dependent Features
5882 @end ifset
5883 @ifset D10V
5884 * D10V-Dependent:: D10V Dependent Features
5885 @end ifset
5886 @ifset D30V
5887 * D30V-Dependent:: D30V Dependent Features
5888 @end ifset
5889 @ifset H8/300
5890 * H8/300-Dependent:: Renesas H8/300 Dependent Features
5891 @end ifset
5892 @ifset H8/500
5893 * H8/500-Dependent:: Renesas H8/500 Dependent Features
5894 @end ifset
5895 @ifset HPPA
5896 * HPPA-Dependent:: HPPA Dependent Features
5897 @end ifset
5898 @ifset I370
5899 * ESA/390-Dependent:: IBM ESA/390 Dependent Features
5900 @end ifset
5901 @ifset I80386
5902 * i386-Dependent:: Intel 80386 and AMD x86-64 Dependent Features
5903 @end ifset
5904 @ifset I860
5905 * i860-Dependent:: Intel 80860 Dependent Features
5906 @end ifset
5907 @ifset I960
5908 * i960-Dependent:: Intel 80960 Dependent Features
5909 @end ifset
5910 @ifset IP2K
5911 * IP2K-Dependent:: IP2K Dependent Features
5912 @end ifset
5913 @ifset M32R
5914 * M32R-Dependent:: M32R Dependent Features
5915 @end ifset
5916 @ifset M680X0
5917 * M68K-Dependent:: M680x0 Dependent Features
5918 @end ifset
5919 @ifset M68HC11
5920 * M68HC11-Dependent:: M68HC11 and 68HC12 Dependent Features
5921 @end ifset
5922 @ifset M880X0
5923 * M88K-Dependent:: M880x0 Dependent Features
5924 @end ifset
5925 @ifset MIPS
5926 * MIPS-Dependent:: MIPS Dependent Features
5927 @end ifset
5928 @ifset MMIX
5929 * MMIX-Dependent:: MMIX Dependent Features
5930 @end ifset
5931 @ifset MSP430
5932 * MSP430-Dependent:: MSP430 Dependent Features
5933 @end ifset
5934 @ifset SH
5935 * SH-Dependent:: Renesas / SuperH SH Dependent Features
5936 * SH64-Dependent:: SuperH SH64 Dependent Features
5937 @end ifset
5938 @ifset PDP11
5939 * PDP-11-Dependent:: PDP-11 Dependent Features
5940 @end ifset
5941 @ifset PJ
5942 * PJ-Dependent:: picoJava Dependent Features
5943 @end ifset
5944 @ifset PPC
5945 * PPC-Dependent:: PowerPC Dependent Features
5946 @end ifset
5947 @ifset SPARC
5948 * Sparc-Dependent:: SPARC Dependent Features
5949 @end ifset
5950 @ifset TIC54X
5951 * TIC54X-Dependent:: TI TMS320C54x Dependent Features
5952 @end ifset
5953 @ifset V850
5954 * V850-Dependent:: V850 Dependent Features
5955 @end ifset
5956 @ifset XTENSA
5957 * Xtensa-Dependent:: Xtensa Dependent Features
5958 @end ifset
5959 @ifset Z8000
5960 * Z8000-Dependent:: Z8000 Dependent Features
5961 @end ifset
5962 @ifset VAX
5963 * Vax-Dependent:: VAX Dependent Features
5964 @end ifset
5965 @end menu
5966
5967 @lowersections
5968 @end ifset
5969
5970 @c The following major nodes are *sections* in the GENERIC version, *chapters*
5971 @c in single-cpu versions. This is mainly achieved by @lowersections. There is a
5972 @c peculiarity: to preserve cross-references, there must be a node called
5973 @c "Machine Dependencies". Hence the conditional nodenames in each
5974 @c major node below. Node defaulting in makeinfo requires adjacency of
5975 @c node and sectioning commands; hence the repetition of @chapter BLAH
5976 @c in both conditional blocks.
5977
5978 @ifset A29K
5979 @include c-a29k.texi
5980 @end ifset
5981
5982 @ifset ALPHA
5983 @include c-alpha.texi
5984 @end ifset
5985
5986 @ifset ARC
5987 @include c-arc.texi
5988 @end ifset
5989
5990 @ifset ARM
5991 @include c-arm.texi
5992 @end ifset
5993
5994 @ifset CRIS
5995 @include c-cris.texi
5996 @end ifset
5997
5998 @ifset Renesas-all
5999 @ifclear GENERIC
6000 @node Machine Dependencies
6001 @chapter Machine Dependent Features
6002
6003 The machine instruction sets are different on each Renesas chip family,
6004 and there are also some syntax differences among the families. This
6005 chapter describes the specific @command{@value{AS}} features for each
6006 family.
6007
6008 @menu
6009 * H8/300-Dependent:: Renesas H8/300 Dependent Features
6010 * H8/500-Dependent:: Renesas H8/500 Dependent Features
6011 * SH-Dependent:: Renesas SH Dependent Features
6012 @end menu
6013 @lowersections
6014 @end ifclear
6015 @end ifset
6016
6017 @ifset D10V
6018 @include c-d10v.texi
6019 @end ifset
6020
6021 @ifset D30V
6022 @include c-d30v.texi
6023 @end ifset
6024
6025 @ifset H8/300
6026 @include c-h8300.texi
6027 @end ifset
6028
6029 @ifset H8/500
6030 @include c-h8500.texi
6031 @end ifset
6032
6033 @ifset HPPA
6034 @include c-hppa.texi
6035 @end ifset
6036
6037 @ifset I370
6038 @include c-i370.texi
6039 @end ifset
6040
6041 @ifset I80386
6042 @include c-i386.texi
6043 @end ifset
6044
6045 @ifset I860
6046 @include c-i860.texi
6047 @end ifset
6048
6049 @ifset I960
6050 @include c-i960.texi
6051 @end ifset
6052
6053 @ifset IA64
6054 @include c-ia64.texi
6055 @end ifset
6056
6057 @ifset IP2K
6058 @include c-ip2k.texi
6059 @end ifset
6060
6061 @ifset M32R
6062 @include c-m32r.texi
6063 @end ifset
6064
6065 @ifset M680X0
6066 @include c-m68k.texi
6067 @end ifset
6068
6069 @ifset M68HC11
6070 @include c-m68hc11.texi
6071 @end ifset
6072
6073 @ifset M880X0
6074 @include c-m88k.texi
6075 @end ifset
6076
6077 @ifset MIPS
6078 @include c-mips.texi
6079 @end ifset
6080
6081 @ifset MMIX
6082 @include c-mmix.texi
6083 @end ifset
6084
6085 @ifset MSP430
6086 @include c-msp430.texi
6087 @end ifset
6088
6089 @ifset NS32K
6090 @include c-ns32k.texi
6091 @end ifset
6092
6093 @ifset PDP11
6094 @include c-pdp11.texi
6095 @end ifset
6096
6097 @ifset PJ
6098 @include c-pj.texi
6099 @end ifset
6100
6101 @ifset PPC
6102 @include c-ppc.texi
6103 @end ifset
6104
6105 @ifset SH
6106 @include c-sh.texi
6107 @include c-sh64.texi
6108 @end ifset
6109
6110 @ifset SPARC
6111 @include c-sparc.texi
6112 @end ifset
6113
6114 @ifset TIC54X
6115 @include c-tic54x.texi
6116 @end ifset
6117
6118 @ifset Z8000
6119 @include c-z8k.texi
6120 @end ifset
6121
6122 @ifset VAX
6123 @include c-vax.texi
6124 @end ifset
6125
6126 @ifset V850
6127 @include c-v850.texi
6128 @end ifset
6129
6130 @ifset XTENSA
6131 @include c-xtensa.texi
6132 @end ifset
6133
6134 @ifset GENERIC
6135 @c reverse effect of @down at top of generic Machine-Dep chapter
6136 @raisesections
6137 @end ifset
6138
6139 @node Reporting Bugs
6140 @chapter Reporting Bugs
6141 @cindex bugs in assembler
6142 @cindex reporting bugs in assembler
6143
6144 Your bug reports play an essential role in making @command{@value{AS}} reliable.
6145
6146 Reporting a bug may help you by bringing a solution to your problem, or it may
6147 not. But in any case the principal function of a bug report is to help the
6148 entire community by making the next version of @command{@value{AS}} work better.
6149 Bug reports are your contribution to the maintenance of @command{@value{AS}}.
6150
6151 In order for a bug report to serve its purpose, you must include the
6152 information that enables us to fix the bug.
6153
6154 @menu
6155 * Bug Criteria:: Have you found a bug?
6156 * Bug Reporting:: How to report bugs
6157 @end menu
6158
6159 @node Bug Criteria
6160 @section Have You Found a Bug?
6161 @cindex bug criteria
6162
6163 If you are not sure whether you have found a bug, here are some guidelines:
6164
6165 @itemize @bullet
6166 @cindex fatal signal
6167 @cindex assembler crash
6168 @cindex crash of assembler
6169 @item
6170 If the assembler gets a fatal signal, for any input whatever, that is a
6171 @command{@value{AS}} bug. Reliable assemblers never crash.
6172
6173 @cindex error on valid input
6174 @item
6175 If @command{@value{AS}} produces an error message for valid input, that is a bug.
6176
6177 @cindex invalid input
6178 @item
6179 If @command{@value{AS}} does not produce an error message for invalid input, that
6180 is a bug. However, you should note that your idea of ``invalid input'' might
6181 be our idea of ``an extension'' or ``support for traditional practice''.
6182
6183 @item
6184 If you are an experienced user of assemblers, your suggestions for improvement
6185 of @command{@value{AS}} are welcome in any case.
6186 @end itemize
6187
6188 @node Bug Reporting
6189 @section How to Report Bugs
6190 @cindex bug reports
6191 @cindex assembler bugs, reporting
6192
6193 A number of companies and individuals offer support for @sc{gnu} products. If
6194 you obtained @command{@value{AS}} from a support organization, we recommend you
6195 contact that organization first.
6196
6197 You can find contact information for many support companies and
6198 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
6199 distribution.
6200
6201 In any event, we also recommend that you send bug reports for @command{@value{AS}}
6202 to @samp{bug-binutils@@gnu.org}.
6203
6204 The fundamental principle of reporting bugs usefully is this:
6205 @strong{report all the facts}. If you are not sure whether to state a
6206 fact or leave it out, state it!
6207
6208 Often people omit facts because they think they know what causes the problem
6209 and assume that some details do not matter. Thus, you might assume that the
6210 name of a symbol you use in an example does not matter. Well, probably it does
6211 not, but one cannot be sure. Perhaps the bug is a stray memory reference which
6212 happens to fetch from the location where that name is stored in memory;
6213 perhaps, if the name were different, the contents of that location would fool
6214 the assembler into doing the right thing despite the bug. Play it safe and
6215 give a specific, complete example. That is the easiest thing for you to do,
6216 and the most helpful.
6217
6218 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
6219 it is new to us. Therefore, always write your bug reports on the assumption
6220 that the bug has not been reported previously.
6221
6222 Sometimes people give a few sketchy facts and ask, ``Does this ring a
6223 bell?'' This cannot help us fix a bug, so it is basically useless. We
6224 respond by asking for enough details to enable us to investigate.
6225 You might as well expedite matters by sending them to begin with.
6226
6227 To enable us to fix the bug, you should include all these things:
6228
6229 @itemize @bullet
6230 @item
6231 The version of @command{@value{AS}}. @command{@value{AS}} announces it if you start
6232 it with the @samp{--version} argument.
6233
6234 Without this, we will not know whether there is any point in looking for
6235 the bug in the current version of @command{@value{AS}}.
6236
6237 @item
6238 Any patches you may have applied to the @command{@value{AS}} source.
6239
6240 @item
6241 The type of machine you are using, and the operating system name and
6242 version number.
6243
6244 @item
6245 What compiler (and its version) was used to compile @command{@value{AS}}---e.g.
6246 ``@code{gcc-2.7}''.
6247
6248 @item
6249 The command arguments you gave the assembler to assemble your example and
6250 observe the bug. To guarantee you will not omit something important, list them
6251 all. A copy of the Makefile (or the output from make) is sufficient.
6252
6253 If we were to try to guess the arguments, we would probably guess wrong
6254 and then we might not encounter the bug.
6255
6256 @item
6257 A complete input file that will reproduce the bug. If the bug is observed when
6258 the assembler is invoked via a compiler, send the assembler source, not the
6259 high level language source. Most compilers will produce the assembler source
6260 when run with the @samp{-S} option. If you are using @code{@value{GCC}}, use
6261 the options @samp{-v --save-temps}; this will save the assembler source in a
6262 file with an extension of @file{.s}, and also show you exactly how
6263 @command{@value{AS}} is being run.
6264
6265 @item
6266 A description of what behavior you observe that you believe is
6267 incorrect. For example, ``It gets a fatal signal.''
6268
6269 Of course, if the bug is that @command{@value{AS}} gets a fatal signal, then we
6270 will certainly notice it. But if the bug is incorrect output, we might not
6271 notice unless it is glaringly wrong. You might as well not give us a chance to
6272 make a mistake.
6273
6274 Even if the problem you experience is a fatal signal, you should still say so
6275 explicitly. Suppose something strange is going on, such as, your copy of
6276 @command{@value{AS}} is out of synch, or you have encountered a bug in the C
6277 library on your system. (This has happened!) Your copy might crash and ours
6278 would not. If you told us to expect a crash, then when ours fails to crash, we
6279 would know that the bug was not happening for us. If you had not told us to
6280 expect a crash, then we would not be able to draw any conclusion from our
6281 observations.
6282
6283 @item
6284 If you wish to suggest changes to the @command{@value{AS}} source, send us context
6285 diffs, as generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
6286 option. Always send diffs from the old file to the new file. If you even
6287 discuss something in the @command{@value{AS}} source, refer to it by context, not
6288 by line number.
6289
6290 The line numbers in our development sources will not match those in your
6291 sources. Your line numbers would convey no useful information to us.
6292 @end itemize
6293
6294 Here are some things that are not necessary:
6295
6296 @itemize @bullet
6297 @item
6298 A description of the envelope of the bug.
6299
6300 Often people who encounter a bug spend a lot of time investigating
6301 which changes to the input file will make the bug go away and which
6302 changes will not affect it.
6303
6304 This is often time consuming and not very useful, because the way we
6305 will find the bug is by running a single example under the debugger
6306 with breakpoints, not by pure deduction from a series of examples.
6307 We recommend that you save your time for something else.
6308
6309 Of course, if you can find a simpler example to report @emph{instead}
6310 of the original one, that is a convenience for us. Errors in the
6311 output will be easier to spot, running under the debugger will take
6312 less time, and so on.
6313
6314 However, simplification is not vital; if you do not want to do this,
6315 report the bug anyway and send us the entire test case you used.
6316
6317 @item
6318 A patch for the bug.
6319
6320 A patch for the bug does help us if it is a good one. But do not omit
6321 the necessary information, such as the test case, on the assumption that
6322 a patch is all we need. We might see problems with your patch and decide
6323 to fix the problem another way, or we might not understand it at all.
6324
6325 Sometimes with a program as complicated as @command{@value{AS}} it is very hard to
6326 construct an example that will make the program follow a certain path through
6327 the code. If you do not send us the example, we will not be able to construct
6328 one, so we will not be able to verify that the bug is fixed.
6329
6330 And if we cannot understand what bug you are trying to fix, or why your
6331 patch should be an improvement, we will not install it. A test case will
6332 help us to understand.
6333
6334 @item
6335 A guess about what the bug is or what it depends on.
6336
6337 Such guesses are usually wrong. Even we cannot guess right about such
6338 things without first using the debugger to find the facts.
6339 @end itemize
6340
6341 @node Acknowledgements
6342 @chapter Acknowledgements
6343
6344 If you have contributed to @command{@value{AS}} and your name isn't listed here,
6345 it is not meant as a slight. We just don't know about it. Send mail to the
6346 maintainer, and we'll correct the situation. Currently
6347 @c (January 1994),
6348 the maintainer is Ken Raeburn (email address @code{raeburn@@cygnus.com}).
6349
6350 Dean Elsner wrote the original @sc{gnu} assembler for the VAX.@footnote{Any
6351 more details?}
6352
6353 Jay Fenlason maintained GAS for a while, adding support for GDB-specific debug
6354 information and the 68k series machines, most of the preprocessing pass, and
6355 extensive changes in @file{messages.c}, @file{input-file.c}, @file{write.c}.
6356
6357 K. Richard Pixley maintained GAS for a while, adding various enhancements and
6358 many bug fixes, including merging support for several processors, breaking GAS
6359 up to handle multiple object file format back ends (including heavy rewrite,
6360 testing, an integration of the coff and b.out back ends), adding configuration
6361 including heavy testing and verification of cross assemblers and file splits
6362 and renaming, converted GAS to strictly ANSI C including full prototypes, added
6363 support for m680[34]0 and cpu32, did considerable work on i960 including a COFF
6364 port (including considerable amounts of reverse engineering), a SPARC opcode
6365 file rewrite, DECstation, rs6000, and hp300hpux host ports, updated ``know''
6366 assertions and made them work, much other reorganization, cleanup, and lint.
6367
6368 Ken Raeburn wrote the high-level BFD interface code to replace most of the code
6369 in format-specific I/O modules.
6370
6371 The original VMS support was contributed by David L. Kashtan. Eric Youngdale
6372 has done much work with it since.
6373
6374 The Intel 80386 machine description was written by Eliot Dresselhaus.
6375
6376 Minh Tran-Le at IntelliCorp contributed some AIX 386 support.
6377
6378 The Motorola 88k machine description was contributed by Devon Bowen of Buffalo
6379 University and Torbjorn Granlund of the Swedish Institute of Computer Science.
6380
6381 Keith Knowles at the Open Software Foundation wrote the original MIPS back end
6382 (@file{tc-mips.c}, @file{tc-mips.h}), and contributed Rose format support
6383 (which hasn't been merged in yet). Ralph Campbell worked with the MIPS code to
6384 support a.out format.
6385
6386 Support for the Zilog Z8k and Renesas H8/300 and H8/500 processors (tc-z8k,
6387 tc-h8300, tc-h8500), and IEEE 695 object file format (obj-ieee), was written by
6388 Steve Chamberlain of Cygnus Support. Steve also modified the COFF back end to
6389 use BFD for some low-level operations, for use with the H8/300 and AMD 29k
6390 targets.
6391
6392 John Gilmore built the AMD 29000 support, added @code{.include} support, and
6393 simplified the configuration of which versions accept which directives. He
6394 updated the 68k machine description so that Motorola's opcodes always produced
6395 fixed-size instructions (e.g., @code{jsr}), while synthetic instructions
6396 remained shrinkable (@code{jbsr}). John fixed many bugs, including true tested
6397 cross-compilation support, and one bug in relaxation that took a week and
6398 required the proverbial one-bit fix.
6399
6400 Ian Lance Taylor of Cygnus Support merged the Motorola and MIT syntax for the
6401 68k, completed support for some COFF targets (68k, i386 SVR3, and SCO Unix),
6402 added support for MIPS ECOFF and ELF targets, wrote the initial RS/6000 and
6403 PowerPC assembler, and made a few other minor patches.
6404
6405 Steve Chamberlain made @command{@value{AS}} able to generate listings.
6406
6407 Hewlett-Packard contributed support for the HP9000/300.
6408
6409 Jeff Law wrote GAS and BFD support for the native HPPA object format (SOM)
6410 along with a fairly extensive HPPA testsuite (for both SOM and ELF object
6411 formats). This work was supported by both the Center for Software Science at
6412 the University of Utah and Cygnus Support.
6413
6414 Support for ELF format files has been worked on by Mark Eichin of Cygnus
6415 Support (original, incomplete implementation for SPARC), Pete Hoogenboom and
6416 Jeff Law at the University of Utah (HPPA mainly), Michael Meissner of the Open
6417 Software Foundation (i386 mainly), and Ken Raeburn of Cygnus Support (sparc,
6418 and some initial 64-bit support).
6419
6420 Linas Vepstas added GAS support for the ESA/390 ``IBM 370'' architecture.
6421
6422 Richard Henderson rewrote the Alpha assembler. Klaus Kaempf wrote GAS and BFD
6423 support for openVMS/Alpha.
6424
6425 Timothy Wall, Michael Hayes, and Greg Smart contributed to the various tic*
6426 flavors.
6427
6428 David Heine, Sterling Augustine, Bob Wilson and John Ruttenberg from Tensilica,
6429 Inc. added support for Xtensa processors.
6430
6431 Several engineers at Cygnus Support have also provided many small bug fixes and
6432 configuration enhancements.
6433
6434 Many others have contributed large or small bugfixes and enhancements. If
6435 you have contributed significant work and are not mentioned on this list, and
6436 want to be, let us know. Some of the history has been lost; we are not
6437 intentionally leaving anyone out.
6438
6439 @include fdl.texi
6440
6441 @node Index
6442 @unnumbered Index
6443
6444 @printindex cp
6445
6446 @contents
6447 @bye
6448 @c Local Variables:
6449 @c fill-column: 79
6450 @c End:
This page took 0.191395 seconds and 5 git commands to generate.