match: Check the number of elements in broadcasting operands
[nasm/avx512.git] / nasm.txt
blob55f9a05bc7511e58ebcbe2bde575693c5e25b9ee
1 nasm(1)
2 =======
3 :doctype:       manpage
4 :man source:    NASM
5 :man manual:    The Netwide Assembler Project
7 NAME
8 ----
9 nasm - the Netwide Assembler, a portable 80x86 assembler
11 SYNOPSIS
12 --------
13 *nasm* [*-@* response file] [*-f* format] [*-o* outfile] [*-l* listfile] ['options'...] filename
15 DESCRIPTION
16 -----------
17 The *nasm* command assembles the file 'filename' and directs output to the file
18 'outfile' if specified. If 'outfile' is not specified, *nasm* will derive a default
19 output file name from the name of its input file, usually by appending `.o' or
20 `.obj', or by removing all extensions for a raw binary file. Failing that, the
21 output file name will be `nasm.out'.
23 OPTIONS
24 -------
25 *-@* 'filename'::
26         Causes *nasm* to process options from filename as if they were included on
27         the command line.
29 *-a*::
30         Causes *nasm* to assemble the given input file without first applying the
31         macro preprocessor.
33 *-D*|*-d* 'macro[=value]'::
34         Pre-defines a single-line macro.
36 *-E*|*-e*::
37         Causes *nasm* to preprocess the given input file, and write the output to
38         'stdout' (or the specified output file name), and not actually assemble
39         anything.
41 *-f* 'format'::
42         Specifies the output file format. To see a list of valid output formats,
43         use the *-hf* option.
45 *-F* 'format'::
46         Specifies the debug information format. To see a list of valid output
47         formats, use the *-y* option (for example *-felf -y*).
49 *-g*::
50         Causes *nasm* to generate debug information in selected format.
52 *-h*::
53         Causes *nasm* to exit immediately, after giving a summary of its
54         invocation options.
56 *-hf*::
57         Same as *-h* , but also lists all valid output formats.
59 *-I*|*-i* 'directory'::
60         Adds a directory to the search path for include files. The directory
61         specification must include the trailing slash, as it will be directly
62         prepended to the name of the include file.
64 *-l* 'listfile'::
65         Causes an assembly listing to be directed to the given file, in which
66         the original source is displayed on the right hand side (plus the source
67         for included files and the expansions of multi-line macros) and the
68         generated code is shown in hex on the left.
70 *-M*::
71         Causes *nasm* to output Makefile-style dependencies to stdout; normal
72         output is suppressed.
74 *-MG* 'file'::
75         Same as *-M* but assumes that missing Makefile dependecies are generated
76         and added to dependency list without a prefix.
78 *-MF* 'file'::
79         Output Makefile-style dependencies to the specified file.
81 *-MD* 'file'::
82         Same as a combination of *-M* and *-MF* options.
84 *-MT* 'file'::
85         Override the default name of the dependency target dependency target name.
86         This is normally the same as the output filename, specified by
87         the *-o* option.
89 *-MQ* 'file'::
90         The same as *-MT* except it tries to quote characters that have special
91         meaning in Makefile syntax. This is not foolproof, as not all characters
92         with special meaning are quotable in Make.
94 *-MP*::
95         Emit phony target.
97 *-O* 'number'::
98         Optimize branch offsets.
99         * *-O0*: No optimization
100         * *-O1*: Minimal optimization
101         * *-Ox*: Multipass optimization (default)
103 *-o* 'outfile'::
104         Specifies a precise name for the output file, overriding *nasm*'s default
105         means of determining it.
107 *-P*|*-p* 'file'::
108         Specifies a file to be pre-included, before the main source file
109         starts to be processed.
111 *-s*::
112         Causes *nasm* to send its error messages and/or help text to stdout
113         instead of stderr.
115 *-t*::
116         Causes *nasm* to assemble in SciTech TASM compatible mode.
118 *-U*|*-u* 'macro'::
119         Undefines a single-line macro.
121 *-v*::
122         Causes *nasm* to exit immediately, after displaying its version number.
124 *-W[no-]foo'::
125         Causes *nasm* to enable or disable certain classes of warning messages,
126         in gcc-like style, for example *-Worphan-labels* or *-Wno-orphan-labels*.
128 *-w*'[+-]foo'::
129         Causes *nasm* to enable or disable certain classes of warning messages,
130         for example *-w+orphan-labels* or *-w-macro-params*.
132 *-X* 'format'::
133         Specifies error reporting format (gnu or vc).
135 *-y*::
136         Causes *nasm* to list supported debug formats.
138 *-Z* 'filename'::
139         Causes *nasm* to redirect error messages to 'filename'. This option exists
140         to support operating systems on which stderr is not easily redirected.
142 --prefix::
143 --postfix::
144         Prepend or append (respectively) the given argument to all global or
145         extern variables.
147 SYNTAX
148 ------
149 This man page does not fully describe the syntax of *nasm*'s assembly language,
150 but does give a summary of the differences from other assemblers.
152 'Registers' have no leading `%' sign, unlike *gas*, and floating-point stack
153 registers are referred to as 'st0', 'st1', and so on.
155 'Floating-point instructions' may use either the single-operand form or the
156 double. A 'TO' keyword is provided; thus, one could either write
158         fadd st0,st1
159         fadd st1,st0
161 or one could use the alternative single-operand forms
163         fadd st1
164         fadd to st1
166 'Uninitialised storage' is reserved using the 'RESB', 'RESW', 'RESD', 'RESQ',
167 'REST' and 'RESO' pseudo-opcodes, each taking one parameter which gives the
168 number of bytes, words, doublewords, quadwords or ten-byte words to reserve.
170 'Repetition' of data items is not done by the 'DUP' keyword as seen in DOS
171 assemblers, but by the use of the 'TIMES' prefix, like this:
173         message: times 3 db 'abc'
174                  times 64-$+message db 0
176 which defines the string `abcabcabc`, followed by the right number of zero
177 bytes to make the total length up to 64 bytes.
179 'Symbol references' are always understood to be immediate (i.e. the address
180 of the symbol), unless square brackets are used, in which case the contents
181 of the memory location are used. Thus:
183         mov ax,wordvar
185 loads AX with the address of the variable `wordvar`, whereas
187         mov ax,[wordvar]
188         mov ax,[wordvar+1]
189         mov ax,[es:wordvar+bx]
191 all refer to the 'contents' of memory locations. The syntaxes
193         mov ax,es:wordvar[bx]
194         es mov ax,wordvar[1]
196 are not legal at all, although the use of a segment register name as an instruction
197 prefix is valid, and can be used with instructions such as 'LODSB' which can't
198 be overridden any other way.
200 'Constants' may be expressed numerically in most formats: a trailing H, Q or
201 B denotes hex, octal or binary respectively, and a leading `0x' or `$' denotes
202 hex as well. Leading zeros are not treated specially at all. Character constants
203 may be enclosed in single or double quotes; there is no escape character. The
204 ordering is little-endian (reversed), so that the character constant ''abcd''
205 denotes 0x64636261 and not 0x61626364.
207 Local labels begin with a period, and their `locality' is granted by the assembler
208 prepending the name of the previous non-local symbol. Thus declaring a label
209 `.loop' after a label `label' has actually defined a symbol called `label.loop'.
211 DIRECTIVES
212 ----------
213 'SECTION' 'name' or 'SEGMENT' 'name' causes *nasm* to direct all following code
214 to the named section. Section names vary with output file format, although most
215 formats support the names '.text', '.data' and '.bss'. (The exception is the
216 'obj' format, in which all segments are user-definable.)
218 'ABSOLUTE' 'address' causes *nasm* to position its notional assembly point at
219 an absolute address: so no code or data may be generated, but you can use 'RESB',
220 'RESW' and 'RESD' to move the assembly point further on, and you can define labels.
221 So this directive may be used to define data structures. When you have finished
222 doing absolute assembly, you must issue another 'SECTION' directive to return to
223 normal assembly.
225 'BITS' '16', 'BITS' '32' or 'BITS' '64' switches the default processor mode for
226 which *nasm* is generating code: it is equivalent to 'USE16' or 'USE32' in DOS
227 assemblers.
229 'EXTERN' 'symbol' and 'GLOBAL' 'symbol' import and export symbol definitions,
230 respectively, from and to other modules. Note that the 'GLOBAL' directive must
231 appear before the definition of the symbol it refers to.
233 'STRUC' 'strucname' and 'ENDSTRUC', when used to bracket a number of 'RESB',
234 'RESW' or similar instructions, define a data structure. In addition to
235 defining the offsets of the structure members, the construct also defines a symbol
236 for the size of the structure, which is simply the structure name with 'size'
237 tacked on to the end.
239 FORMAT-SPECIFIC DIRECTIVES
240 --------------------------
241 'ORG' 'address' is used by the 'bin' flat-form binary output format, and
242 specifies the address at which the output code will eventually be loaded.
244 'GROUP' 'grpname' 'seg1' 'seg2'... is used by the obj (Microsoft 16-bit)
245 output format, and defines segment groups. This format also uses 'UPPERCASE',
246 which directs that all segment, group and symbol names output to the object
247 file should be in uppercase. Note that the actual assembly is still case
248 sensitive.
250 'LIBRARY' 'libname' is used by the 'rdf' output format, and causes a
251 dependency record to be written to the output file which indicates that
252 the program requires a certain library in order to run.
254 MACRO PREPROCESSOR
255 ------------------
256 Single-line macros are defined using the '%define' or '%idefine' commands, in
257 a similar fashion to the C preprocessor. They can be overloaded with respect
258 to number of parameters, although defining a macro with no parameters prevents
259 the definition of any macro with the same name taking parameters, and vice versa.
260 '%define' defines macros whose names match case-sensitively, whereas '%idefine'
261 defines case-insensitive macros.
263 Multi-line macros are defined using '%macro' and '%imacro' (the distinction is the
264 same as that between '%define' and '%idefine'), whose syntax is as follows
266         %macro name minprm[-maxprm][+][.nolist] [defaults]
267                 <some lines of macro expansion text>
268         %endmacro
270 Again, these macros may be overloaded. The trailing plus sign indicates that
271 any parameters after the last one get subsumed, with their separating commas,
272 into the last parameter. The 'defaults' part can be used to specify defaults for
273 unspecified macro parameters after 'minparam'. '%endm' is a valid synonym for
274 '%endmacro'.
276 To refer to the macro parameters within a macro expansion, you use '%1', '%2' and
277 so on. You can also enforce that a macro parameter should contain a condition
278 code by using '%+1', and you can invert the condition code by using '%-1'. You can also
279 define a label specific to a macro invocation by prefixing it with a double `%' sign.
281 Files can be included using the '%include' directive, which works like C.
283 The preprocessor has a `context stack', which may be used by one macro to store
284 information that a later one will retrieve. You can push a context on the stack
285 using '%push', remove one using '%pop', and change the name of the top context (without
286 disturbing any associated definitions) using '%repl'. Labels and '%define' macros
287 specific to the top context may be defined by prefixing their names with %$,
288 and things specific to the next context down with %$$, and so on.
290 Conditional assembly is done by means of '%ifdef', '%ifndef', '%else' and '%endif'
291 as in C. (Except that '%ifdef' can accept several putative macro names, and
292 will evaluate TRUE if any of them is defined.) In addition, the directives
293 '%ifctx' and '%ifnctx' can be used to condition on the name of the top context
294 on the context stack. The obvious set of `else-if' directives, '%elifdef',
295 '%elifndef', '%elifctx' and '%elifnctx' are also supported.
297 BUGS
298 ----
299 Please report bugs through the bug tracker function at http://nasm.us.
301 SEE ALSO
302 --------
303 *as*(1), *ld*(1).