MIPS/GAS/doc: Refer to `.module' rather than `.set'
[external/binutils.git] / gas / doc / c-mips.texi
1 @c Copyright (C) 1991-2017 Free Software Foundation, Inc.
2 @c This is part of the GAS manual.
3 @c For copying conditions, see the file as.texinfo.
4 @ifset GENERIC
5 @page
6 @node MIPS-Dependent
7 @chapter MIPS Dependent Features
8 @end ifset
9 @ifclear GENERIC
10 @node Machine Dependencies
11 @chapter MIPS Dependent Features
12 @end ifclear
13
14 @cindex MIPS processor
15 @sc{gnu} @code{@value{AS}} for MIPS architectures supports several
16 different MIPS processors, and MIPS ISA levels I through V, MIPS32,
17 and MIPS64.  For information about the MIPS instruction set, see
18 @cite{MIPS RISC Architecture}, by Kane and Heindrich (Prentice-Hall).
19 For an overview of MIPS assembly conventions, see ``Appendix D:
20 Assembly Language Programming'' in the same work.
21
22 @menu
23 * MIPS Options::        Assembler options
24 * MIPS Macros::         High-level assembly macros
25 * MIPS Symbol Sizes::   Directives to override the size of symbols
26 * MIPS Small Data::     Controlling the use of small data accesses
27 * MIPS ISA::            Directives to override the ISA level
28 * MIPS assembly options:: Directives to control code generation
29 * MIPS autoextend::     Directives for extending MIPS 16 bit instructions
30 * MIPS insn::           Directive to mark data as an instruction
31 * MIPS FP ABIs::        Marking which FP ABI is in use
32 * MIPS NaN Encodings::  Directives to record which NaN encoding is being used
33 * MIPS Option Stack::   Directives to save and restore options
34 * MIPS ASE Instruction Generation Overrides:: Directives to control
35                         generation of MIPS ASE instructions
36 * MIPS Floating-Point:: Directives to override floating-point options
37 * MIPS Syntax::         MIPS specific syntactical considerations
38 @end menu
39
40 @node MIPS Options
41 @section Assembler options
42
43 The MIPS configurations of @sc{gnu} @code{@value{AS}} support these
44 special options:
45
46 @table @code
47 @cindex @code{-G} option (MIPS)
48 @item -G @var{num}
49 Set the ``small data'' limit to @var{n} bytes.  The default limit is 8 bytes.
50 @xref{MIPS Small Data,, Controlling the use of small data accesses}.
51
52 @cindex @code{-EB} option (MIPS)
53 @cindex @code{-EL} option (MIPS)
54 @cindex MIPS big-endian output
55 @cindex MIPS little-endian output
56 @cindex big-endian output, MIPS
57 @cindex little-endian output, MIPS
58 @item -EB
59 @itemx -EL
60 Any MIPS configuration of @code{@value{AS}} can select big-endian or
61 little-endian output at run time (unlike the other @sc{gnu} development
62 tools, which must be configured for one or the other).  Use @samp{-EB}
63 to select big-endian output, and @samp{-EL} for little-endian.
64
65 @item -KPIC
66 @cindex PIC selection, MIPS
67 @cindex @option{-KPIC} option, MIPS
68 Generate SVR4-style PIC.  This option tells the assembler to generate
69 SVR4-style position-independent macro expansions.  It also tells the
70 assembler to mark the output file as PIC.
71
72 @item -mvxworks-pic
73 @cindex @option{-mvxworks-pic} option, MIPS
74 Generate VxWorks PIC.  This option tells the assembler to generate
75 VxWorks-style position-independent macro expansions.
76
77 @cindex MIPS architecture options
78 @item -mips1
79 @itemx -mips2
80 @itemx -mips3
81 @itemx -mips4
82 @itemx -mips5
83 @itemx -mips32
84 @itemx -mips32r2
85 @itemx -mips32r3
86 @itemx -mips32r5
87 @itemx -mips32r6
88 @itemx -mips64
89 @itemx -mips64r2
90 @itemx -mips64r3
91 @itemx -mips64r5
92 @itemx -mips64r6
93 Generate code for a particular MIPS Instruction Set Architecture level.
94 @samp{-mips1} corresponds to the R2000 and R3000 processors,
95 @samp{-mips2} to the R6000 processor, @samp{-mips3} to the
96 R4000 processor, and @samp{-mips4} to the R8000 and R10000 processors.
97 @samp{-mips5}, @samp{-mips32}, @samp{-mips32r2}, @samp{-mips32r3},
98 @samp{-mips32r5}, @samp{-mips32r6}, @samp{-mips64}, @samp{-mips64r2},
99 @samp{-mips64r3}, @samp{-mips64r5}, and @samp{-mips64r6} correspond to
100 generic MIPS V, MIPS32, MIPS32 Release 2, MIPS32 Release 3, MIPS32
101 Release 5, MIPS32 Release 6, MIPS64, and MIPS64 Release 2, MIPS64
102 Release 3, MIPS64 Release 5, and MIPS64 Release 6 ISA processors,
103 respectively.  You can also switch instruction sets during the assembly;
104 see @ref{MIPS ISA, Directives to override the ISA level}.
105
106 @item -mgp32
107 @itemx -mfp32
108 Some macros have different expansions for 32-bit and 64-bit registers.
109 The register sizes are normally inferred from the ISA and ABI, but these
110 flags force a certain group of registers to be treated as 32 bits wide at
111 all times.  @samp{-mgp32} controls the size of general-purpose registers
112 and @samp{-mfp32} controls the size of floating-point registers.
113
114 The @code{.set gp=32} and @code{.set fp=32} directives allow the size
115 of registers to be changed for parts of an object. The default value is
116 restored by @code{.set gp=default} and @code{.set fp=default}.
117
118 On some MIPS variants there is a 32-bit mode flag; when this flag is
119 set, 64-bit instructions generate a trap.  Also, some 32-bit OSes only
120 save the 32-bit registers on a context switch, so it is essential never
121 to use the 64-bit registers.
122
123 @item -mgp64
124 @itemx -mfp64
125 Assume that 64-bit registers are available.  This is provided in the
126 interests of symmetry with @samp{-mgp32} and @samp{-mfp32}.
127
128 The @code{.set gp=64} and @code{.set fp=64} directives allow the size
129 of registers to be changed for parts of an object. The default value is
130 restored by @code{.set gp=default} and @code{.set fp=default}.
131
132 @item -mfpxx
133 Make no assumptions about whether 32-bit or 64-bit floating-point
134 registers are available. This is provided to support having modules
135 compatible with either @samp{-mfp32} or @samp{-mfp64}. This option can
136 only be used with MIPS II and above.
137
138 The @code{.set fp=xx} directive allows a part of an object to be marked
139 as not making assumptions about 32-bit or 64-bit FP registers.  The
140 default value is restored by @code{.set fp=default}.
141
142 @item -modd-spreg
143 @itemx -mno-odd-spreg
144 Enable use of floating-point operations on odd-numbered single-precision
145 registers when supported by the ISA.  @samp{-mfpxx} implies
146 @samp{-mno-odd-spreg}, otherwise the default is @samp{-modd-spreg}
147
148 @item -mips16
149 @itemx -no-mips16
150 Generate code for the MIPS 16 processor.  This is equivalent to putting
151 @code{.module mips16} at the start of the assembly file.  @samp{-no-mips16}
152 turns off this option.
153
154 @item -mmicromips
155 @itemx -mno-micromips
156 Generate code for the microMIPS processor.  This is equivalent to putting
157 @code{.module micromips} at the start of the assembly file.
158 @samp{-mno-micromips} turns off this option.  This is equivalent to putting
159 @code{.module nomicromips} at the start of the assembly file.
160
161 @item -msmartmips
162 @itemx -mno-smartmips
163 Enables the SmartMIPS extensions to the MIPS32 instruction set, which
164 provides a number of new instructions which target smartcard and
165 cryptographic applications.  This is equivalent to putting
166 @code{.module smartmips} at the start of the assembly file.
167 @samp{-mno-smartmips} turns off this option.
168
169 @item -mips3d
170 @itemx -no-mips3d
171 Generate code for the MIPS-3D Application Specific Extension.
172 This tells the assembler to accept MIPS-3D instructions.
173 @samp{-no-mips3d} turns off this option.
174
175 @item -mdmx
176 @itemx -no-mdmx
177 Generate code for the MDMX Application Specific Extension.
178 This tells the assembler to accept MDMX instructions.
179 @samp{-no-mdmx} turns off this option.
180
181 @item -mdsp
182 @itemx -mno-dsp
183 Generate code for the DSP Release 1 Application Specific Extension.
184 This tells the assembler to accept DSP Release 1 instructions.
185 @samp{-mno-dsp} turns off this option.
186
187 @item -mdspr2
188 @itemx -mno-dspr2
189 Generate code for the DSP Release 2 Application Specific Extension.
190 This option implies @samp{-mdsp}.
191 This tells the assembler to accept DSP Release 2 instructions.
192 @samp{-mno-dspr2} turns off this option.
193
194 @item -mdspr3
195 @itemx -mno-dspr3
196 Generate code for the DSP Release 3 Application Specific Extension.
197 This option implies @samp{-mdsp} and @samp{-mdspr2}.
198 This tells the assembler to accept DSP Release 3 instructions.
199 @samp{-mno-dspr3} turns off this option.
200
201 @item -mmt
202 @itemx -mno-mt
203 Generate code for the MT Application Specific Extension.
204 This tells the assembler to accept MT instructions.
205 @samp{-mno-mt} turns off this option.
206
207 @item -mmcu
208 @itemx -mno-mcu
209 Generate code for the MCU Application Specific Extension.
210 This tells the assembler to accept MCU instructions.
211 @samp{-mno-mcu} turns off this option.
212
213 @item -mmsa
214 @itemx -mno-msa
215 Generate code for the MIPS SIMD Architecture Extension.
216 This tells the assembler to accept MSA instructions.
217 @samp{-mno-msa} turns off this option.
218
219 @item -mxpa
220 @itemx -mno-xpa
221 Generate code for the MIPS eXtended Physical Address (XPA) Extension.
222 This tells the assembler to accept XPA instructions.
223 @samp{-mno-xpa} turns off this option.
224
225 @item -mvirt
226 @itemx -mno-virt
227 Generate code for the Virtualization Application Specific Extension.
228 This tells the assembler to accept Virtualization instructions.
229 @samp{-mno-virt} turns off this option.
230
231 @item -minsn32
232 @itemx -mno-insn32
233 Only use 32-bit instruction encodings when generating code for the
234 microMIPS processor.  This option inhibits the use of any 16-bit
235 instructions.  This is equivalent to putting @code{.set insn32} at
236 the start of the assembly file.  @samp{-mno-insn32} turns off this
237 option.  This is equivalent to putting @code{.set noinsn32} at the
238 start of the assembly file.  By default @samp{-mno-insn32} is
239 selected, allowing all instructions to be used.
240
241 @item -mfix7000
242 @itemx -mno-fix7000
243 Cause nops to be inserted if the read of the destination register
244 of an mfhi or mflo instruction occurs in the following two instructions.
245
246 @item -mfix-rm7000
247 @itemx -mno-fix-rm7000
248 Cause nops to be inserted if a dmult or dmultu instruction is
249 followed by a load instruction.
250
251 @item -mfix-loongson2f-jump
252 @itemx -mno-fix-loongson2f-jump
253 Eliminate instruction fetch from outside 256M region to work around the
254 Loongson2F @samp{jump} instructions.  Without it, under extreme cases,
255 the kernel may crash.  The issue has been solved in latest processor
256 batches, but this fix has no side effect to them.
257
258 @item -mfix-loongson2f-nop
259 @itemx -mno-fix-loongson2f-nop
260 Replace nops by @code{or at,at,zero} to work around the Loongson2F
261 @samp{nop} errata.  Without it, under extreme cases, the CPU might
262 deadlock.  The issue has been solved in later Loongson2F batches, but
263 this fix has no side effect to them.
264
265 @item -mfix-vr4120
266 @itemx -mno-fix-vr4120
267 Insert nops to work around certain VR4120 errata.  This option is
268 intended to be used on GCC-generated code: it is not designed to catch
269 all problems in hand-written assembler code.
270
271 @item -mfix-vr4130
272 @itemx -mno-fix-vr4130
273 Insert nops to work around the VR4130 @samp{mflo}/@samp{mfhi} errata.
274
275 @item -mfix-24k
276 @itemx -mno-fix-24k
277 Insert nops to work around the 24K @samp{eret}/@samp{deret} errata.
278
279 @item -mfix-cn63xxp1
280 @itemx -mno-fix-cn63xxp1
281 Replace @code{pref} hints 0 - 4 and 6 - 24 with hint 28 to work around
282 certain CN63XXP1 errata.
283
284 @item -m4010
285 @itemx -no-m4010
286 Generate code for the LSI R4010 chip.  This tells the assembler to
287 accept the R4010-specific instructions (@samp{addciu}, @samp{ffc},
288 etc.), and to not schedule @samp{nop} instructions around accesses to
289 the @samp{HI} and @samp{LO} registers.  @samp{-no-m4010} turns off this
290 option.
291
292 @item -m4650
293 @itemx -no-m4650
294 Generate code for the MIPS R4650 chip.  This tells the assembler to accept
295 the @samp{mad} and @samp{madu} instruction, and to not schedule @samp{nop}
296 instructions around accesses to the @samp{HI} and @samp{LO} registers.
297 @samp{-no-m4650} turns off this option.
298
299 @item -m3900
300 @itemx -no-m3900
301 @itemx -m4100
302 @itemx -no-m4100
303 For each option @samp{-m@var{nnnn}}, generate code for the MIPS
304 R@var{nnnn} chip.  This tells the assembler to accept instructions
305 specific to that chip, and to schedule for that chip's hazards.
306
307 @item -march=@var{cpu}
308 Generate code for a particular MIPS CPU.  It is exactly equivalent to
309 @samp{-m@var{cpu}}, except that there are more value of @var{cpu}
310 understood.  Valid @var{cpu} value are:
311
312 @quotation
313 2000,
314 3000,
315 3900,
316 4000,
317 4010,
318 4100,
319 4111,
320 vr4120,
321 vr4130,
322 vr4181,
323 4300,
324 4400,
325 4600,
326 4650,
327 5000,
328 rm5200,
329 rm5230,
330 rm5231,
331 rm5261,
332 rm5721,
333 vr5400,
334 vr5500,
335 6000,
336 rm7000,
337 8000,
338 rm9000,
339 10000,
340 12000,
341 14000,
342 16000,
343 4kc,
344 4km,
345 4kp,
346 4ksc,
347 4kec,
348 4kem,
349 4kep,
350 4ksd,
351 m4k,
352 m4kp,
353 m14k,
354 m14kc,
355 m14ke,
356 m14kec,
357 24kc,
358 24kf2_1,
359 24kf,
360 24kf1_1,
361 24kec,
362 24kef2_1,
363 24kef,
364 24kef1_1,
365 34kc,
366 34kf2_1,
367 34kf,
368 34kf1_1,
369 34kn,
370 74kc,
371 74kf2_1,
372 74kf,
373 74kf1_1,
374 74kf3_2,
375 1004kc,
376 1004kf2_1,
377 1004kf,
378 1004kf1_1,
379 interaptiv,
380 m5100,
381 m5101,
382 p5600,
383 5kc,
384 5kf,
385 20kc,
386 25kf,
387 sb1,
388 sb1a,
389 i6400,
390 p6600,
391 loongson2e,
392 loongson2f,
393 loongson3a,
394 octeon,
395 octeon+,
396 octeon2,
397 octeon3,
398 xlr,
399 xlp
400 @end quotation
401
402 For compatibility reasons, @samp{@var{n}x} and @samp{@var{b}fx} are
403 accepted as synonyms for @samp{@var{n}f1_1}.  These values are
404 deprecated.
405
406 @item -mtune=@var{cpu}
407 Schedule and tune for a particular MIPS CPU.  Valid @var{cpu} values are
408 identical to @samp{-march=@var{cpu}}.
409
410 @item -mabi=@var{abi}
411 Record which ABI the source code uses.  The recognized arguments
412 are: @samp{32}, @samp{n32}, @samp{o64}, @samp{64} and @samp{eabi}.
413
414 @item -msym32
415 @itemx -mno-sym32
416 @cindex -msym32
417 @cindex -mno-sym32
418 Equivalent to adding @code{.set sym32} or @code{.set nosym32} to
419 the beginning of the assembler input.  @xref{MIPS Symbol Sizes}.
420
421 @cindex @code{-nocpp} ignored (MIPS)
422 @item -nocpp
423 This option is ignored.  It is accepted for command-line compatibility with
424 other assemblers, which use it to turn off C style preprocessing.  With
425 @sc{gnu} @code{@value{AS}}, there is no need for @samp{-nocpp}, because the
426 @sc{gnu} assembler itself never runs the C preprocessor.
427
428 @item -msoft-float
429 @itemx -mhard-float
430 Disable or enable floating-point instructions.  Note that by default
431 floating-point instructions are always allowed even with CPU targets
432 that don't have support for these instructions.
433
434 @item -msingle-float
435 @itemx -mdouble-float
436 Disable or enable double-precision floating-point operations.  Note
437 that by default double-precision floating-point operations are always
438 allowed even with CPU targets that don't have support for these
439 operations.
440
441 @item --construct-floats
442 @itemx --no-construct-floats
443 The @code{--no-construct-floats} option disables the construction of
444 double width floating point constants by loading the two halves of the
445 value into the two single width floating point registers that make up
446 the double width register.  This feature is useful if the processor
447 support the FR bit in its status  register, and this bit is known (by
448 the programmer) to be set.  This bit prevents the aliasing of the double
449 width register by the single width registers.
450
451 By default @code{--construct-floats} is selected, allowing construction
452 of these floating point constants.
453
454 @item --relax-branch
455 @itemx --no-relax-branch
456 The @samp{--relax-branch} option enables the relaxation of out-of-range
457 branches.  Any branches whose target cannot be reached directly are
458 converted to a small instruction sequence including an inverse-condition
459 branch to the physically next instruction, and a jump to the original
460 target is inserted between the two instructions.  In PIC code the jump
461 will involve further instructions for address calculation.
462
463 The @code{BC1ANY2F}, @code{BC1ANY2T}, @code{BC1ANY4F}, @code{BC1ANY4T},
464 @code{BPOSGE32} and @code{BPOSGE64} instructions are excluded from
465 relaxation, because they have no complementing counterparts.  They could
466 be relaxed with the use of a longer sequence involving another branch,
467 however this has not been implemented and if their target turns out of
468 reach, they produce an error even if branch relaxation is enabled.
469
470 Also no MIPS16 branches are ever relaxed.
471
472 By default @samp{--no-relax-branch} is selected, causing any out-of-range
473 branches to produce an error.
474
475 @item -mignore-branch-isa
476 @itemx -mno-ignore-branch-isa
477 Ignore branch checks for invalid transitions between ISA modes.
478
479 The semantics of branches does not provide for an ISA mode switch, so in
480 most cases the ISA mode a branch has been encoded for has to be the same
481 as the ISA mode of the branch's target label.  If the ISA modes do not
482 match, then such a branch, if taken, will cause the ISA mode to remain
483 unchanged and instructions that follow will be executed in the wrong ISA
484 mode causing the program to misbehave or crash.
485
486 In the case of the @code{BAL} instruction it may be possible to relax
487 it to an equivalent @code{JALX} instruction so that the ISA mode is
488 switched at the run time as required.  For other branches no relaxation
489 is possible and therefore GAS has checks implemented that verify in
490 branch assembly that the two ISA modes match, and report an error
491 otherwise so that the problem with code can be diagnosed at the assembly
492 time rather than at the run time.
493
494 However some assembly code, including generated code produced by some
495 versions of GCC, may incorrectly include branches to data labels, which
496 appear to require a mode switch but are either dead or immediately
497 followed by valid instructions encoded for the same ISA the branch has
498 been encoded for.  While not strictly correct at the source level such
499 code will execute as intended, so to help with these cases
500 @samp{-mignore-branch-isa} is supported which disables ISA mode checks
501 for branches.
502
503 By default @samp{-mno-ignore-branch-isa} is selected, causing any invalid
504 branch requiring a transition between ISA modes to produce an error.
505
506 @cindex @option{-mnan=} command line option, MIPS
507 @item -mnan=@var{encoding}
508 This option indicates whether the source code uses the IEEE 2008
509 NaN encoding (@option{-mnan=2008}) or the original MIPS encoding
510 (@option{-mnan=legacy}).  It is equivalent to adding a @code{.nan}
511 directive to the beginning of the source file.  @xref{MIPS NaN Encodings}.
512
513 @option{-mnan=legacy} is the default if no @option{-mnan} option or
514 @code{.nan} directive is used.
515
516 @item --trap
517 @itemx --no-break
518 @c FIXME!  (1) reflect these options (next item too) in option summaries;
519 @c         (2) stop teasing, say _which_ instructions expanded _how_.
520 @code{@value{AS}} automatically macro expands certain division and
521 multiplication instructions to check for overflow and division by zero.  This
522 option causes @code{@value{AS}} to generate code to take a trap exception
523 rather than a break exception when an error is detected.  The trap instructions
524 are only supported at Instruction Set Architecture level 2 and higher.
525
526 @item --break
527 @itemx --no-trap
528 Generate code to take a break exception rather than a trap exception when an
529 error is detected.  This is the default.
530
531 @item -mpdr
532 @itemx -mno-pdr
533 Control generation of @code{.pdr} sections.  Off by default on IRIX, on
534 elsewhere.
535
536 @item -mshared
537 @itemx -mno-shared
538 When generating code using the Unix calling conventions (selected by
539 @samp{-KPIC} or @samp{-mcall_shared}), gas will normally generate code
540 which can go into a shared library.  The @samp{-mno-shared} option
541 tells gas to generate code which uses the calling convention, but can
542 not go into a shared library.  The resulting code is slightly more
543 efficient.  This option only affects the handling of the
544 @samp{.cpload} and @samp{.cpsetup} pseudo-ops.
545 @end table
546
547 @node MIPS Macros
548 @section High-level assembly macros
549
550 MIPS assemblers have traditionally provided a wider range of
551 instructions than the MIPS architecture itself.  These extra
552 instructions are usually referred to as ``macro'' instructions
553 @footnote{The term ``macro'' is somewhat overloaded here, since
554 these macros have no relation to those defined by @code{.macro},
555 @pxref{Macro,, @code{.macro}}.}.
556
557 Some MIPS macro instructions extend an underlying architectural instruction
558 while others are entirely new.  An example of the former type is @code{and},
559 which allows the third operand to be either a register or an arbitrary
560 immediate value.  Examples of the latter type include @code{bgt}, which
561 branches to the third operand when the first operand is greater than
562 the second operand, and @code{ulh}, which implements an unaligned
563 2-byte load.
564
565 One of the most common extensions provided by macros is to expand
566 memory offsets to the full address range (32 or 64 bits) and to allow
567 symbolic offsets such as @samp{my_data + 4} to be used in place of
568 integer constants.  For example, the architectural instruction
569 @code{lbu} allows only a signed 16-bit offset, whereas the macro
570 @code{lbu} allows code such as @samp{lbu $4,array+32769($5)}.
571 The implementation of these symbolic offsets depends on several factors,
572 such as whether the assembler is generating SVR4-style PIC (selected by
573 @option{-KPIC}, @pxref{MIPS Options,, Assembler options}), the size of symbols
574 (@pxref{MIPS Symbol Sizes,, Directives to override the size of symbols}),
575 and the small data limit (@pxref{MIPS Small Data,, Controlling the use
576 of small data accesses}).
577
578 @kindex @code{.set macro}
579 @kindex @code{.set nomacro}
580 Sometimes it is undesirable to have one assembly instruction expand
581 to several machine instructions.  The directive @code{.set nomacro}
582 tells the assembler to warn when this happens.  @code{.set macro}
583 restores the default behavior.
584
585 @cindex @code{at} register, MIPS
586 @kindex @code{.set at=@var{reg}}
587 Some macro instructions need a temporary register to store intermediate
588 results.  This register is usually @code{$1}, also known as @code{$at},
589 but it can be changed to any core register @var{reg} using
590 @code{.set at=@var{reg}}.  Note that @code{$at} always refers
591 to @code{$1} regardless of which register is being used as the
592 temporary register.
593
594 @kindex @code{.set at}
595 @kindex @code{.set noat}
596 Implicit uses of the temporary register in macros could interfere with
597 explicit uses in the assembly code.  The assembler therefore warns
598 whenever it sees an explicit use of the temporary register.  The directive
599 @code{.set noat} silences this warning while @code{.set at} restores
600 the default behavior.  It is safe to use @code{.set noat} while
601 @code{.set nomacro} is in effect since single-instruction macros
602 never need a temporary register.
603
604 Note that while the @sc{gnu} assembler provides these macros for compatibility,
605 it does not make any attempt to optimize them with the surrounding code.
606
607 @node MIPS Symbol Sizes
608 @section Directives to override the size of symbols
609
610 @kindex @code{.set sym32}
611 @kindex @code{.set nosym32}
612 The n64 ABI allows symbols to have any 64-bit value.  Although this
613 provides a great deal of flexibility, it means that some macros have
614 much longer expansions than their 32-bit counterparts.  For example,
615 the non-PIC expansion of @samp{dla $4,sym} is usually:
616
617 @smallexample
618 lui     $4,%highest(sym)
619 lui     $1,%hi(sym)
620 daddiu  $4,$4,%higher(sym)
621 daddiu  $1,$1,%lo(sym)
622 dsll32  $4,$4,0
623 daddu   $4,$4,$1
624 @end smallexample
625
626 whereas the 32-bit expansion is simply:
627
628 @smallexample
629 lui     $4,%hi(sym)
630 daddiu  $4,$4,%lo(sym)
631 @end smallexample
632
633 n64 code is sometimes constructed in such a way that all symbolic
634 constants are known to have 32-bit values, and in such cases, it's
635 preferable to use the 32-bit expansion instead of the 64-bit
636 expansion.
637
638 You can use the @code{.set sym32} directive to tell the assembler
639 that, from this point on, all expressions of the form
640 @samp{@var{symbol}} or @samp{@var{symbol} + @var{offset}}
641 have 32-bit values.  For example:
642
643 @smallexample
644 .set sym32
645 dla     $4,sym
646 lw      $4,sym+16
647 sw      $4,sym+0x8000($4)
648 @end smallexample
649
650 will cause the assembler to treat @samp{sym}, @code{sym+16} and
651 @code{sym+0x8000} as 32-bit values.  The handling of non-symbolic
652 addresses is not affected.
653
654 The directive @code{.set nosym32} ends a @code{.set sym32} block and
655 reverts to the normal behavior.  It is also possible to change the
656 symbol size using the command-line options @option{-msym32} and
657 @option{-mno-sym32}.
658
659 These options and directives are always accepted, but at present,
660 they have no effect for anything other than n64.
661
662 @node MIPS Small Data
663 @section Controlling the use of small data accesses
664
665 @c This section deliberately glosses over the possibility of using -G
666 @c in SVR4-style PIC, as could be done on IRIX.  We don't support that.
667 @cindex small data, MIPS
668 @cindex @code{gp} register, MIPS
669 It often takes several instructions to load the address of a symbol.
670 For example, when @samp{addr} is a 32-bit symbol, the non-PIC expansion
671 of @samp{dla $4,addr} is usually:
672
673 @smallexample
674 lui     $4,%hi(addr)
675 daddiu  $4,$4,%lo(addr)
676 @end smallexample
677
678 The sequence is much longer when @samp{addr} is a 64-bit symbol.
679 @xref{MIPS Symbol Sizes,, Directives to override the size of symbols}.
680
681 In order to cut down on this overhead, most embedded MIPS systems
682 set aside a 64-kilobyte ``small data'' area and guarantee that all
683 data of size @var{n} and smaller will be placed in that area.
684 The limit @var{n} is passed to both the assembler and the linker
685 using the command-line option @option{-G @var{n}}, @pxref{MIPS Options,,
686 Assembler options}.  Note that the same value of @var{n} must be used
687 when linking and when assembling all input files to the link; any
688 inconsistency could cause a relocation overflow error.
689
690 The size of an object in the @code{.bss} section is set by the
691 @code{.comm} or @code{.lcomm} directive that defines it.  The size of
692 an external object may be set with the @code{.extern} directive.  For
693 example, @samp{.extern sym,4} declares that the object at @code{sym}
694 is 4 bytes in length, while leaving @code{sym} otherwise undefined.
695
696 When no @option{-G} option is given, the default limit is 8 bytes.
697 The option @option{-G 0} prevents any data from being automatically
698 classified as small.
699
700 It is also possible to mark specific objects as small by putting them
701 in the special sections @code{.sdata} and @code{.sbss}, which are
702 ``small'' counterparts of @code{.data} and @code{.bss} respectively.
703 The toolchain will treat such data as small regardless of the
704 @option{-G} setting.
705
706 On startup, systems that support a small data area are expected to
707 initialize register @code{$28}, also known as @code{$gp}, in such a
708 way that small data can be accessed using a 16-bit offset from that
709 register.  For example, when @samp{addr} is small data,
710 the @samp{dla $4,addr} instruction above is equivalent to:
711
712 @smallexample
713 daddiu  $4,$28,%gp_rel(addr)
714 @end smallexample
715
716 Small data is not supported for SVR4-style PIC.
717
718 @node MIPS ISA
719 @section Directives to override the ISA level
720
721 @cindex MIPS ISA override
722 @kindex @code{.set mips@var{n}}
723 @sc{gnu} @code{@value{AS}} supports an additional directive to change
724 the MIPS Instruction Set Architecture level on the fly: @code{.set
725 mips@var{n}}.  @var{n} should be a number from 0 to 5, or 32, 32r2, 32r3,
726 32r5, 32r6, 64, 64r2, 64r3, 64r5 or 64r6.
727 The values other than 0 make the assembler accept instructions
728 for the corresponding ISA level, from that point on in the
729 assembly.  @code{.set mips@var{n}} affects not only which instructions
730 are permitted, but also how certain macros are expanded.  @code{.set
731 mips0} restores the ISA level to its original level: either the
732 level you selected with command line options, or the default for your
733 configuration.  You can use this feature to permit specific MIPS III
734 instructions while assembling in 32 bit mode.  Use this directive with
735 care!
736
737 @cindex MIPS CPU override
738 @kindex @code{.set arch=@var{cpu}}
739 The @code{.set arch=@var{cpu}} directive provides even finer control.
740 It changes the effective CPU target and allows the assembler to use
741 instructions specific to a particular CPU.  All CPUs supported by the
742 @samp{-march} command line option are also selectable by this directive.
743 The original value is restored by @code{.set arch=default}.
744
745 The directive @code{.set mips16} puts the assembler into MIPS 16 mode,
746 in which it will assemble instructions for the MIPS 16 processor.  Use
747 @code{.set nomips16} to return to normal 32 bit mode.
748
749 Traditional MIPS assemblers do not support this directive.
750
751 The directive @code{.set micromips} puts the assembler into microMIPS mode,
752 in which it will assemble instructions for the microMIPS processor.  Use
753 @code{.set nomicromips} to return to normal 32 bit mode.
754
755 Traditional MIPS assemblers do not support this directive.
756
757 @node MIPS assembly options
758 @section Directives to control code generation
759
760 @cindex MIPS directives to override command line options
761 @kindex @code{.module}
762 The @code{.module} directive allows command line options to be set directly
763 from assembly.  The format of the directive matches the @code{.set}
764 directive but only those options which are relevant to a whole module are
765 supported.  The effect of a @code{.module} directive is the same as the
766 corresponding command line option.  Where @code{.set} directives support
767 returning to a default then the @code{.module} directives do not as they
768 define the defaults.
769
770 These module-level directives must appear first in assembly.
771
772 Traditional MIPS assemblers do not support this directive.
773
774 @cindex MIPS 32-bit microMIPS instruction generation override
775 @kindex @code{.set insn32}
776 @kindex @code{.set noinsn32}
777 The directive @code{.set insn32} makes the assembler only use 32-bit
778 instruction encodings when generating code for the microMIPS processor.
779 This directive inhibits the use of any 16-bit instructions from that
780 point on in the assembly.  The @code{.set noinsn32} directive allows
781 16-bit instructions to be accepted.
782
783 Traditional MIPS assemblers do not support this directive.
784
785 @node MIPS autoextend
786 @section Directives for extending MIPS 16 bit instructions
787
788 @kindex @code{.set autoextend}
789 @kindex @code{.set noautoextend}
790 By default, MIPS 16 instructions are automatically extended to 32 bits
791 when necessary.  The directive @code{.set noautoextend} will turn this
792 off.  When @code{.set noautoextend} is in effect, any 32 bit instruction
793 must be explicitly extended with the @code{.e} modifier (e.g.,
794 @code{li.e $4,1000}).  The directive @code{.set autoextend} may be used
795 to once again automatically extend instructions when necessary.
796
797 This directive is only meaningful when in MIPS 16 mode.  Traditional
798 MIPS assemblers do not support this directive.
799
800 @node MIPS insn
801 @section Directive to mark data as an instruction
802
803 @kindex @code{.insn}
804 The @code{.insn} directive tells @code{@value{AS}} that the following
805 data is actually instructions.  This makes a difference in MIPS 16 and
806 microMIPS modes: when loading the address of a label which precedes
807 instructions, @code{@value{AS}} automatically adds 1 to the value, so
808 that jumping to the loaded address will do the right thing.
809
810 @kindex @code{.global}
811 The @code{.global} and @code{.globl} directives supported by
812 @code{@value{AS}} will by default mark the symbol as pointing to a
813 region of data not code.  This means that, for example, any
814 instructions following such a symbol will not be disassembled by
815 @code{objdump} as it will regard them as data.  To change this
816 behavior an optional section name can be placed after the symbol name
817 in the @code{.global} directive.  If this section exists and is known
818 to be a code section, then the symbol will be marked as pointing at
819 code not data.  Ie the syntax for the directive is:
820
821   @code{.global @var{symbol}[ @var{section}][, @var{symbol}[ @var{section}]] ...},
822
823 Here is a short example:
824
825 @example
826         .global foo .text, bar, baz .data
827 foo:
828         nop
829 bar:
830         .word 0x0
831 baz:
832         .word 0x1
833
834 @end example
835
836 @node MIPS FP ABIs
837 @section Directives to control the FP ABI
838 @menu
839 * MIPS FP ABI History::                History of FP ABIs
840 * MIPS FP ABI Variants::               Supported FP ABIs
841 * MIPS FP ABI Selection::              Automatic selection of FP ABI
842 * MIPS FP ABI Compatibility::          Linking different FP ABI variants
843 @end menu
844
845 @node MIPS FP ABI History
846 @subsection History of FP ABIs
847 @cindex @code{.gnu_attribute 4, @var{n}} directive, MIPS
848 @cindex @code{.gnu_attribute Tag_GNU_MIPS_ABI_FP, @var{n}} directive, MIPS
849 The MIPS ABIs support a variety of different floating-point extensions
850 where calling-convention and register sizes vary for floating-point data.
851 The extensions exist to support a wide variety of optional architecture
852 features.  The resulting ABI variants are generally incompatible with each
853 other and must be tracked carefully.
854
855 Traditionally the use of an explicit @code{.gnu_attribute 4, @var{n}}
856 directive is used to indicate which ABI is in use by a specific module.
857 It was then left to the user to ensure that command line options and the
858 selected ABI were compatible with some potential for inconsistencies.
859
860 @node MIPS FP ABI Variants
861 @subsection Supported FP ABIs
862 The supported floating-point ABI variants are:
863
864 @table @code
865 @item 0 - No floating-point
866 This variant is used to indicate that floating-point is not used within
867 the module at all and therefore has no impact on the ABI.  This is the
868 default.
869
870 @item 1 - Double-precision
871 This variant indicates that double-precision support is used.  For 64-bit
872 ABIs this means that 64-bit wide floating-point registers are required.
873 For 32-bit ABIs this means that 32-bit wide floating-point registers are
874 required and double-precision operations use pairs of registers.
875
876 @item 2 - Single-precision
877 This variant indicates that single-precision support is used.  Double
878 precision operations will be supported via soft-float routines.
879
880 @item 3 - Soft-float
881 This variant indicates that although floating-point support is used all
882 operations are emulated in software.  This means the ABI is modified to
883 pass all floating-point data in general-purpose registers.
884
885 @item 4 - Deprecated
886 This variant existed as an initial attempt at supporting 64-bit wide
887 floating-point registers for O32 ABI on a MIPS32r2 CPU.  This has been
888 superseded by 5, 6 and 7.
889
890 @item 5 - Double-precision 32-bit CPU, 32-bit or 64-bit FPU
891 This variant is used by 32-bit ABIs to indicate that the floating-point
892 code in the module has been designed to operate correctly with either
893 32-bit wide or 64-bit wide floating-point registers.  Double-precision
894 support is used.  Only O32 currently supports this variant and requires
895 a minimum architecture of MIPS II.
896
897 @item 6 - Double-precision 32-bit FPU, 64-bit FPU
898 This variant is used by 32-bit ABIs to indicate that the floating-point
899 code in the module requires 64-bit wide floating-point registers.
900 Double-precision support is used.  Only O32 currently supports this
901 variant and requires a minimum architecture of MIPS32r2.
902
903 @item 7 - Double-precision compat 32-bit FPU, 64-bit FPU
904 This variant is used by 32-bit ABIs to indicate that the floating-point
905 code in the module requires 64-bit wide floating-point registers.
906 Double-precision support is used.  This differs from the previous ABI
907 as it restricts use of odd-numbered single-precision registers.  Only
908 O32 currently supports this variant and requires a minimum architecture
909 of MIPS32r2.
910 @end table
911
912 @node MIPS FP ABI Selection
913 @subsection Automatic selection of FP ABI
914 @cindex @code{.module fp=@var{nn}} directive, MIPS
915 In order to simplify and add safety to the process of selecting the
916 correct floating-point ABI, the assembler will automatically infer the
917 correct @code{.gnu_attribute 4, @var{n}} directive based on command line
918 options and @code{.module} overrides.  Where an explicit
919 @code{.gnu_attribute 4, @var{n}} directive has been seen then a warning
920 will be raised if it does not match an inferred setting.
921
922 The floating-point ABI is inferred as follows.  If @samp{-msoft-float}
923 has been used the module will be marked as soft-float.  If
924 @samp{-msingle-float} has been used then the module will be marked as
925 single-precision.  The remaining ABIs are then selected based
926 on the FP register width.  Double-precision is selected if the width
927 of GP and FP registers match and the special double-precision variants
928 for 32-bit ABIs are then selected depending on @samp{-mfpxx},
929 @samp{-mfp64} and @samp{-mno-odd-spreg}.
930
931 @node MIPS FP ABI Compatibility
932 @subsection Linking different FP ABI variants
933 Modules using the default FP ABI (no floating-point) can be linked with
934 any other (singular) FP ABI variant.
935
936 Special compatibility support exists for O32 with the four
937 double-precision FP ABI variants.  The @samp{-mfpxx} FP ABI is specifically
938 designed to be compatible with the standard double-precision ABI and the
939 @samp{-mfp64} FP ABIs.  This makes it desirable for O32 modules to be
940 built as @samp{-mfpxx} to ensure the maximum compatibility with other
941 modules produced for more specific needs.  The only FP ABIs which cannot
942 be linked together are the standard double-precision ABI and the full
943 @samp{-mfp64} ABI with @samp{-modd-spreg}.
944
945 @node MIPS NaN Encodings
946 @section Directives to record which NaN encoding is being used
947
948 @cindex MIPS IEEE 754 NaN data encoding selection
949 @cindex @code{.nan} directive, MIPS
950 The IEEE 754 floating-point standard defines two types of not-a-number
951 (NaN) data: ``signalling'' NaNs and ``quiet'' NaNs.  The original version
952 of the standard did not specify how these two types should be
953 distinguished.  Most implementations followed the i387 model, in which
954 the first bit of the significand is set for quiet NaNs and clear for
955 signalling NaNs.  However, the original MIPS implementation assigned the
956 opposite meaning to the bit, so that it was set for signalling NaNs and
957 clear for quiet NaNs.
958
959 The 2008 revision of the standard formally suggested the i387 choice
960 and as from Sep 2012 the current release of the MIPS architecture
961 therefore optionally supports that form.  Code that uses one NaN encoding
962 would usually be incompatible with code that uses the other NaN encoding,
963 so MIPS ELF objects have a flag (@code{EF_MIPS_NAN2008}) to record which
964 encoding is being used.
965
966 Assembly files can use the @code{.nan} directive to select between the
967 two encodings.  @samp{.nan 2008} says that the assembly file uses the
968 IEEE 754-2008 encoding while @samp{.nan legacy} says that the file uses
969 the original MIPS encoding.  If several @code{.nan} directives are given,
970 the final setting is the one that is used.
971
972 The command-line options @option{-mnan=legacy} and @option{-mnan=2008}
973 can be used instead of @samp{.nan legacy} and @samp{.nan 2008}
974 respectively.  However, any @code{.nan} directive overrides the
975 command-line setting.
976
977 @samp{.nan legacy} is the default if no @code{.nan} directive or
978 @option{-mnan} option is given.
979
980 Note that @sc{gnu} @code{@value{AS}} does not produce NaNs itself and
981 therefore these directives do not affect code generation.  They simply
982 control the setting of the @code{EF_MIPS_NAN2008} flag.
983
984 Traditional MIPS assemblers do not support these directives.
985
986 @node MIPS Option Stack
987 @section Directives to save and restore options
988
989 @cindex MIPS option stack
990 @kindex @code{.set push}
991 @kindex @code{.set pop}
992 The directives @code{.set push} and @code{.set pop} may be used to save
993 and restore the current settings for all the options which are
994 controlled by @code{.set}.  The @code{.set push} directive saves the
995 current settings on a stack.  The @code{.set pop} directive pops the
996 stack and restores the settings.
997
998 These directives can be useful inside an macro which must change an
999 option such as the ISA level or instruction reordering but does not want
1000 to change the state of the code which invoked the macro.
1001
1002 Traditional MIPS assemblers do not support these directives.
1003
1004 @node MIPS ASE Instruction Generation Overrides
1005 @section Directives to control generation of MIPS ASE instructions
1006
1007 @cindex MIPS MIPS-3D instruction generation override
1008 @kindex @code{.set mips3d}
1009 @kindex @code{.set nomips3d}
1010 The directive @code{.set mips3d} makes the assembler accept instructions
1011 from the MIPS-3D Application Specific Extension from that point on
1012 in the assembly.  The @code{.set nomips3d} directive prevents MIPS-3D
1013 instructions from being accepted.
1014
1015 @cindex SmartMIPS instruction generation override
1016 @kindex @code{.set smartmips}
1017 @kindex @code{.set nosmartmips}
1018 The directive @code{.set smartmips} makes the assembler accept
1019 instructions from the SmartMIPS Application Specific Extension to the
1020 MIPS32 ISA from that point on in the assembly.  The
1021 @code{.set nosmartmips} directive prevents SmartMIPS instructions from
1022 being accepted.
1023
1024 @cindex MIPS MDMX instruction generation override
1025 @kindex @code{.set mdmx}
1026 @kindex @code{.set nomdmx}
1027 The directive @code{.set mdmx} makes the assembler accept instructions
1028 from the MDMX Application Specific Extension from that point on
1029 in the assembly.  The @code{.set nomdmx} directive prevents MDMX
1030 instructions from being accepted.
1031
1032 @cindex MIPS DSP Release 1 instruction generation override
1033 @kindex @code{.set dsp}
1034 @kindex @code{.set nodsp}
1035 The directive @code{.set dsp} makes the assembler accept instructions
1036 from the DSP Release 1 Application Specific Extension from that point
1037 on in the assembly.  The @code{.set nodsp} directive prevents DSP
1038 Release 1 instructions from being accepted.
1039
1040 @cindex MIPS DSP Release 2 instruction generation override
1041 @kindex @code{.set dspr2}
1042 @kindex @code{.set nodspr2}
1043 The directive @code{.set dspr2} makes the assembler accept instructions
1044 from the DSP Release 2 Application Specific Extension from that point
1045 on in the assembly.  This directive implies @code{.set dsp}.  The
1046 @code{.set nodspr2} directive prevents DSP Release 2 instructions from
1047 being accepted.
1048
1049 @cindex MIPS DSP Release 3 instruction generation override
1050 @kindex @code{.set dspr3}
1051 @kindex @code{.set nodspr3}
1052 The directive @code{.set dspr3} makes the assembler accept instructions
1053 from the DSP Release 3 Application Specific Extension from that point
1054 on in the assembly.  This directive implies @code{.set dsp} and
1055 @code{.set dspr2}.  The @code{.set nodspr3} directive prevents DSP
1056 Release 3 instructions from being accepted.
1057
1058 @cindex MIPS MT instruction generation override
1059 @kindex @code{.set mt}
1060 @kindex @code{.set nomt}
1061 The directive @code{.set mt} makes the assembler accept instructions
1062 from the MT Application Specific Extension from that point on
1063 in the assembly.  The @code{.set nomt} directive prevents MT
1064 instructions from being accepted.
1065
1066 @cindex MIPS MCU instruction generation override
1067 @kindex @code{.set mcu}
1068 @kindex @code{.set nomcu}
1069 The directive @code{.set mcu} makes the assembler accept instructions
1070 from the MCU Application Specific Extension from that point on
1071 in the assembly.  The @code{.set nomcu} directive prevents MCU
1072 instructions from being accepted.
1073
1074 @cindex MIPS SIMD Architecture instruction generation override
1075 @kindex @code{.set msa}
1076 @kindex @code{.set nomsa}
1077 The directive @code{.set msa} makes the assembler accept instructions
1078 from the MIPS SIMD Architecture Extension from that point on
1079 in the assembly.  The @code{.set nomsa} directive prevents MSA
1080 instructions from being accepted.
1081
1082 @cindex Virtualization instruction generation override
1083 @kindex @code{.set virt}
1084 @kindex @code{.set novirt}
1085 The directive @code{.set virt} makes the assembler accept instructions
1086 from the Virtualization Application Specific Extension from that point
1087 on in the assembly.  The @code{.set novirt} directive prevents Virtualization
1088 instructions from being accepted.
1089
1090 @cindex MIPS eXtended Physical Address (XPA) instruction generation override
1091 @kindex @code{.set xpa}
1092 @kindex @code{.set noxpa}
1093 The directive @code{.set xpa} makes the assembler accept instructions
1094 from the XPA Extension from that point on in the assembly.  The 
1095 @code{.set noxpa} directive prevents XPA instructions from being accepted.
1096
1097 Traditional MIPS assemblers do not support these directives.
1098
1099 @node MIPS Floating-Point
1100 @section Directives to override floating-point options
1101
1102 @cindex Disable floating-point instructions
1103 @kindex @code{.set softfloat}
1104 @kindex @code{.set hardfloat}
1105 The directives @code{.set softfloat} and @code{.set hardfloat} provide
1106 finer control of disabling and enabling float-point instructions.
1107 These directives always override the default (that hard-float
1108 instructions are accepted) or the command-line options
1109 (@samp{-msoft-float} and @samp{-mhard-float}).
1110
1111 @cindex Disable single-precision floating-point operations
1112 @kindex @code{.set singlefloat}
1113 @kindex @code{.set doublefloat}
1114 The directives @code{.set singlefloat} and @code{.set doublefloat}
1115 provide finer control of disabling and enabling double-precision
1116 float-point operations.  These directives always override the default
1117 (that double-precision operations are accepted) or the command-line
1118 options (@samp{-msingle-float} and @samp{-mdouble-float}).
1119
1120 Traditional MIPS assemblers do not support these directives.
1121
1122 @node MIPS Syntax
1123 @section Syntactical considerations for the MIPS assembler
1124 @menu
1125 * MIPS-Chars::                Special Characters
1126 @end menu
1127
1128 @node MIPS-Chars
1129 @subsection Special Characters
1130
1131 @cindex line comment character, MIPS
1132 @cindex MIPS line comment character
1133 The presence of a @samp{#} on a line indicates the start of a comment
1134 that extends to the end of the current line.
1135
1136 If a @samp{#} appears as the first character of a line, the whole line
1137 is treated as a comment, but in this case the line can also be a
1138 logical line number directive (@pxref{Comments}) or a
1139 preprocessor control command (@pxref{Preprocessing}).
1140
1141 @cindex line separator, MIPS
1142 @cindex statement separator, MIPS
1143 @cindex MIPS line separator
1144 The @samp{;} character can be used to separate statements on the same
1145 line.