doc: better description of %line
[nasm/perl-rewrite.git] / doc / nasmdoc.src
blob22fcc7c31a5582203928f5882d8295478eac58cd
1 \#
2 \# Source code to NASM documentation
3 \#
4 \M{category}{Programming}
5 \M{title}{NASM - The Netwide Assembler}
6 \M{year}{2008}
7 \M{author}{The NASM Development Team}
8 \M{license}{All rights reserved. This document is redistributable under the license given in the file "COPYING" distributed in the NASM archive.}
9 \M{summary}{This file documents NASM, the Netwide Assembler: an assembler targetting the Intel x86 series of processors, with portable source.}
10 \M{infoname}{NASM}
11 \M{infofile}{nasm}
12 \M{infotitle}{The Netwide Assembler for x86}
13 \M{epslogo}{nasmlogo.eps}
14 \IR{-D} \c{-D} option
15 \IR{-E} \c{-E} option
16 \IR{-F} \c{-F} option
17 \IR{-I} \c{-I} option
18 \IR{-M} \c{-M} option
19 \IR{-MD} \c{-MD} option
20 \IR{-MF} \c{-MF} option
21 \IR{-MG} \c{-MG} option
22 \IR{-MP} \c{-MP} option
23 \IR{-MQ} \c{-MQ} option
24 \IR{-MT} \c{-MT} option
25 \IR{-O} \c{-O} option
26 \IR{-P} \c{-P} option
27 \IR{-U} \c{-U} option
28 \IR{-X} \c{-X} option
29 \IR{-a} \c{-a} option
30 \IR{-d} \c{-d} option
31 \IR{-e} \c{-e} option
32 \IR{-f} \c{-f} option
33 \IR{-g} \c{-g} option
34 \IR{-i} \c{-i} option
35 \IR{-l} \c{-l} option
36 \IR{-o} \c{-o} option
37 \IR{-p} \c{-p} option
38 \IR{-s} \c{-s} option
39 \IR{-u} \c{-u} option
40 \IR{-v} \c{-v} option
41 \IR{-W} \c{-W} option
42 \IR{-w} \c{-w} option
43 \IR{-y} \c{-y} option
44 \IR{-Z} \c{-Z} option
45 \IR{!=} \c{!=} operator
46 \IR{$, here} \c{$}, Here token
47 \IR{$, prefix} \c{$}, prefix
48 \IR{$$} \c{$$} token
49 \IR{%} \c{%} operator
50 \IR{%%} \c{%%} operator
51 \IR{%+1} \c{%+1} and \c{%-1} syntax
52 \IA{%-1}{%+1}
53 \IR{%0} \c{%0} parameter count
54 \IR{&} \c{&} operator
55 \IR{&&} \c{&&} operator
56 \IR{*} \c{*} operator
57 \IR{..@} \c{..@} symbol prefix
58 \IR{/} \c{/} operator
59 \IR{//} \c{//} operator
60 \IR{<} \c{<} operator
61 \IR{<<} \c{<<} operator
62 \IR{<=} \c{<=} operator
63 \IR{<>} \c{<>} operator
64 \IR{=} \c{=} operator
65 \IR{==} \c{==} operator
66 \IR{>} \c{>} operator
67 \IR{>=} \c{>=} operator
68 \IR{>>} \c{>>} operator
69 \IR{?} \c{?} MASM syntax
70 \IR{^} \c{^} operator
71 \IR{^^} \c{^^} operator
72 \IR{|} \c{|} operator
73 \IR{||} \c{||} operator
74 \IR{~} \c{~} operator
75 \IR{%$} \c{%$} and \c{%$$} prefixes
76 \IA{%$$}{%$}
77 \IR{+ opaddition} \c{+} operator, binary
78 \IR{+ opunary} \c{+} operator, unary
79 \IR{+ modifier} \c{+} modifier
80 \IR{- opsubtraction} \c{-} operator, binary
81 \IR{- opunary} \c{-} operator, unary
82 \IR{! opunary} \c{!} operator, unary
83 \IR{alignment, in bin sections} alignment, in \c{bin} sections
84 \IR{alignment, in elf sections} alignment, in \c{elf} sections
85 \IR{alignment, in win32 sections} alignment, in \c{win32} sections
86 \IR{alignment, of elf common variables} alignment, of \c{elf} common
87 variables
88 \IR{alignment, in obj sections} alignment, in \c{obj} sections
89 \IR{a.out, bsd version} \c{a.out}, BSD version
90 \IR{a.out, linux version} \c{a.out}, Linux version
91 \IR{autoconf} Autoconf
92 \IR{bin} bin
93 \IR{bitwise and} bitwise AND
94 \IR{bitwise or} bitwise OR
95 \IR{bitwise xor} bitwise XOR
96 \IR{block ifs} block IFs
97 \IR{borland pascal} Borland, Pascal
98 \IR{borland's win32 compilers} Borland, Win32 compilers
99 \IR{braces, after % sign} braces, after \c{%} sign
100 \IR{bsd} BSD
101 \IR{c calling convention} C calling convention
102 \IR{c symbol names} C symbol names
103 \IA{critical expressions}{critical expression}
104 \IA{command line}{command-line}
105 \IA{case sensitivity}{case sensitive}
106 \IA{case-sensitive}{case sensitive}
107 \IA{case-insensitive}{case sensitive}
108 \IA{character constants}{character constant}
109 \IR{common object file format} Common Object File Format
110 \IR{common variables, alignment in elf} common variables, alignment
111 in \c{elf}
112 \IR{common, elf extensions to} \c{COMMON}, \c{elf} extensions to
113 \IR{common, obj extensions to} \c{COMMON}, \c{obj} extensions to
114 \IR{declaring structure} declaring structures
115 \IR{default-wrt mechanism} default-\c{WRT} mechanism
116 \IR{devpac} DevPac
117 \IR{djgpp} DJGPP
118 \IR{dll symbols, exporting} DLL symbols, exporting
119 \IR{dll symbols, importing} DLL symbols, importing
120 \IR{dos} DOS
121 \IR{dos archive} DOS archive
122 \IR{dos source archive} DOS source archive
123 \IA{effective address}{effective addresses}
124 \IA{effective-address}{effective addresses}
125 \IR{elf} ELF
126 \IR{elf, 16-bit code and} ELF, 16-bit code and
127 \IR{elf shared libraries} ELF, shared libraries
128 \IR{executable and linkable format} Executable and Linkable Format
129 \IR{extern, obj extensions to} \c{EXTERN}, \c{obj} extensions to
130 \IR{extern, rdf extensions to} \c{EXTERN}, \c{rdf} extensions to
131 \IR{floating-point, constants} floating-point, constants
132 \IR{floating-point, packed bcd constants} floating-point, packed BCD constants
133 \IR{freebsd} FreeBSD
134 \IR{freelink} FreeLink
135 \IR{functions, c calling convention} functions, C calling convention
136 \IR{functions, pascal calling convention} functions, Pascal calling
137 convention
138 \IR{global, aoutb extensions to} \c{GLOBAL}, \c{aoutb} extensions to
139 \IR{global, elf extensions to} \c{GLOBAL}, \c{elf} extensions to
140 \IR{global, rdf extensions to} \c{GLOBAL}, \c{rdf} extensions to
141 \IR{got} GOT
142 \IR{got relocations} \c{GOT} relocations
143 \IR{gotoff relocation} \c{GOTOFF} relocations
144 \IR{gotpc relocation} \c{GOTPC} relocations
145 \IR{intel number formats} Intel number formats
146 \IR{linux, elf} Linux, ELF
147 \IR{linux, a.out} Linux, \c{a.out}
148 \IR{linux, as86} Linux, \c{as86}
149 \IR{logical and} logical AND
150 \IR{logical or} logical OR
151 \IR{logical xor} logical XOR
152 \IR{masm} MASM
153 \IA{memory reference}{memory references}
154 \IR{minix} Minix
155 \IA{misc directory}{misc subdirectory}
156 \IR{misc subdirectory} \c{misc} subdirectory
157 \IR{microsoft omf} Microsoft OMF
158 \IR{mmx registers} MMX registers
159 \IA{modr/m}{modr/m byte}
160 \IR{modr/m byte} ModR/M byte
161 \IR{ms-dos} MS-DOS
162 \IR{ms-dos device drivers} MS-DOS device drivers
163 \IR{multipush} \c{multipush} macro
164 \IR{nan} NaN
165 \IR{nasm version} NASM version
166 \IR{netbsd} NetBSD
167 \IR{omf} OMF
168 \IR{openbsd} OpenBSD
169 \IR{operating system} operating system
170 \IR{os/2} OS/2
171 \IR{pascal calling convention}Pascal calling convention
172 \IR{passes} passes, assembly
173 \IR{perl} Perl
174 \IR{pic} PIC
175 \IR{pharlap} PharLap
176 \IR{plt} PLT
177 \IR{plt} \c{PLT} relocations
178 \IA{pre-defining macros}{pre-define}
179 \IA{preprocessor expressions}{preprocessor, expressions}
180 \IA{preprocessor loops}{preprocessor, loops}
181 \IA{preprocessor variables}{preprocessor, variables}
182 \IA{rdoff subdirectory}{rdoff}
183 \IR{rdoff} \c{rdoff} subdirectory
184 \IR{relocatable dynamic object file format} Relocatable Dynamic
185 Object File Format
186 \IR{relocations, pic-specific} relocations, PIC-specific
187 \IA{repeating}{repeating code}
188 \IR{section alignment, in elf} section alignment, in \c{elf}
189 \IR{section alignment, in bin} section alignment, in \c{bin}
190 \IR{section alignment, in obj} section alignment, in \c{obj}
191 \IR{section alignment, in win32} section alignment, in \c{win32}
192 \IR{section, elf extensions to} \c{SECTION}, \c{elf} extensions to
193 \IR{section, win32 extensions to} \c{SECTION}, \c{win32} extensions to
194 \IR{segment alignment, in bin} segment alignment, in \c{bin}
195 \IR{segment alignment, in obj} segment alignment, in \c{obj}
196 \IR{segment, obj extensions to} \c{SEGMENT}, \c{elf} extensions to
197 \IR{segment names, borland pascal} segment names, Borland Pascal
198 \IR{shift command} \c{shift} command
199 \IA{sib}{sib byte}
200 \IR{sib byte} SIB byte
201 \IR{align, smart} \c{ALIGN}, smart
202 \IR{solaris x86} Solaris x86
203 \IA{standard section names}{standardized section names}
204 \IR{symbols, exporting from dlls} symbols, exporting from DLLs
205 \IR{symbols, importing from dlls} symbols, importing from DLLs
206 \IR{test subdirectory} \c{test} subdirectory
207 \IR{tlink} \c{TLINK}
208 \IR{underscore, in c symbols} underscore, in C symbols
209 \IR{unicode} Unicode
210 \IR{unix} Unix
211 \IR{utf-8} UTF-8
212 \IR{utf-16} UTF-16
213 \IR{utf-32} UTF-32
214 \IA{sco unix}{unix, sco}
215 \IR{unix, sco} Unix, SCO
216 \IA{unix source archive}{unix, source archive}
217 \IR{unix, source archive} Unix, source archive
218 \IA{unix system v}{unix, system v}
219 \IR{unix, system v} Unix, System V
220 \IR{unixware} UnixWare
221 \IR{val} VAL
222 \IR{version number of nasm} version number of NASM
223 \IR{visual c++} Visual C++
224 \IR{www page} WWW page
225 \IR{win32} Win32
226 \IR{win32} Win64
227 \IR{windows} Windows
228 \IR{windows 95} Windows 95
229 \IR{windows nt} Windows NT
230 \# \IC{program entry point}{entry point, program}
231 \# \IC{program entry point}{start point, program}
232 \# \IC{MS-DOS device drivers}{device drivers, MS-DOS}
233 \# \IC{16-bit mode, versus 32-bit mode}{32-bit mode, versus 16-bit mode}
234 \# \IC{c symbol names}{symbol names, in C}
237 \C{intro} Introduction
239 \H{whatsnasm} What Is NASM?
241 The Netwide Assembler, NASM, is an 80x86 and x86-64 assembler designed
242 for portability and modularity. It supports a range of object file
243 formats, including Linux and \c{*BSD} \c{a.out}, \c{ELF}, \c{COFF},
244 \c{Mach-O}, Microsoft 16-bit \c{OBJ}, \c{Win32} and \c{Win64}. It will
245 also output plain binary files. Its syntax is designed to be simple
246 and easy to understand, similar to Intel's but less complex. It
247 supports all currently known x86 architectural extensions, and has
248 strong support for macros.
251 \S{yaasm} Why Yet Another Assembler?
253 The Netwide Assembler grew out of an idea on \i\c{comp.lang.asm.x86}
254 (or possibly \i\c{alt.lang.asm} - I forget which), which was
255 essentially that there didn't seem to be a good \e{free} x86-series
256 assembler around, and that maybe someone ought to write one.
258 \b \i\c{a86} is good, but not free, and in particular you don't get any
259 32-bit capability until you pay. It's DOS only, too.
261 \b \i\c{gas} is free, and ports over to DOS and Unix, but it's not
262 very good, since it's designed to be a back end to \i\c{gcc}, which
263 always feeds it correct code. So its error checking is minimal. Also,
264 its syntax is horrible, from the point of view of anyone trying to
265 actually \e{write} anything in it. Plus you can't write 16-bit code in
266 it (properly.)
268 \b \i\c{as86} is specific to Minix and Linux, and (my version at least)
269 doesn't seem to have much (or any) documentation.
271 \b \i\c{MASM} isn't very good, and it's (was) expensive, and it runs only under
272 DOS.
274 \b \i\c{TASM} is better, but still strives for MASM compatibility,
275 which means millions of directives and tons of red tape. And its syntax
276 is essentially MASM's, with the contradictions and quirks that
277 entails (although it sorts out some of those by means of Ideal mode.)
278 It's expensive too. And it's DOS-only.
280 So here, for your coding pleasure, is NASM. At present it's
281 still in prototype stage - we don't promise that it can outperform
282 any of these assemblers. But please, \e{please} send us bug reports,
283 fixes, helpful information, and anything else you can get your hands
284 on (and thanks to the many people who've done this already! You all
285 know who you are), and we'll improve it out of all recognition.
286 Again.
289 \S{legal} License Conditions
291 Please see the file \c{COPYING}, supplied as part of any NASM
292 distribution archive, for the \i{license} conditions under which you
293 may use NASM.  NASM is now under the so-called GNU Lesser General
294 Public License, LGPL.
297 \H{contact} Contact Information
299 The current version of NASM (since about 0.98.08) is maintained by a
300 team of developers, accessible through the \c{nasm-devel} mailing list
301 (see below for the link).
302 If you want to report a bug, please read \k{bugs} first.
304 NASM has a \i{WWW page} at
305 \W{http://nasm.sourceforge.net}\c{http://nasm.sourceforge.net}. If it's
306 not there, google for us!
309 The original authors are \i{e\-mail}able as
310 \W{mailto:jules@dsf.org.uk}\c{jules@dsf.org.uk} and
311 \W{mailto:anakin@pobox.com}\c{anakin@pobox.com}.
312 The latter is no longer involved in the development team.
314 \i{New releases} of NASM are uploaded to the official sites
315 \W{http://nasm.sourceforge.net}\c{http://nasm.sourceforge.net}
316 and to
317 \W{ftp://ftp.kernel.org/pub/software/devel/nasm/}\i\c{ftp.kernel.org}
319 \W{ftp://ibiblio.org/pub/Linux/devel/lang/assemblers/}\i\c{ibiblio.org}.
321 Announcements are posted to
322 \W{news:comp.lang.asm.x86}\i\c{comp.lang.asm.x86},
323 \W{news:alt.lang.asm}\i\c{alt.lang.asm} and
324 \W{news:comp.os.linux.announce}\i\c{comp.os.linux.announce}
326 If you want information about NASM beta releases, and the current
327 development status, please subscribe to the \i\c{nasm-devel} email list
328 by registering at
329 \W{http://sourceforge.net/projects/nasm}\c{http://sourceforge.net/projects/nasm}.
332 \H{install} Installation
334 \S{instdos} \i{Installing} NASM under MS-\i{DOS} or Windows
336 Once you've obtained the appropriate archive for NASM,
337 \i\c{nasm-XXX-dos.zip} or \i\c{nasm-XXX-win32.zip} (where \c{XXX}
338 denotes the version number of NASM contained in the archive), unpack
339 it into its own directory (for example \c{c:\\nasm}).
341 The archive will contain a set of executable files: the NASM
342 executable file \i\c{nasm.exe}, the NDISASM executable file
343 \i\c{ndisasm.exe}, and possibly additional utilities to handle the
344 RDOFF file format.
346 The only file NASM needs to run is its own executable, so copy
347 \c{nasm.exe} to a directory on your PATH, or alternatively edit
348 \i\c{autoexec.bat} to add the \c{nasm} directory to your
349 \i\c{PATH} (to do that under Windows XP, go to Start > Control Panel >
350 System > Advanced > Environment Variables; these instructions may work
351 under other versions of Windows as well.)
353 That's it - NASM is installed. You don't need the nasm directory
354 to be present to run NASM (unless you've added it to your \c{PATH}),
355 so you can delete it if you need to save space; however, you may
356 want to keep the documentation or test programs.
358 If you've downloaded the \i{DOS source archive}, \i\c{nasm-XXX.zip},
359 the \c{nasm} directory will also contain the full NASM \i{source
360 code}, and a selection of \i{Makefiles} you can (hopefully) use to
361 rebuild your copy of NASM from scratch.  See the file \c{INSTALL} in
362 the source archive.
364 Note that a number of files are generated from other files by Perl
365 scripts.  Although the NASM source distribution includes these
366 generated files, you will need to rebuild them (and hence, will need a
367 Perl interpreter) if you change insns.dat, standard.mac or the
368 documentation. It is possible future source distributions may not
369 include these files at all. Ports of \i{Perl} for a variety of
370 platforms, including DOS and Windows, are available from
371 \W{http://www.cpan.org/ports/}\i{www.cpan.org}.
374 \S{instdos} Installing NASM under \i{Unix}
376 Once you've obtained the \i{Unix source archive} for NASM,
377 \i\c{nasm-XXX.tar.gz} (where \c{XXX} denotes the version number of
378 NASM contained in the archive), unpack it into a directory such
379 as \c{/usr/local/src}. The archive, when unpacked, will create its
380 own subdirectory \c{nasm-XXX}.
382 NASM is an \I{Autoconf}\I\c{configure}auto-configuring package: once
383 you've unpacked it, \c{cd} to the directory it's been unpacked into
384 and type \c{./configure}. This shell script will find the best C
385 compiler to use for building NASM and set up \i{Makefiles}
386 accordingly.
388 Once NASM has auto-configured, you can type \i\c{make} to build the
389 \c{nasm} and \c{ndisasm} binaries, and then \c{make install} to
390 install them in \c{/usr/local/bin} and install the \i{man pages}
391 \i\c{nasm.1} and \i\c{ndisasm.1} in \c{/usr/local/man/man1}.
392 Alternatively, you can give options such as \c{--prefix} to the
393 configure script (see the file \i\c{INSTALL} for more details), or
394 install the programs yourself.
396 NASM also comes with a set of utilities for handling the \c{RDOFF}
397 custom object-file format, which are in the \i\c{rdoff} subdirectory
398 of the NASM archive. You can build these with \c{make rdf} and
399 install them with \c{make rdf_install}, if you want them.
402 \C{running} Running NASM
404 \H{syntax} NASM \i{Command-Line} Syntax
406 To assemble a file, you issue a command of the form
408 \c nasm -f <format> <filename> [-o <output>]
410 For example,
412 \c nasm -f elf myfile.asm
414 will assemble \c{myfile.asm} into an \c{ELF} object file \c{myfile.o}. And
416 \c nasm -f bin myfile.asm -o myfile.com
418 will assemble \c{myfile.asm} into a raw binary file \c{myfile.com}.
420 To produce a listing file, with the hex codes output from NASM
421 displayed on the left of the original sources, use the \c{-l} option
422 to give a listing file name, for example:
424 \c nasm -f coff myfile.asm -l myfile.lst
426 To get further usage instructions from NASM, try typing
428 \c nasm -h
430 As \c{-hf}, this will also list the available output file formats, and what they
431 are.
433 If you use Linux but aren't sure whether your system is \c{a.out}
434 or \c{ELF}, type
436 \c file nasm
438 (in the directory in which you put the NASM binary when you
439 installed it). If it says something like
441 \c nasm: ELF 32-bit LSB executable i386 (386 and up) Version 1
443 then your system is \c{ELF}, and you should use the option \c{-f elf}
444 when you want NASM to produce Linux object files. If it says
446 \c nasm: Linux/i386 demand-paged executable (QMAGIC)
448 or something similar, your system is \c{a.out}, and you should use
449 \c{-f aout} instead (Linux \c{a.out} systems have long been obsolete,
450 and are rare these days.)
452 Like Unix compilers and assemblers, NASM is silent unless it
453 goes wrong: you won't see any output at all, unless it gives error
454 messages.
457 \S{opt-o} The \i\c{-o} Option: Specifying the Output File Name
459 NASM will normally choose the name of your output file for you;
460 precisely how it does this is dependent on the object file format.
461 For Microsoft object file formats (\i\c{obj} and \i\c{win32}), it
462 will remove the \c{.asm} \i{extension} (or whatever extension you
463 like to use - NASM doesn't care) from your source file name and
464 substitute \c{.obj}. For Unix object file formats (\i\c{aout},
465 \i\c{coff}, \i\c{elf}, \i\c{macho} and \i\c{as86}) it will substitute \c{.o}. For
466 \i\c{rdf}, it will use \c{.rdf}, and for the \i\c{bin} format it
467 will simply remove the extension, so that \c{myfile.asm} produces
468 the output file \c{myfile}.
470 If the output file already exists, NASM will overwrite it, unless it
471 has the same name as the input file, in which case it will give a
472 warning and use \i\c{nasm.out} as the output file name instead.
474 For situations in which this behaviour is unacceptable, NASM
475 provides the \c{-o} command-line option, which allows you to specify
476 your desired output file name. You invoke \c{-o} by following it
477 with the name you wish for the output file, either with or without
478 an intervening space. For example:
480 \c nasm -f bin program.asm -o program.com
481 \c nasm -f bin driver.asm -odriver.sys
483 Note that this is a small o, and is different from a capital O , which
484 is used to specify the number of optimisation passes required. See \k{opt-O}.
487 \S{opt-f} The \i\c{-f} Option: Specifying the \i{Output File Format}
489 If you do not supply the \c{-f} option to NASM, it will choose an
490 output file format for you itself. In the distribution versions of
491 NASM, the default is always \i\c{bin}; if you've compiled your own
492 copy of NASM, you can redefine \i\c{OF_DEFAULT} at compile time and
493 choose what you want the default to be.
495 Like \c{-o}, the intervening space between \c{-f} and the output
496 file format is optional; so \c{-f elf} and \c{-felf} are both valid.
498 A complete list of the available output file formats can be given by
499 issuing the command \i\c{nasm -hf}.
502 \S{opt-l} The \i\c{-l} Option: Generating a \i{Listing File}
504 If you supply the \c{-l} option to NASM, followed (with the usual
505 optional space) by a file name, NASM will generate a
506 \i{source-listing file} for you, in which addresses and generated
507 code are listed on the left, and the actual source code, with
508 expansions of multi-line macros (except those which specifically
509 request no expansion in source listings: see \k{nolist}) on the
510 right. For example:
512 \c nasm -f elf myfile.asm -l myfile.lst
514 If a list file is selected, you may turn off listing for a 
515 section of your source with \c{[list -]}, and turn it back on
516 with \c{[list +]}, (the default, obviously). There is no "user 
517 form" (without the brackets). This can be used to list only 
518 sections of interest, avoiding excessively long listings.
521 \S{opt-M} The \i\c{-M} Option: Generate \i{Makefile Dependencies}
523 This option can be used to generate makefile dependencies on stdout.
524 This can be redirected to a file for further processing. For example:
526 \c nasm -M myfile.asm > myfile.dep
529 \S{opt-MG} The \i\c{-MG} Option: Generate \i{Makefile Dependencies}
531 This option can be used to generate makefile dependencies on stdout.
532 This differs from the \c{-M} option in that if a nonexisting file is
533 encountered, it is assumed to be a generated file and is added to the
534 dependency list without a prefix.
537 \S{opt-MF} The \i\c\{-MF} Option: Set Makefile Dependency File
539 This option can be used with the \c{-M} or \c{-MG} options to send the
540 output to a file, rather than to stdout.  For example:
542 \c nasm -M -MF myfile.dep myfile.asm
545 \S{opt-MD} The \i\c{-MD} Option: Assemble and Generate Dependencies
547 The \c{-MD} option acts as the combination of the \c{-M} and \c{-MF}
548 options (i.e. a filename has to be specified.)  However, unlike the
549 \c{-M} or \c{-MG} options, \c{-MD} does \e{not} inhibit the normal
550 operation of the assembler.  Use this to automatically generate
551 updated dependencies with every assembly session.  For example:
553 \c nasm -f elf -o myfile.o -MD myfile.dep myfile.asm
556 \S{opt-MT} The \i\c{-MT} Option: Dependency Target Name
558 The \c{-MT} option can be used to override the default name of the
559 dependency target.  This is normally the same as the output filename,
560 specified by the \c{-o} option.
563 \S{opt-MQ} The \i\c{-MQ} Option: Dependency Target Name (Quoted)
565 The \c{-MQ} option acts as the \c{-MT} option, except it tries to
566 quote characters that have special meaning in Makefile syntax.  This
567 is not foolproof, as not all characters with special meaning are
568 quotable in Make.
571 \S{opt-MP} The \i\c{-MP} Option: Emit phony targets
573 When used with any of the dependency generation options, the \c{-MP}
574 option causes NASM to emit a phony target without dependencies for
575 each header file.  This prevents Make from complaining if a header
576 file has been removed.
579 \S{opt-F} The \i\c{-F} Option: Selecting a \i{Debug Information Format}
581 This option is used to select the format of the debug information
582 emitted into the output file, to be used by a debugger (or \e{will}
583 be). Prior to version 2.03.01, the use of this switch did \e{not} enable
584 output of the selected debug info format.  Use \c{-g}, see \k{opt-g},
585 to enable output.  Versions 2.03.01 and later automatically enable \c{-g}
586 if \c{-F} is specified.
588 A complete list of the available debug file formats for an output
589 format can be seen by issuing the command \c{nasm -f <format> -y}.  Not
590 all output formats currently support debugging output.  See \k{opt-y}.
592 This should not be confused with the \c{-f dbg} output format option which 
593 is not built into NASM by default. For information on how
594 to enable it when building from the sources, see \k{dbgfmt}.
597 \S{opt-g} The \i\c{-g} Option: Enabling \i{Debug Information}.
599 This option can be used to generate debugging information in the specified
600 format. See \k{opt-F}. Using \c{-g} without \c{-F} results in emitting 
601 debug info in the default format, if any, for the selected output format.
602 If no debug information is currently implemented in the selected output 
603 format, \c{-g} is \e{silently ignored}.
606 \S{opt-X} The \i\c{-X} Option: Selecting an \i{Error Reporting Format}
608 This option can be used to select an error reporting format for any 
609 error messages that might be produced by NASM.
611 Currently, two error reporting formats may be selected.  They are
612 the \c{-Xvc} option and the \c{-Xgnu} option.  The GNU format is 
613 the default and looks like this:
615 \c filename.asm:65: error: specific error message 
617 where \c{filename.asm} is the name of the source file in which the
618 error was detected, \c{65} is the source file line number on which 
619 the error was detected, \c{error} is the severity of the error (this
620 could be \c{warning}), and \c{specific error message} is a more
621 detailed text message which should help pinpoint the exact problem.
623 The other format, specified by \c{-Xvc} is the style used by Microsoft
624 Visual C++ and some other programs.  It looks like this:
626 \c filename.asm(65) : error: specific error message
628 where the only difference is that the line number is in parentheses
629 instead of being delimited by colons.  
631 See also the \c{Visual C++} output format, \k{win32fmt}.
633 \S{opt-Z} The \i\c{-Z} Option: Send Errors to a File
635 Under \I{DOS}\c{MS-DOS} it can be difficult (though there are ways) to
636 redirect the standard-error output of a program to a file. Since
637 NASM usually produces its warning and \i{error messages} on
638 \i\c{stderr}, this can make it hard to capture the errors if (for
639 example) you want to load them into an editor.
641 NASM therefore provides the \c{-Z} option, taking a filename argument
642 which causes errors to be sent to the specified files rather than
643 standard error. Therefore you can \I{redirecting errors}redirect
644 the errors into a file by typing
646 \c nasm -Z myfile.err -f obj myfile.asm
648 In earlier versions of NASM, this option was called \c{-E}, but it was
649 changed since \c{-E} is an option conventionally used for
650 preprocessing only, with disastrous results.  See \k{opt-E}.
652 \S{opt-s} The \i\c{-s} Option: Send Errors to \i\c{stdout}
654 The \c{-s} option redirects \i{error messages} to \c{stdout} rather
655 than \c{stderr}, so it can be redirected under \I{DOS}\c{MS-DOS}. To
656 assemble the file \c{myfile.asm} and pipe its output to the \c{more}
657 program, you can type:
659 \c nasm -s -f obj myfile.asm | more
661 See also the \c{-Z} option, \k{opt-Z}.
664 \S{opt-i} The \i\c{-i}\I\c{-I} Option: Include File Search Directories
666 When NASM sees the \i\c{%include} or \i\c{%pathsearch} directive in a
667 source file (see \k{include}, \k{pathsearch} or \k{incbin}), it will
668 search for the given file not only in the current directory, but also
669 in any directories specified on the command line by the use of the
670 \c{-i} option. Therefore you can include files from a \i{macro
671 library}, for example, by typing
673 \c nasm -ic:\macrolib\ -f obj myfile.asm
675 (As usual, a space between \c{-i} and the path name is allowed, and
676 optional).
678 NASM, in the interests of complete source-code portability, does not
679 understand the file naming conventions of the OS it is running on;
680 the string you provide as an argument to the \c{-i} option will be
681 prepended exactly as written to the name of the include file.
682 Therefore the trailing backslash in the above example is necessary.
683 Under Unix, a trailing forward slash is similarly necessary.
685 (You can use this to your advantage, if you're really \i{perverse},
686 by noting that the option \c{-ifoo} will cause \c{%include "bar.i"}
687 to search for the file \c{foobar.i}...)
689 If you want to define a \e{standard} \i{include search path},
690 similar to \c{/usr/include} on Unix systems, you should place one or
691 more \c{-i} directives in the \c{NASMENV} environment variable (see
692 \k{nasmenv}).
694 For Makefile compatibility with many C compilers, this option can also
695 be specified as \c{-I}.
698 \S{opt-p} The \i\c{-p}\I\c{-P} Option: \I{pre-including files}Pre-Include a File
700 \I\c{%include}NASM allows you to specify files to be
701 \e{pre-included} into your source file, by the use of the \c{-p}
702 option. So running
704 \c nasm myfile.asm -p myinc.inc
706 is equivalent to running \c{nasm myfile.asm} and placing the
707 directive \c{%include "myinc.inc"} at the start of the file.
709 For consistency with the \c{-I}, \c{-D} and \c{-U} options, this
710 option can also be specified as \c{-P}.
713 \S{opt-d} The \i\c{-d}\I\c{-D} Option: \I{pre-defining macros}Pre-Define a Macro
715 \I\c{%define}Just as the \c{-p} option gives an alternative to placing
716 \c{%include} directives at the start of a source file, the \c{-d}
717 option gives an alternative to placing a \c{%define} directive. You
718 could code
720 \c nasm myfile.asm -dFOO=100
722 as an alternative to placing the directive
724 \c %define FOO 100
726 at the start of the file. You can miss off the macro value, as well:
727 the option \c{-dFOO} is equivalent to coding \c{%define FOO}. This
728 form of the directive may be useful for selecting \i{assembly-time
729 options} which are then tested using \c{%ifdef}, for example
730 \c{-dDEBUG}.
732 For Makefile compatibility with many C compilers, this option can also
733 be specified as \c{-D}.
736 \S{opt-u} The \i\c{-u}\I\c{-U} Option: \I{Undefining macros}Undefine a Macro
738 \I\c{%undef}The \c{-u} option undefines a macro that would otherwise
739 have been pre-defined, either automatically or by a \c{-p} or \c{-d}
740 option specified earlier on the command lines.
742 For example, the following command line:
744 \c nasm myfile.asm -dFOO=100 -uFOO
746 would result in \c{FOO} \e{not} being a predefined macro in the
747 program. This is useful to override options specified at a different
748 point in a Makefile.
750 For Makefile compatibility with many C compilers, this option can also
751 be specified as \c{-U}.
754 \S{opt-E} The \i\c{-E}\I{-e} Option: Preprocess Only
756 NASM allows the \i{preprocessor} to be run on its own, up to a
757 point. Using the \c{-E} option (which requires no arguments) will
758 cause NASM to preprocess its input file, expand all the macro
759 references, remove all the comments and preprocessor directives, and
760 print the resulting file on standard output (or save it to a file,
761 if the \c{-o} option is also used).
763 This option cannot be applied to programs which require the
764 preprocessor to evaluate \I{preprocessor expressions}\i{expressions}
765 which depend on the values of symbols: so code such as
767 \c %assign tablesize ($-tablestart)
769 will cause an error in \i{preprocess-only mode}.
771 For compatiblity with older version of NASM, this option can also be
772 written \c{-e}.  \c{-E} in older versions of NASM was the equivalent
773 of the current \c{-Z} option, \k{opt-Z}.
775 \S{opt-a} The \i\c{-a} Option: Don't Preprocess At All
777 If NASM is being used as the back end to a compiler, it might be
778 desirable to \I{suppressing preprocessing}suppress preprocessing
779 completely and assume the compiler has already done it, to save time
780 and increase compilation speeds. The \c{-a} option, requiring no
781 argument, instructs NASM to replace its powerful \i{preprocessor}
782 with a \i{stub preprocessor} which does nothing.
785 \S{opt-O} The \i\c{-O} Option: Specifying \i{Multipass Optimization}
787 NASM defaults to not optimizing operands which can fit into a signed byte.
788 This means that if you want the shortest possible object code,
789 you have to enable optimization.
791 Using the \c{-O} option, you can tell NASM to carry out different
792 levels of optimization.  The syntax is:
794 \b \c{-O0}: No optimization. All operands take their long forms,
795         if a short form is not specified, except conditional jumps.
796         This is intended to match NASM 0.98 behavior.
798 \b \c{-O1}: Minimal optimization. As above, but immediate operands
799         which will fit in a signed byte are optimized,
800         unless the long form is specified.  Conditional jumps default
801         to the long form unless otherwise specified.
803 \b \c{-Ox} (where \c{x} is the actual letter \c{x}): Multipass optimization.
804         Minimize branch offsets and signed immediate bytes,
805         overriding size specification unless the \c{strict} keyword
806         has been used (see \k{strict}).  For compatability with earlier
807         releases, the letter \c{x} may also be any number greater than
808         one. This number has no effect on the actual number of passes.
810 The \c{-Ox} mode is recommended for most uses.
812 Note that this is a capital \c{O}, and is different from a small \c{o}, which
813 is used to specify the output file name. See \k{opt-o}.
816 \S{opt-t} The \i\c{-t} Option: Enable TASM Compatibility Mode
818 NASM includes a limited form of compatibility with Borland's \i\c{TASM}.
819 When NASM's \c{-t} option is used, the following changes are made:
821 \b local labels may be prefixed with \c{@@} instead of \c{.}
823 \b size override is supported within brackets. In TASM compatible mode,
824 a size override inside square brackets changes the size of the operand,
825 and not the address type of the operand as it does in NASM syntax. E.g.
826 \c{mov eax,[DWORD val]} is valid syntax in TASM compatibility mode.
827 Note that you lose the ability to override the default address type for
828 the instruction.
830 \b unprefixed forms of some directives supported (\c{arg}, \c{elif},
831 \c{else}, \c{endif}, \c{if}, \c{ifdef}, \c{ifdifi}, \c{ifndef},
832 \c{include}, \c{local})
834 \S{opt-w} The \i\c{-w} and \i\c{-W} Options: Enable or Disable Assembly \i{Warnings}
836 NASM can observe many conditions during the course of assembly which
837 are worth mentioning to the user, but not a sufficiently severe
838 error to justify NASM refusing to generate an output file. These
839 conditions are reported like errors, but come up with the word
840 `warning' before the message. Warnings do not prevent NASM from
841 generating an output file and returning a success status to the
842 operating system.
844 Some conditions are even less severe than that: they are only
845 sometimes worth mentioning to the user. Therefore NASM supports the
846 \c{-w} command-line option, which enables or disables certain
847 classes of assembly warning. Such warning classes are described by a
848 name, for example \c{orphan-labels}; you can enable warnings of
849 this class by the command-line option \c{-w+orphan-labels} and
850 disable it by \c{-w-orphan-labels}.
852 The \i{suppressible warning} classes are:
854 \b \i\c{macro-params} covers warnings about \i{multi-line macros}
855 being invoked with the wrong number of parameters. This warning
856 class is enabled by default; see \k{mlmacover} for an example of why
857 you might want to disable it.
859 \b \i\c{macro-selfref} warns if a macro references itself. This 
860 warning class is disabled by default.
862 \b\i\c{macro-defaults} warns when a macro has more default
863 parameters than optional parameters. This warning class
864 is enabled by default; see \k{mlmacdef} for why you might want to disable it.
866 \b \i\c{orphan-labels} covers warnings about source lines which
867 contain no instruction but define a label without a trailing colon.
868 NASM warns about this somewhat obscure condition by default;
869 see \k{syntax} for more information.
871 \b \i\c{number-overflow} covers warnings about numeric constants which
872 don't fit in 64 bits. This warning class is enabled by default.
874 \b \i\c{gnu-elf-extensions} warns if 8-bit or 16-bit relocations 
875 are used in \c{-f elf} format. The GNU extensions allow this. 
876 This warning class is disabled by default.
878 \b \i\c{float-overflow} warns about floating point overflow.
879 Enabled by default.
881 \b \i\c{float-denorm} warns about floating point denormals.
882 Disabled by default.
884 \b \i\c{float-underflow} warns about floating point underflow.
885 Disabled by default.
887 \b \i\c{float-toolong} warns about too many digits in floating-point numbers.
888 Enabled by default.
890 \b \i\c{user} controls \c{%warning} directives (see \k{pperror}).
891 Enabled by default.
893 \b \i\c{error} causes warnings to be treated as errors.  Disabled by
894 default.
896 \b \i\c{all} is an alias for \e{all} suppressible warning classes (not
897 including \c{error}).  Thus, \c{-w+all} enables all available warnings.
899 In addition, you can set warning classes across sections.
900 Warning classes may be enabled with \i\c{[warning +warning-name]},
901 disabled with \i\c{[warning -warning-name]} or reset to their
902 original value with \i\c{[warning *warning-name]}. No "user form"
903 (without the brackets) exists.
905 Since version 2.00, NASM has also supported the gcc-like syntax
906 \c{-Wwarning} and \c{-Wno-warning} instead of \c{-w+warning} and
907 \c{-w-warning}, respectively.
910 \S{opt-v} The \i\c{-v} Option: Display \i{Version} Info
912 Typing \c{NASM -v} will display the version of NASM which you are using,
913 and the date on which it was compiled.
915 You will need the version number if you report a bug.
917 \S{opt-y} The \i\c{-y} Option: Display Available Debug Info Formats
919 Typing \c{nasm -f <option> -y} will display a list of the available 
920 debug info formats for the given output format. The default format 
921 is indicated by an asterisk. For example:
923 \c nasm -f elf -y
925 \c valid debug formats for 'elf32' output format are
926 \c   ('*' denotes default):
927 \c   * stabs     ELF32 (i386) stabs debug format for Linux
928 \c     dwarf     elf32 (i386) dwarf debug format for Linux
931 \S{opt-pfix} The \i\c{--prefix} and \i\c{--postfix} Options.
933 The \c{--prefix} and \c{--postfix} options prepend or append 
934 (respectively) the given argument to all \c{global} or
935 \c{extern} variables. E.g. \c{--prefix _} will prepend the 
936 underscore to all global and external variables, as C sometimes 
937 (but not always) likes it.
940 \S{nasmenv} The \i\c{NASMENV} \i{Environment} Variable
942 If you define an environment variable called \c{NASMENV}, the program
943 will interpret it as a list of extra command-line options, which are
944 processed before the real command line. You can use this to define
945 standard search directories for include files, by putting \c{-i}
946 options in the \c{NASMENV} variable.
948 The value of the variable is split up at white space, so that the
949 value \c{-s -ic:\\nasmlib} will be treated as two separate options.
950 However, that means that the value \c{-dNAME="my name"} won't do
951 what you might want, because it will be split at the space and the
952 NASM command-line processing will get confused by the two
953 nonsensical words \c{-dNAME="my} and \c{name"}.
955 To get round this, NASM provides a feature whereby, if you begin the
956 \c{NASMENV} environment variable with some character that isn't a minus
957 sign, then NASM will treat this character as the \i{separator
958 character} for options. So setting the \c{NASMENV} variable to the
959 value \c{!-s!-ic:\\nasmlib} is equivalent to setting it to \c{-s
960 -ic:\\nasmlib}, but \c{!-dNAME="my name"} will work.
962 This environment variable was previously called \c{NASM}. This was
963 changed with version 0.98.31.
966 \H{qstart} \i{Quick Start} for \i{MASM} Users
968 If you're used to writing programs with MASM, or with \i{TASM} in
969 MASM-compatible (non-Ideal) mode, or with \i\c{a86}, this section
970 attempts to outline the major differences between MASM's syntax and
971 NASM's. If you're not already used to MASM, it's probably worth
972 skipping this section.
975 \S{qscs} NASM Is \I{case sensitivity}Case-Sensitive
977 One simple difference is that NASM is case-sensitive. It makes a
978 difference whether you call your label \c{foo}, \c{Foo} or \c{FOO}.
979 If you're assembling to \c{DOS} or \c{OS/2} \c{.OBJ} files, you can
980 invoke the \i\c{UPPERCASE} directive (documented in \k{objfmt}) to
981 ensure that all symbols exported to other code modules are forced
982 to be upper case; but even then, \e{within} a single module, NASM
983 will distinguish between labels differing only in case.
986 \S{qsbrackets} NASM Requires \i{Square Brackets} For \i{Memory References}
988 NASM was designed with simplicity of syntax in mind. One of the
989 \i{design goals} of NASM is that it should be possible, as far as is
990 practical, for the user to look at a single line of NASM code
991 and tell what opcode is generated by it. You can't do this in MASM:
992 if you declare, for example,
994 \c foo     equ     1
995 \c bar     dw      2
997 then the two lines of code
999 \c         mov     ax,foo
1000 \c         mov     ax,bar
1002 generate completely different opcodes, despite having
1003 identical-looking syntaxes.
1005 NASM avoids this undesirable situation by having a much simpler
1006 syntax for memory references. The rule is simply that any access to
1007 the \e{contents} of a memory location requires square brackets
1008 around the address, and any access to the \e{address} of a variable
1009 doesn't. So an instruction of the form \c{mov ax,foo} will
1010 \e{always} refer to a compile-time constant, whether it's an \c{EQU}
1011 or the address of a variable; and to access the \e{contents} of the
1012 variable \c{bar}, you must code \c{mov ax,[bar]}.
1014 This also means that NASM has no need for MASM's \i\c{OFFSET}
1015 keyword, since the MASM code \c{mov ax,offset bar} means exactly the
1016 same thing as NASM's \c{mov ax,bar}. If you're trying to get
1017 large amounts of MASM code to assemble sensibly under NASM, you
1018 can always code \c{%idefine offset} to make the preprocessor treat
1019 the \c{OFFSET} keyword as a no-op.
1021 This issue is even more confusing in \i\c{a86}, where declaring a
1022 label with a trailing colon defines it to be a `label' as opposed to
1023 a `variable' and causes \c{a86} to adopt NASM-style semantics; so in
1024 \c{a86}, \c{mov ax,var} has different behaviour depending on whether
1025 \c{var} was declared as \c{var: dw 0} (a label) or \c{var dw 0} (a
1026 word-size variable). NASM is very simple by comparison:
1027 \e{everything} is a label.
1029 NASM, in the interests of simplicity, also does not support the
1030 \i{hybrid syntaxes} supported by MASM and its clones, such as
1031 \c{mov ax,table[bx]}, where a memory reference is denoted by one
1032 portion outside square brackets and another portion inside. The
1033 correct syntax for the above is \c{mov ax,[table+bx]}. Likewise,
1034 \c{mov ax,es:[di]} is wrong and \c{mov ax,[es:di]} is right.
1037 \S{qstypes} NASM Doesn't Store \i{Variable Types}
1039 NASM, by design, chooses not to remember the types of variables you
1040 declare. Whereas MASM will remember, on seeing \c{var dw 0}, that
1041 you declared \c{var} as a word-size variable, and will then be able
1042 to fill in the \i{ambiguity} in the size of the instruction \c{mov
1043 var,2}, NASM will deliberately remember nothing about the symbol
1044 \c{var} except where it begins, and so you must explicitly code
1045 \c{mov word [var],2}.
1047 For this reason, NASM doesn't support the \c{LODS}, \c{MOVS},
1048 \c{STOS}, \c{SCAS}, \c{CMPS}, \c{INS}, or \c{OUTS} instructions,
1049 but only supports the forms such as \c{LODSB}, \c{MOVSW}, and
1050 \c{SCASD}, which explicitly specify the size of the components of
1051 the strings being manipulated.
1054 \S{qsassume} NASM Doesn't \i\c{ASSUME}
1056 As part of NASM's drive for simplicity, it also does not support the
1057 \c{ASSUME} directive. NASM will not keep track of what values you
1058 choose to put in your segment registers, and will never
1059 \e{automatically} generate a \i{segment override} prefix.
1062 \S{qsmodel} NASM Doesn't Support \i{Memory Models}
1064 NASM also does not have any directives to support different 16-bit
1065 memory models. The programmer has to keep track of which functions
1066 are supposed to be called with a \i{far call} and which with a
1067 \i{near call}, and is responsible for putting the correct form of
1068 \c{RET} instruction (\c{RETN} or \c{RETF}; NASM accepts \c{RET}
1069 itself as an alternate form for \c{RETN}); in addition, the
1070 programmer is responsible for coding CALL FAR instructions where
1071 necessary when calling \e{external} functions, and must also keep
1072 track of which external variable definitions are far and which are
1073 near.
1076 \S{qsfpu} \i{Floating-Point} Differences
1078 NASM uses different names to refer to floating-point registers from
1079 MASM: where MASM would call them \c{ST(0)}, \c{ST(1)} and so on, and
1080 \i\c{a86} would call them simply \c{0}, \c{1} and so on, NASM
1081 chooses to call them \c{st0}, \c{st1} etc.
1083 As of version 0.96, NASM now treats the instructions with
1084 \i{`nowait'} forms in the same way as MASM-compatible assemblers.
1085 The idiosyncratic treatment employed by 0.95 and earlier was based
1086 on a misunderstanding by the authors.
1089 \S{qsother} Other Differences
1091 For historical reasons, NASM uses the keyword \i\c{TWORD} where MASM
1092 and compatible assemblers use \i\c{TBYTE}.
1094 NASM does not declare \i{uninitialized storage} in the same way as
1095 MASM: where a MASM programmer might use \c{stack db 64 dup (?)},
1096 NASM requires \c{stack resb 64}, intended to be read as `reserve 64
1097 bytes'. For a limited amount of compatibility, since NASM treats
1098 \c{?} as a valid character in symbol names, you can code \c{? equ 0}
1099 and then writing \c{dw ?} will at least do something vaguely useful.
1100 \I\c{RESB}\i\c{DUP} is still not a supported syntax, however.
1102 In addition to all of this, macros and directives work completely
1103 differently to MASM. See \k{preproc} and \k{directive} for further
1104 details.
1107 \C{lang} The NASM Language
1109 \H{syntax} Layout of a NASM Source Line
1111 Like most assemblers, each NASM source line contains (unless it
1112 is a macro, a preprocessor directive or an assembler directive: see
1113 \k{preproc} and \k{directive}) some combination of the four fields
1115 \c label:    instruction operands        ; comment
1117 As usual, most of these fields are optional; the presence or absence
1118 of any combination of a label, an instruction and a comment is allowed.
1119 Of course, the operand field is either required or forbidden by the
1120 presence and nature of the instruction field.
1122 NASM uses backslash (\\) as the line continuation character; if a line
1123 ends with backslash, the next line is considered to be a part of the
1124 backslash-ended line.
1126 NASM places no restrictions on white space within a line: labels may
1127 have white space before them, or instructions may have no space
1128 before them, or anything. The \i{colon} after a label is also
1129 optional. (Note that this means that if you intend to code \c{lodsb}
1130 alone on a line, and type \c{lodab} by accident, then that's still a
1131 valid source line which does nothing but define a label. Running
1132 NASM with the command-line option
1133 \I{orphan-labels}\c{-w+orphan-labels} will cause it to warn you if
1134 you define a label alone on a line without a \i{trailing colon}.)
1136 \i{Valid characters} in labels are letters, numbers, \c{_}, \c{$},
1137 \c{#}, \c{@}, \c{~}, \c{.}, and \c{?}. The only characters which may
1138 be used as the \e{first} character of an identifier are letters,
1139 \c{.} (with special meaning: see \k{locallab}), \c{_} and \c{?}.
1140 An identifier may also be prefixed with a \I{$, prefix}\c{$} to
1141 indicate that it is intended to be read as an identifier and not a
1142 reserved word; thus, if some other module you are linking with
1143 defines a symbol called \c{eax}, you can refer to \c{$eax} in NASM
1144 code to distinguish the symbol from the register. Maximum length of 
1145 an identifier is 4095 characters.
1147 The instruction field may contain any machine instruction: Pentium
1148 and P6 instructions, FPU instructions, MMX instructions and even
1149 undocumented instructions are all supported. The instruction may be
1150 prefixed by \c{LOCK}, \c{REP}, \c{REPE}/\c{REPZ} or
1151 \c{REPNE}/\c{REPNZ}, in the usual way. Explicit \I{address-size
1152 prefixes}address-size and \i{operand-size prefixes} \i\c{A16},
1153 \i\c{A32}, \i\c{A64}, \i\c{O16} and \i\c{O32}, \i\c{O64} are provided - one example of their use
1154 is given in \k{mixsize}. You can also use the name of a \I{segment
1155 override}segment register as an instruction prefix: coding
1156 \c{es mov [bx],ax} is equivalent to coding \c{mov [es:bx],ax}. We
1157 recommend the latter syntax, since it is consistent with other
1158 syntactic features of the language, but for instructions such as
1159 \c{LODSB}, which has no operands and yet can require a segment
1160 override, there is no clean syntactic way to proceed apart from
1161 \c{es lodsb}.
1163 An instruction is not required to use a prefix: prefixes such as
1164 \c{CS}, \c{A32}, \c{LOCK} or \c{REPE} can appear on a line by
1165 themselves, and NASM will just generate the prefix bytes.
1167 In addition to actual machine instructions, NASM also supports a
1168 number of pseudo-instructions, described in \k{pseudop}.
1170 Instruction \i{operands} may take a number of forms: they can be
1171 registers, described simply by the register name (e.g. \c{ax},
1172 \c{bp}, \c{ebx}, \c{cr0}: NASM does not use the \c{gas}-style
1173 syntax in which register names must be prefixed by a \c{%} sign), or
1174 they can be \i{effective addresses} (see \k{effaddr}), constants
1175 (\k{const}) or expressions (\k{expr}).
1177 For x87 \i{floating-point} instructions, NASM accepts a wide range of
1178 syntaxes: you can use two-operand forms like MASM supports, or you
1179 can use NASM's native single-operand forms in most cases.
1180 \# Details of
1181 \# all forms of each supported instruction are given in
1182 \# \k{iref}.
1183 For example, you can code:
1185 \c         fadd    st1             ; this sets st0 := st0 + st1
1186 \c         fadd    st0,st1         ; so does this
1188 \c         fadd    st1,st0         ; this sets st1 := st1 + st0
1189 \c         fadd    to st1          ; so does this
1191 Almost any x87 floating-point instruction that references memory must
1192 use one of the prefixes \i\c{DWORD}, \i\c{QWORD} or \i\c{TWORD} to
1193 indicate what size of \i{memory operand} it refers to.
1196 \H{pseudop} \i{Pseudo-Instructions}
1198 Pseudo-instructions are things which, though not real x86 machine
1199 instructions, are used in the instruction field anyway because that's
1200 the most convenient place to put them. The current pseudo-instructions
1201 are \i\c{DB}, \i\c{DW}, \i\c{DD}, \i\c{DQ}, \i\c{DT}, \i\c{DO} and
1202 \i\c{DY}; their \i{uninitialized} counterparts \i\c{RESB}, \i\c{RESW},
1203 \i\c{RESD}, \i\c{RESQ}, \i\c{REST}, \i\c{RESO} and \i\c{RESY}; the
1204 \i\c{INCBIN} command, the \i\c{EQU} command, and the \i\c{TIMES}
1205 prefix.
1208 \S{db} \c{DB} and Friends: Declaring Initialized Data
1210 \i\c{DB}, \i\c{DW}, \i\c{DD}, \i\c{DQ}, \i\c{DT}, \i\c{DO} and
1211 \i\c{DY} are used, much as in MASM, to declare initialized data in the
1212 output file. They can be invoked in a wide range of ways:
1213 \I{floating-point}\I{character constant}\I{string constant}
1215 \c       db    0x55                ; just the byte 0x55
1216 \c       db    0x55,0x56,0x57      ; three bytes in succession
1217 \c       db    'a',0x55            ; character constants are OK
1218 \c       db    'hello',13,10,'$'   ; so are string constants
1219 \c       dw    0x1234              ; 0x34 0x12
1220 \c       dw    'a'                 ; 0x61 0x00 (it's just a number)
1221 \c       dw    'ab'                ; 0x61 0x62 (character constant)
1222 \c       dw    'abc'               ; 0x61 0x62 0x63 0x00 (string)
1223 \c       dd    0x12345678          ; 0x78 0x56 0x34 0x12
1224 \c       dd    1.234567e20         ; floating-point constant
1225 \c       dq    0x123456789abcdef0  ; eight byte constant
1226 \c       dq    1.234567e20         ; double-precision float
1227 \c       dt    1.234567e20         ; extended-precision float
1229 \c{DT}, \c{DO} and \c{DY} do not accept \i{numeric constants} as operands.
1232 \S{resb} \c{RESB} and Friends: Declaring \i{Uninitialized} Data
1234 \i\c{RESB}, \i\c{RESW}, \i\c{RESD}, \i\c{RESQ}, \i\c{REST}, \i\c{RESO}
1235 and \i\c{RESY} are designed to be used in the BSS section of a module:
1236 they declare \e{uninitialized} storage space. Each takes a single
1237 operand, which is the number of bytes, words, doublewords or whatever
1238 to reserve.  As stated in \k{qsother}, NASM does not support the
1239 MASM/TASM syntax of reserving uninitialized space by writing
1240 \I\c{?}\c{DW ?} or similar things: this is what it does instead. The
1241 operand to a \c{RESB}-type pseudo-instruction is a \i\e{critical
1242 expression}: see \k{crit}.
1244 For example:
1246 \c buffer:         resb    64              ; reserve 64 bytes
1247 \c wordvar:        resw    1               ; reserve a word
1248 \c realarray       resq    10              ; array of ten reals
1249 \c ymmval:         resy    1               ; one YMM register
1251 \S{incbin} \i\c{INCBIN}: Including External \i{Binary Files}
1253 \c{INCBIN} is borrowed from the old Amiga assembler \i{DevPac}: it
1254 includes a binary file verbatim into the output file. This can be
1255 handy for (for example) including \i{graphics} and \i{sound} data
1256 directly into a game executable file. It can be called in one of
1257 these three ways:
1259 \c     incbin  "file.dat"             ; include the whole file
1260 \c     incbin  "file.dat",1024        ; skip the first 1024 bytes
1261 \c     incbin  "file.dat",1024,512    ; skip the first 1024, and
1262 \c                                    ; actually include at most 512
1264 \c{INCBIN} is both a directive and a standard macro; the standard
1265 macro version searches for the file in the include file search path
1266 and adds the file to the dependency lists.  This macro can be
1267 overridden if desired.
1270 \S{equ} \i\c{EQU}: Defining Constants
1272 \c{EQU} defines a symbol to a given constant value: when \c{EQU} is
1273 used, the source line must contain a label. The action of \c{EQU} is
1274 to define the given label name to the value of its (only) operand.
1275 This definition is absolute, and cannot change later. So, for
1276 example,
1278 \c message         db      'hello, world'
1279 \c msglen          equ     $-message
1281 defines \c{msglen} to be the constant 12. \c{msglen} may not then be
1282 redefined later. This is not a \i{preprocessor} definition either:
1283 the value of \c{msglen} is evaluated \e{once}, using the value of
1284 \c{$} (see \k{expr} for an explanation of \c{$}) at the point of
1285 definition, rather than being evaluated wherever it is referenced
1286 and using the value of \c{$} at the point of reference.
1289 \S{times} \i\c{TIMES}: \i{Repeating} Instructions or Data
1291 The \c{TIMES} prefix causes the instruction to be assembled multiple
1292 times. This is partly present as NASM's equivalent of the \i\c{DUP}
1293 syntax supported by \i{MASM}-compatible assemblers, in that you can
1294 code
1296 \c zerobuf:        times 64 db 0
1298 or similar things; but \c{TIMES} is more versatile than that. The
1299 argument to \c{TIMES} is not just a numeric constant, but a numeric
1300 \e{expression}, so you can do things like
1302 \c buffer: db      'hello, world'
1303 \c         times 64-$+buffer db ' '
1305 which will store exactly enough spaces to make the total length of
1306 \c{buffer} up to 64. Finally, \c{TIMES} can be applied to ordinary
1307 instructions, so you can code trivial \i{unrolled loops} in it:
1309 \c         times 100 movsb
1311 Note that there is no effective difference between \c{times 100 resb
1312 1} and \c{resb 100}, except that the latter will be assembled about
1313 100 times faster due to the internal structure of the assembler.
1315 The operand to \c{TIMES} is a critical expression (\k{crit}).
1317 Note also that \c{TIMES} can't be applied to \i{macros}: the reason
1318 for this is that \c{TIMES} is processed after the macro phase, which
1319 allows the argument to \c{TIMES} to contain expressions such as
1320 \c{64-$+buffer} as above. To repeat more than one line of code, or a
1321 complex macro, use the preprocessor \i\c{%rep} directive.
1324 \H{effaddr} Effective Addresses
1326 An \i{effective address} is any operand to an instruction which
1327 \I{memory reference}references memory. Effective addresses, in NASM,
1328 have a very simple syntax: they consist of an expression evaluating
1329 to the desired address, enclosed in \i{square brackets}. For
1330 example:
1332 \c wordvar dw      123
1333 \c         mov     ax,[wordvar]
1334 \c         mov     ax,[wordvar+1]
1335 \c         mov     ax,[es:wordvar+bx]
1337 Anything not conforming to this simple system is not a valid memory
1338 reference in NASM, for example \c{es:wordvar[bx]}.
1340 More complicated effective addresses, such as those involving more
1341 than one register, work in exactly the same way:
1343 \c         mov     eax,[ebx*2+ecx+offset]
1344 \c         mov     ax,[bp+di+8]
1346 NASM is capable of doing \i{algebra} on these effective addresses,
1347 so that things which don't necessarily \e{look} legal are perfectly
1348 all right:
1350 \c     mov     eax,[ebx*5]             ; assembles as [ebx*4+ebx]
1351 \c     mov     eax,[label1*2-label2]   ; ie [label1+(label1-label2)]
1353 Some forms of effective address have more than one assembled form;
1354 in most such cases NASM will generate the smallest form it can. For
1355 example, there are distinct assembled forms for the 32-bit effective
1356 addresses \c{[eax*2+0]} and \c{[eax+eax]}, and NASM will generally
1357 generate the latter on the grounds that the former requires four
1358 bytes to store a zero offset.
1360 NASM has a hinting mechanism which will cause \c{[eax+ebx]} and
1361 \c{[ebx+eax]} to generate different opcodes; this is occasionally
1362 useful because \c{[esi+ebp]} and \c{[ebp+esi]} have different
1363 default segment registers.
1365 However, you can force NASM to generate an effective address in a
1366 particular form by the use of the keywords \c{BYTE}, \c{WORD},
1367 \c{DWORD} and \c{NOSPLIT}. If you need \c{[eax+3]} to be assembled
1368 using a double-word offset field instead of the one byte NASM will
1369 normally generate, you can code \c{[dword eax+3]}. Similarly, you
1370 can force NASM to use a byte offset for a small value which it
1371 hasn't seen on the first pass (see \k{crit} for an example of such a
1372 code fragment) by using \c{[byte eax+offset]}. As special cases,
1373 \c{[byte eax]} will code \c{[eax+0]} with a byte offset of zero, and
1374 \c{[dword eax]} will code it with a double-word offset of zero. The
1375 normal form, \c{[eax]}, will be coded with no offset field.
1377 The form described in the previous paragraph is also useful if you
1378 are trying to access data in a 32-bit segment from within 16 bit code.
1379 For more information on this see the section on mixed-size addressing
1380 (\k{mixaddr}). In particular, if you need to access data with a known
1381 offset that is larger than will fit in a 16-bit value, if you don't
1382 specify that it is a dword offset, nasm will cause the high word of
1383 the offset to be lost.
1385 Similarly, NASM will split \c{[eax*2]} into \c{[eax+eax]} because
1386 that allows the offset field to be absent and space to be saved; in
1387 fact, it will also split \c{[eax*2+offset]} into
1388 \c{[eax+eax+offset]}. You can combat this behaviour by the use of
1389 the \c{NOSPLIT} keyword: \c{[nosplit eax*2]} will force
1390 \c{[eax*2+0]} to be generated literally.
1392 In 64-bit mode, NASM will by default generate absolute addresses.  The
1393 \i\c{REL} keyword makes it produce \c{RIP}-relative addresses. Since
1394 this is frequently the normally desired behaviour, see the \c{DEFAULT}
1395 directive (\k{default}). The keyword \i\c{ABS} overrides \i\c{REL}.
1398 \H{const} \i{Constants}
1400 NASM understands four different types of constant: numeric,
1401 character, string and floating-point.
1404 \S{numconst} \i{Numeric Constants}
1406 A numeric constant is simply a number. NASM allows you to specify
1407 numbers in a variety of number bases, in a variety of ways: you can
1408 suffix \c{H}, \c{Q} or \c{O}, and \c{B} for \i{hex}, \i{octal} and \i{binary},
1409 or you can prefix \c{0x} for hex in the style of C, or you can
1410 prefix \c{$} for hex in the style of Borland Pascal. Note, though,
1411 that the \I{$, prefix}\c{$} prefix does double duty as a prefix on
1412 identifiers (see \k{syntax}), so a hex number prefixed with a \c{$}
1413 sign must have a digit after the \c{$} rather than a letter.
1415 Numeric constants can have underscores (\c{_}) interspersed to break
1416 up long strings.
1418 Some examples:
1420 \c         mov     ax,100          ; decimal
1421 \c         mov     ax,0a2h         ; hex
1422 \c         mov     ax,$0a2         ; hex again: the 0 is required
1423 \c         mov     ax,0xa2         ; hex yet again
1424 \c         mov     ax,777q         ; octal
1425 \c         mov     ax,777o         ; octal again
1426 \c         mov     ax,10010011b    ; binary
1427 \c         mov     ax,1001_0011b   ; same binary constant
1430 \S{strings} \I{Strings}\i{Character Strings}
1432 A character string consists of up to eight characters enclosed in
1433 either single quotes (\c{'...'}), double quotes (\c{"..."}) or
1434 backquotes (\c{`...`}).  Single or double quotes are equivalent to
1435 NASM (except of course that surrounding the constant with single
1436 quotes allows double quotes to appear within it and vice versa); the
1437 contents of those are represented verbatim.  Strings enclosed in
1438 backquotes support C-style \c{\\}-escapes for special characters.
1441 The following \i{escape sequences} are recognized by backquoted strings:
1443 \c       \'          single quote (')
1444 \c       \"          double quote (")
1445 \c       \`          backquote (`)
1446 \c       \\\          backslash (\)
1447 \c       \?          question mark (?)
1448 \c       \a          BEL (ASCII 7)
1449 \c       \b          BS  (ASCII 8)
1450 \c       \t          TAB (ASCII 9)
1451 \c       \n          LF  (ASCII 10)
1452 \c       \v          VT  (ASCII 11)
1453 \c       \f          FF  (ASCII 12)
1454 \c       \r          CR  (ASCII 13)
1455 \c       \e          ESC (ASCII 27)
1456 \c       \377        Up to 3 octal digits - literal byte
1457 \c       \xFF        Up to 2 hexadecimal digits - literal byte
1458 \c       \u1234      4 hexadecimal digits - Unicode character
1459 \c       \U12345678  8 hexadecimal digits - Unicode character
1461 All other escape sequences are reserved.  Note that \c{\\0}, meaning a
1462 \c{NUL} character (ASCII 0), is a special case of the octal escape
1463 sequence.
1465 \i{Unicode} characters specified with \c{\\u} or \c{\\U} are converted to
1466 \i{UTF-8}.  For example, the following lines are all equivalent:
1468 \c       db `\u263a`            ; UTF-8 smiley face
1469 \c       db `\xe2\x98\xba`      ; UTF-8 smiley face
1470 \c       db 0E2h, 098h, 0BAh    ; UTF-8 smiley face
1473 \S{chrconst} \i{Character Constants}
1475 A character constant consists of a string up to eight bytes long, used
1476 in an expression context.  It is treated as if it was an integer.
1478 A character constant with more than one byte will be arranged
1479 with \i{little-endian} order in mind: if you code
1481 \c           mov eax,'abcd'
1483 then the constant generated is not \c{0x61626364}, but
1484 \c{0x64636261}, so that if you were then to store the value into
1485 memory, it would read \c{abcd} rather than \c{dcba}. This is also
1486 the sense of character constants understood by the Pentium's
1487 \i\c{CPUID} instruction.
1490 \S{strconst} \i{String Constants}
1492 String constants are character strings used in the context of some
1493 pseudo-instructions, namely the
1494 \I\c{DW}\I\c{DD}\I\c{DQ}\I\c{DT}\I\c{DO}\I\c{DY}\i\c{DB} family and
1495 \i\c{INCBIN} (where it represents a filename.)  They are also used in
1496 certain preprocessor directives.
1498 A string constant looks like a character constant, only longer. It
1499 is treated as a concatenation of maximum-size character constants
1500 for the conditions. So the following are equivalent:
1502 \c       db    'hello'               ; string constant
1503 \c       db    'h','e','l','l','o'   ; equivalent character constants
1505 And the following are also equivalent:
1507 \c       dd    'ninechars'           ; doubleword string constant
1508 \c       dd    'nine','char','s'     ; becomes three doublewords
1509 \c       db    'ninechars',0,0,0     ; and really looks like this
1511 Note that when used in a string-supporting context, quoted strings are
1512 treated as a string constants even if they are short enough to be a
1513 character constant, because otherwise \c{db 'ab'} would have the same
1514 effect as \c{db 'a'}, which would be silly. Similarly, three-character
1515 or four-character constants are treated as strings when they are
1516 operands to \c{DW}, and so forth.
1518 \S{unicode} \I{UTF-16}\I{UTF-32}\i{Unicode} Strings
1520 The special operators \i\c{__utf16__} and \i\c{__utf32__} allows
1521 definition of Unicode strings.  They take a string in UTF-8 format and
1522 converts it to (littleendian) UTF-16 or UTF-32, respectively.
1524 For example:
1526 \c %define u(x) __utf16__(x)
1527 \c %define w(x) __utf32__(x)
1529 \c       dw u('C:\WINDOWS'), 0       ; Pathname in UTF-16
1530 \c       dd w(`A + B = \u206a`), 0   ; String in UTF-32
1532 \c{__utf16__} and \c{__utf32__} can be applied either to strings
1533 passed to the \c{DB} family instructions, or to character constants in
1534 an expression context.  
1536 \S{fltconst} \I{floating-point, constants}Floating-Point Constants
1538 \i{Floating-point} constants are acceptable only as arguments to
1539 \i\c{DB}, \i\c{DW}, \i\c{DD}, \i\c{DQ}, \i\c{DT}, and \i\c{DO}, or as
1540 arguments to the special operators \i\c{__float8__},
1541 \i\c{__float16__}, \i\c{__float32__}, \i\c{__float64__},
1542 \i\c{__float80m__}, \i\c{__float80e__}, \i\c{__float128l__}, and
1543 \i\c{__float128h__}.
1545 Floating-point constants are expressed in the traditional form:
1546 digits, then a period, then optionally more digits, then optionally an
1547 \c{E} followed by an exponent. The period is mandatory, so that NASM
1548 can distinguish between \c{dd 1}, which declares an integer constant,
1549 and \c{dd 1.0} which declares a floating-point constant.  NASM also
1550 support C99-style hexadecimal floating-point: \c{0x}, hexadecimal
1551 digits, period, optionally more hexadeximal digits, then optionally a
1552 \c{P} followed by a \e{binary} (not hexadecimal) exponent in decimal
1553 notation.
1555 Underscores to break up groups of digits are permitted in
1556 floating-point constants as well.
1558 Some examples:
1560 \c       db    -0.2                    ; "Quarter precision"
1561 \c       dw    -0.5                    ; IEEE 754r/SSE5 half precision
1562 \c       dd    1.2                     ; an easy one
1563 \c       dd    1.222_222_222           ; underscores are permitted
1564 \c       dd    0x1p+2                  ; 1.0x2^2 = 4.0
1565 \c       dq    0x1p+32                 ; 1.0x2^32 = 4 294 967 296.0
1566 \c       dq    1.e10                   ; 10 000 000 000.0
1567 \c       dq    1.e+10                  ; synonymous with 1.e10
1568 \c       dq    1.e-10                  ; 0.000 000 000 1
1569 \c       dt    3.141592653589793238462 ; pi
1570 \c       do    1.e+4000                ; IEEE 754r quad precision
1572 The 8-bit "quarter-precision" floating-point format is
1573 sign:exponent:mantissa = 1:4:3 with an exponent bias of 7.  This
1574 appears to be the most frequently used 8-bit floating-point format,
1575 although it is not covered by any formal standard.  This is sometimes
1576 called a "\i{minifloat}."
1578 The special operators are used to produce floating-point numbers in
1579 other contexts.  They produce the binary representation of a specific
1580 floating-point number as an integer, and can use anywhere integer
1581 constants are used in an expression.  \c{__float80m__} and
1582 \c{__float80e__} produce the 64-bit mantissa and 16-bit exponent of an
1583 80-bit floating-point number, and \c{__float128l__} and
1584 \c{__float128h__} produce the lower and upper 64-bit halves of a 128-bit
1585 floating-point number, respectively.
1587 For example:
1589 \c       mov    rax,__float64__(3.141592653589793238462)
1591 ... would assign the binary representation of pi as a 64-bit floating
1592 point number into \c{RAX}.  This is exactly equivalent to:
1594 \c       mov    rax,0x400921fb54442d18
1596 NASM cannot do compile-time arithmetic on floating-point constants.
1597 This is because NASM is designed to be portable - although it always
1598 generates code to run on x86 processors, the assembler itself can
1599 run on any system with an ANSI C compiler. Therefore, the assembler
1600 cannot guarantee the presence of a floating-point unit capable of
1601 handling the \i{Intel number formats}, and so for NASM to be able to
1602 do floating arithmetic it would have to include its own complete set
1603 of floating-point routines, which would significantly increase the
1604 size of the assembler for very little benefit.
1606 The special tokens \i\c{__Infinity__}, \i\c{__QNaN__} (or
1607 \i\c{__NaN__}) and \i\c{__SNaN__} can be used to generate
1608 \I{infinity}infinities, quiet \i{NaN}s, and signalling NaNs,
1609 respectively.  These are normally used as macros:
1611 \c %define Inf __Infinity__
1612 \c %define NaN __QNaN__
1614 \c       dq    +1.5, -Inf, NaN         ; Double-precision constants
1616 \S{bcdconst} \I{floating-point, packed BCD constants}Packed BCD Constants
1618 x87-style packed BCD constants can be used in the same contexts as
1619 80-bit floating-point numbers.  They are suffixed with \c{p} or
1620 prefixed with \c{0p}, and can include up to 18 decimal digits.
1622 As with other numeric constants, underscores can be used to separate
1623 digits.
1625 For example:
1627 \c       dt 12_345_678_901_245_678p
1628 \c       dt -12_345_678_901_245_678p
1629 \c       dt +0p33
1630 \c       dt 33p
1633 \H{expr} \i{Expressions}
1635 Expressions in NASM are similar in syntax to those in C.  Expressions
1636 are evaluated as 64-bit integers which are then adjusted to the
1637 appropriate size.
1639 NASM supports two special tokens in expressions, allowing
1640 calculations to involve the current assembly position: the
1641 \I{$, here}\c{$} and \i\c{$$} tokens. \c{$} evaluates to the assembly
1642 position at the beginning of the line containing the expression; so
1643 you can code an \i{infinite loop} using \c{JMP $}. \c{$$} evaluates
1644 to the beginning of the current section; so you can tell how far
1645 into the section you are by using \c{($-$$)}.
1647 The arithmetic \i{operators} provided by NASM are listed here, in
1648 increasing order of \i{precedence}.
1651 \S{expor} \i\c{|}: \i{Bitwise OR} Operator
1653 The \c{|} operator gives a bitwise OR, exactly as performed by the
1654 \c{OR} machine instruction. Bitwise OR is the lowest-priority
1655 arithmetic operator supported by NASM.
1658 \S{expxor} \i\c{^}: \i{Bitwise XOR} Operator
1660 \c{^} provides the bitwise XOR operation.
1663 \S{expand} \i\c{&}: \i{Bitwise AND} Operator
1665 \c{&} provides the bitwise AND operation.
1668 \S{expshift} \i\c{<<} and \i\c{>>}: \i{Bit Shift} Operators
1670 \c{<<} gives a bit-shift to the left, just as it does in C. So \c{5<<3}
1671 evaluates to 5 times 8, or 40. \c{>>} gives a bit-shift to the
1672 right; in NASM, such a shift is \e{always} unsigned, so that
1673 the bits shifted in from the left-hand end are filled with zero
1674 rather than a sign-extension of the previous highest bit.
1677 \S{expplmi} \I{+ opaddition}\c{+} and \I{- opsubtraction}\c{-}:
1678 \i{Addition} and \i{Subtraction} Operators
1680 The \c{+} and \c{-} operators do perfectly ordinary addition and
1681 subtraction.
1684 \S{expmul} \i\c{*}, \i\c{/}, \i\c{//}, \i\c{%} and \i\c{%%}:
1685 \i{Multiplication} and \i{Division}
1687 \c{*} is the multiplication operator. \c{/} and \c{//} are both
1688 division operators: \c{/} is \i{unsigned division} and \c{//} is
1689 \i{signed division}. Similarly, \c{%} and \c{%%} provide \I{unsigned
1690 modulo}\I{modulo operators}unsigned and
1691 \i{signed modulo} operators respectively.
1693 NASM, like ANSI C, provides no guarantees about the sensible
1694 operation of the signed modulo operator.
1696 Since the \c{%} character is used extensively by the macro
1697 \i{preprocessor}, you should ensure that both the signed and unsigned
1698 modulo operators are followed by white space wherever they appear.
1701 \S{expmul} \i{Unary Operators}: \I{+ opunary}\c{+}, \I{- opunary}\c{-},
1702 \i\c{~}, \I{! opunary}\c{!} and \i\c{SEG}
1704 The highest-priority operators in NASM's expression grammar are
1705 those which only apply to one argument. \c{-} negates its operand,
1706 \c{+} does nothing (it's provided for symmetry with \c{-}), \c{~}
1707 computes the \i{one's complement} of its operand, \c{!} is the
1708 \i{logical negation} operator, and \c{SEG} provides the \i{segment address}
1709 of its operand (explained in more detail in \k{segwrt}).
1712 \H{segwrt} \i\c{SEG} and \i\c{WRT}
1714 When writing large 16-bit programs, which must be split into
1715 multiple \i{segments}, it is often necessary to be able to refer to
1716 the \I{segment address}segment part of the address of a symbol. NASM
1717 supports the \c{SEG} operator to perform this function.
1719 The \c{SEG} operator returns the \i\e{preferred} segment base of a
1720 symbol, defined as the segment base relative to which the offset of
1721 the symbol makes sense. So the code
1723 \c         mov     ax,seg symbol
1724 \c         mov     es,ax
1725 \c         mov     bx,symbol
1727 will load \c{ES:BX} with a valid pointer to the symbol \c{symbol}.
1729 Things can be more complex than this: since 16-bit segments and
1730 \i{groups} may \I{overlapping segments}overlap, you might occasionally
1731 want to refer to some symbol using a different segment base from the
1732 preferred one. NASM lets you do this, by the use of the \c{WRT}
1733 (With Reference To) keyword. So you can do things like
1735 \c         mov     ax,weird_seg        ; weird_seg is a segment base
1736 \c         mov     es,ax
1737 \c         mov     bx,symbol wrt weird_seg
1739 to load \c{ES:BX} with a different, but functionally equivalent,
1740 pointer to the symbol \c{symbol}.
1742 NASM supports far (inter-segment) calls and jumps by means of the
1743 syntax \c{call segment:offset}, where \c{segment} and \c{offset}
1744 both represent immediate values. So to call a far procedure, you
1745 could code either of
1747 \c         call    (seg procedure):procedure
1748 \c         call    weird_seg:(procedure wrt weird_seg)
1750 (The parentheses are included for clarity, to show the intended
1751 parsing of the above instructions. They are not necessary in
1752 practice.)
1754 NASM supports the syntax \I\c{CALL FAR}\c{call far procedure} as a
1755 synonym for the first of the above usages. \c{JMP} works identically
1756 to \c{CALL} in these examples.
1758 To declare a \i{far pointer} to a data item in a data segment, you
1759 must code
1761 \c         dw      symbol, seg symbol
1763 NASM supports no convenient synonym for this, though you can always
1764 invent one using the macro processor.
1767 \H{strict} \i\c{STRICT}: Inhibiting Optimization
1769 When assembling with the optimizer set to level 2 or higher (see
1770 \k{opt-O}), NASM will use size specifiers (\c{BYTE}, \c{WORD},
1771 \c{DWORD}, \c{QWORD}, \c{TWORD}, \c{OWORD} or \c{YWORD}), but will
1772 give them the smallest possible size. The keyword \c{STRICT} can be
1773 used to inhibit optimization and force a particular operand to be
1774 emitted in the specified size. For example, with the optimizer on, and
1775 in \c{BITS 16} mode,
1777 \c         push dword 33
1779 is encoded in three bytes \c{66 6A 21}, whereas
1781 \c         push strict dword 33
1783 is encoded in six bytes, with a full dword immediate operand \c{66 68
1784 21 00 00 00}.
1786 With the optimizer off, the same code (six bytes) is generated whether
1787 the \c{STRICT} keyword was used or not.
1790 \H{crit} \i{Critical Expressions}
1792 Although NASM has an optional multi-pass optimizer, there are some
1793 expressions which must be resolvable on the first pass. These are
1794 called \e{Critical Expressions}.
1796 The first pass is used to determine the size of all the assembled
1797 code and data, so that the second pass, when generating all the
1798 code, knows all the symbol addresses the code refers to. So one
1799 thing NASM can't handle is code whose size depends on the value of a
1800 symbol declared after the code in question. For example,
1802 \c         times (label-$) db 0
1803 \c label:  db      'Where am I?'
1805 The argument to \i\c{TIMES} in this case could equally legally
1806 evaluate to anything at all; NASM will reject this example because
1807 it cannot tell the size of the \c{TIMES} line when it first sees it.
1808 It will just as firmly reject the slightly \I{paradox}paradoxical
1809 code
1811 \c         times (label-$+1) db 0
1812 \c label:  db      'NOW where am I?'
1814 in which \e{any} value for the \c{TIMES} argument is by definition
1815 wrong!
1817 NASM rejects these examples by means of a concept called a
1818 \e{critical expression}, which is defined to be an expression whose
1819 value is required to be computable in the first pass, and which must
1820 therefore depend only on symbols defined before it. The argument to
1821 the \c{TIMES} prefix is a critical expression.
1823 \H{locallab} \i{Local Labels}
1825 NASM gives special treatment to symbols beginning with a \i{period}.
1826 A label beginning with a single period is treated as a \e{local}
1827 label, which means that it is associated with the previous non-local
1828 label. So, for example:
1830 \c label1  ; some code
1832 \c .loop
1833 \c         ; some more code
1835 \c         jne     .loop
1836 \c         ret
1838 \c label2  ; some code
1840 \c .loop
1841 \c         ; some more code
1843 \c         jne     .loop
1844 \c         ret
1846 In the above code fragment, each \c{JNE} instruction jumps to the
1847 line immediately before it, because the two definitions of \c{.loop}
1848 are kept separate by virtue of each being associated with the
1849 previous non-local label.
1851 This form of local label handling is borrowed from the old Amiga
1852 assembler \i{DevPac}; however, NASM goes one step further, in
1853 allowing access to local labels from other parts of the code. This
1854 is achieved by means of \e{defining} a local label in terms of the
1855 previous non-local label: the first definition of \c{.loop} above is
1856 really defining a symbol called \c{label1.loop}, and the second
1857 defines a symbol called \c{label2.loop}. So, if you really needed
1858 to, you could write
1860 \c label3  ; some more code
1861 \c         ; and some more
1863 \c         jmp label1.loop
1865 Sometimes it is useful - in a macro, for instance - to be able to
1866 define a label which can be referenced from anywhere but which
1867 doesn't interfere with the normal local-label mechanism. Such a
1868 label can't be non-local because it would interfere with subsequent
1869 definitions of, and references to, local labels; and it can't be
1870 local because the macro that defined it wouldn't know the label's
1871 full name. NASM therefore introduces a third type of label, which is
1872 probably only useful in macro definitions: if a label begins with
1873 the \I{label prefix}special prefix \i\c{..@}, then it does nothing
1874 to the local label mechanism. So you could code
1876 \c label1:                         ; a non-local label
1877 \c .local:                         ; this is really label1.local
1878 \c ..@foo:                         ; this is a special symbol
1879 \c label2:                         ; another non-local label
1880 \c .local:                         ; this is really label2.local
1882 \c         jmp     ..@foo          ; this will jump three lines up
1884 NASM has the capacity to define other special symbols beginning with
1885 a double period: for example, \c{..start} is used to specify the
1886 entry point in the \c{obj} output format (see \k{dotdotstart}).
1889 \C{preproc} The NASM \i{Preprocessor}
1891 NASM contains a powerful \i{macro processor}, which supports
1892 conditional assembly, multi-level file inclusion, two forms of macro
1893 (single-line and multi-line), and a `context stack' mechanism for
1894 extra macro power. Preprocessor directives all begin with a \c{%}
1895 sign.
1897 The preprocessor collapses all lines which end with a backslash (\\)
1898 character into a single line.  Thus:
1900 \c %define THIS_VERY_LONG_MACRO_NAME_IS_DEFINED_TO \\
1901 \c         THIS_VALUE
1903 will work like a single-line macro without the backslash-newline
1904 sequence.
1906 \H{slmacro} \i{Single-Line Macros}
1908 \S{define} The Normal Way: \I\c{%idefine}\i\c{%define}
1910 Single-line macros are defined using the \c{%define} preprocessor
1911 directive. The definitions work in a similar way to C; so you can do
1912 things like
1914 \c %define ctrl    0x1F &
1915 \c %define param(a,b) ((a)+(a)*(b))
1917 \c         mov     byte [param(2,ebx)], ctrl 'D'
1919 which will expand to
1921 \c         mov     byte [(2)+(2)*(ebx)], 0x1F & 'D'
1923 When the expansion of a single-line macro contains tokens which
1924 invoke another macro, the expansion is performed at invocation time,
1925 not at definition time. Thus the code
1927 \c %define a(x)    1+b(x)
1928 \c %define b(x)    2*x
1930 \c         mov     ax,a(8)
1932 will evaluate in the expected way to \c{mov ax,1+2*8}, even though
1933 the macro \c{b} wasn't defined at the time of definition of \c{a}.
1935 Macros defined with \c{%define} are \i{case sensitive}: after
1936 \c{%define foo bar}, only \c{foo} will expand to \c{bar}: \c{Foo} or
1937 \c{FOO} will not. By using \c{%idefine} instead of \c{%define} (the
1938 `i' stands for `insensitive') you can define all the case variants
1939 of a macro at once, so that \c{%idefine foo bar} would cause
1940 \c{foo}, \c{Foo}, \c{FOO}, \c{fOO} and so on all to expand to
1941 \c{bar}.
1943 There is a mechanism which detects when a macro call has occurred as
1944 a result of a previous expansion of the same macro, to guard against
1945 \i{circular references} and infinite loops. If this happens, the
1946 preprocessor will only expand the first occurrence of the macro.
1947 Hence, if you code
1949 \c %define a(x)    1+a(x)
1951 \c         mov     ax,a(3)
1953 the macro \c{a(3)} will expand once, becoming \c{1+a(3)}, and will
1954 then expand no further. This behaviour can be useful: see \k{32c}
1955 for an example of its use.
1957 You can \I{overloading, single-line macros}overload single-line
1958 macros: if you write
1960 \c %define foo(x)   1+x
1961 \c %define foo(x,y) 1+x*y
1963 the preprocessor will be able to handle both types of macro call,
1964 by counting the parameters you pass; so \c{foo(3)} will become
1965 \c{1+3} whereas \c{foo(ebx,2)} will become \c{1+ebx*2}. However, if
1966 you define
1968 \c %define foo bar
1970 then no other definition of \c{foo} will be accepted: a macro with
1971 no parameters prohibits the definition of the same name as a macro
1972 \e{with} parameters, and vice versa.
1974 This doesn't prevent single-line macros being \e{redefined}: you can
1975 perfectly well define a macro with
1977 \c %define foo bar
1979 and then re-define it later in the same source file with
1981 \c %define foo baz
1983 Then everywhere the macro \c{foo} is invoked, it will be expanded
1984 according to the most recent definition. This is particularly useful
1985 when defining single-line macros with \c{%assign} (see \k{assign}).
1987 You can \i{pre-define} single-line macros using the `-d' option on
1988 the NASM command line: see \k{opt-d}.
1991 \S{xdefine} Resolving \c{%define}: \I\c{%ixdefine}\i\c{%xdefine}
1993 To have a reference to an embedded single-line macro resolved at the
1994 time that the embedding macro is \e{defined}, as opposed to when the
1995 embedding macro is \e{expanded}, you need a different mechanism to the
1996 one offered by \c{%define}. The solution is to use \c{%xdefine}, or
1997 it's \I{case sensitive}case-insensitive counterpart \c{%ixdefine}.
1999 Suppose you have the following code:
2001 \c %define  isTrue  1
2002 \c %define  isFalse isTrue
2003 \c %define  isTrue  0
2005 \c val1:    db      isFalse
2007 \c %define  isTrue  1
2009 \c val2:    db      isFalse
2011 In this case, \c{val1} is equal to 0, and \c{val2} is equal to 1.
2012 This is because, when a single-line macro is defined using
2013 \c{%define}, it is expanded only when it is called. As \c{isFalse}
2014 expands to \c{isTrue}, the expansion will be the current value of
2015 \c{isTrue}. The first time it is called that is 0, and the second
2016 time it is 1.
2018 If you wanted \c{isFalse} to expand to the value assigned to the
2019 embedded macro \c{isTrue} at the time that \c{isFalse} was defined,
2020 you need to change the above code to use \c{%xdefine}.
2022 \c %xdefine isTrue  1
2023 \c %xdefine isFalse isTrue
2024 \c %xdefine isTrue  0
2026 \c val1:    db      isFalse
2028 \c %xdefine isTrue  1
2030 \c val2:    db      isFalse
2032 Now, each time that \c{isFalse} is called, it expands to 1,
2033 as that is what the embedded macro \c{isTrue} expanded to at
2034 the time that \c{isFalse} was defined.
2037 \S{indmacro} \i{Macro Indirection}: \I\c{%[}\c{%[...]}
2039 The \c{%[...]} construct can be used to expand macros in contexts
2040 where macro expansion would otherwise not occur, including in the
2041 names other macros.  For example, if you have a set of macros named
2042 \c{Foo16}, \c{Foo32} and \c{Foo64}, you could write:
2044 \c      mov ax,Foo%[__BITS__]   ; The Foo value 
2046 to use the builtin macro \c{__BITS__} (see \k{bitsm}) to automatically
2047 select between them.  Similarly, the two statements:
2049 \c %xdefine Bar         Quux    ; Expands due to %xdefine
2050 \c %define  Bar         %[Quux] ; Expands due to %[...]
2052 have, in fact, exactly the same effect.
2054 \c{%[...]} concatenates to adjacent tokens in the same way that
2055 multi-line macro parameters do, see \k{concat} for details.
2058 \S{concat%+} Concatenating Single Line Macro Tokens: \i\c{%+}
2060 Individual tokens in single line macros can be concatenated, to produce
2061 longer tokens for later processing. This can be useful if there are
2062 several similar macros that perform similar functions.
2064 Please note that a space is required after \c{%+}, in order to
2065 disambiguate it from the syntax \c{%+1} used in multiline macros.
2067 As an example, consider the following:
2069 \c %define BDASTART 400h                ; Start of BIOS data area
2071 \c struc   tBIOSDA                      ; its structure
2072 \c         .COM1addr       RESW    1
2073 \c         .COM2addr       RESW    1
2074 \c         ; ..and so on
2075 \c endstruc
2077 Now, if we need to access the elements of tBIOSDA in different places,
2078 we can end up with:
2080 \c         mov     ax,BDASTART + tBIOSDA.COM1addr
2081 \c         mov     bx,BDASTART + tBIOSDA.COM2addr
2083 This will become pretty ugly (and tedious) if used in many places, and
2084 can be reduced in size significantly by using the following macro:
2086 \c ; Macro to access BIOS variables by their names (from tBDA):
2088 \c %define BDA(x)  BDASTART + tBIOSDA. %+ x
2090 Now the above code can be written as:
2092 \c         mov     ax,BDA(COM1addr)
2093 \c         mov     bx,BDA(COM2addr)
2095 Using this feature, we can simplify references to a lot of macros (and,
2096 in turn, reduce typing errors).
2099 \S{selfref%?} The Macro Name Itself: \i\c{%?} and \i\c{%??}
2101 The special symbols \c{%?} and \c{%??} can be used to reference the
2102 macro name itself inside a macro expansion, this is supported for both
2103 single-and multi-line macros.  \c{%?} refers to the macro name as
2104 \e{invoked}, whereas \c{%??} refers to the macro name as
2105 \e{declared}.  The two are always the same for case-sensitive
2106 macros, but for case-insensitive macros, they can differ.
2108 For example:
2110 \c %idefine Foo mov %?,%??
2112 \c         foo
2113 \c         FOO
2115 will expand to:
2117 \c         mov foo,Foo
2118 \c         mov FOO,Foo
2120 The sequence:
2122 \c %idefine keyword $%?
2124 can be used to make a keyword "disappear", for example in case a new
2125 instruction has been used as a label in older code.  For example:
2127 \c %idefine pause $%?                  ; Hide the PAUSE instruction
2130 \S{undef} Undefining Single-Line Macros: \i\c{%undef}
2132 Single-line macros can be removed with the \c{%undef} directive.  For
2133 example, the following sequence:
2135 \c %define foo bar
2136 \c %undef  foo
2138 \c         mov     eax, foo
2140 will expand to the instruction \c{mov eax, foo}, since after
2141 \c{%undef} the macro \c{foo} is no longer defined.
2143 Macros that would otherwise be pre-defined can be undefined on the
2144 command-line using the `-u' option on the NASM command line: see
2145 \k{opt-u}.
2148 \S{assign} \i{Preprocessor Variables}: \i\c{%assign}
2150 An alternative way to define single-line macros is by means of the
2151 \c{%assign} command (and its \I{case sensitive}case-insensitive
2152 counterpart \i\c{%iassign}, which differs from \c{%assign} in
2153 exactly the same way that \c{%idefine} differs from \c{%define}).
2155 \c{%assign} is used to define single-line macros which take no
2156 parameters and have a numeric value. This value can be specified in
2157 the form of an expression, and it will be evaluated once, when the
2158 \c{%assign} directive is processed.
2160 Like \c{%define}, macros defined using \c{%assign} can be re-defined
2161 later, so you can do things like
2163 \c %assign i i+1
2165 to increment the numeric value of a macro.
2167 \c{%assign} is useful for controlling the termination of \c{%rep}
2168 preprocessor loops: see \k{rep} for an example of this. Another
2169 use for \c{%assign} is given in \k{16c} and \k{32c}.
2171 The expression passed to \c{%assign} is a \i{critical expression}
2172 (see \k{crit}), and must also evaluate to a pure number (rather than
2173 a relocatable reference such as a code or data address, or anything
2174 involving a register).
2177 \S{defstr} Defining Strings: \I\c{%idefstr}\i\c{%defstr}
2179 \c{%defstr}, and its case-insensitive counterpart \c{%idefstr}, define
2180 or redefine a single-line macro without parameters but converts the
2181 entire right-hand side, after macro expansion, to a quoted string
2182 before definition.
2184 For example:
2186 \c %defstr test TEST
2188 is equivalent to
2190 \c %define test 'TEST'
2192 This can be used, for example, with the \c{%!} construct (see
2193 \k{getenv}):
2195 \c %defstr PATH %!PATH          ; The operating system PATH variable
2198 \H{strlen} \i{String Manipulation in Macros}
2200 It's often useful to be able to handle strings in macros. NASM
2201 supports two simple string handling macro operators from which
2202 more complex operations can be constructed.
2204 All the string operators define or redefine a value (either a string
2205 or a numeric value) to a single-line macro.
2207 \S{strcat} \i{Concatenating Strings}: \i\c{%strcat}
2209 The \c{%strcat} operator concatenates quoted strings and assign them to
2210 a single-line macro.  In doing so, it may change the type of quotes
2211 and possibly use \c{\\}-escapes inside \c{`}-quoted strings in order to
2212 make sure the string is still a valid quoted string.
2214 For example:
2216 \c %strcat alpha "Alpha: ", '12" screen'
2218 ... would assign the value \c{'Alpha: 12" screen'} to \c{alpha}.
2219 Similarly:
2221 \c %strcat beta '"', "'"
2223 ... would assign the value \c{`"'`} to \c{beta}.
2225 The use of commas to separate strings is permitted but optional.
2228 \S{strlen} \i{String Length}: \i\c{%strlen}
2230 The \c{%strlen} operator assigns the length of a string to a macro.
2231 For example:
2233 \c %strlen charcnt 'my string'
2235 In this example, \c{charcnt} would receive the value 9, just as
2236 if an \c{%assign} had been used. In this example, \c{'my string'}
2237 was a literal string but it could also have been a single-line
2238 macro that expands to a string, as in the following example:
2240 \c %define sometext 'my string'
2241 \c %strlen charcnt sometext
2243 As in the first case, this would result in \c{charcnt} being
2244 assigned the value of 9.
2247 \S{substr} \i{Extracting Substrings}: \i\c{%substr}
2249 Individual letters or substrings in strings can be extracted using the
2250 \c{%substr} operator.  An example of its use is probably more useful
2251 than the description:
2253 \c %substr mychar 'xyzw' 1       ; equivalent to %define mychar 'x'
2254 \c %substr mychar 'xyzw' 2       ; equivalent to %define mychar 'y'
2255 \c %substr mychar 'xyzw' 3       ; equivalent to %define mychar 'z'
2256 \c %substr mychar 'xyzw' 2,2     ; equivalent to %define mychar 'yz'
2257 \c %substr mychar 'xyzw' 2,-1    ; equivalent to %define mychar 'yzw'
2258 \c %substr mychar 'xyzw' 2,-2    ; equivalent to %define mychar 'yz'
2260 As with \c{%strlen} (see \k{strlen}), the first parameter is the
2261 single-line macro to be created and the second is the string. The
2262 third parameter specifies the first character to be selected, and the
2263 optional fourth parameter preceeded by comma) is the length.  Note
2264 that the first index is 1, not 0 and the last index is equal to the
2265 value that \c{%strlen} would assign given the same string. Index
2266 values out of range result in an empty string.  A negative length
2267 means "until N-1 characters before the end of string", i.e. \c{-1}
2268 means until end of string, \c{-2} until one character before, etc.
2271 \H{mlmacro} \i{Multi-Line Macros}: \I\c{%imacro}\i\c{%macro}
2273 Multi-line macros are much more like the type of macro seen in MASM
2274 and TASM: a multi-line macro definition in NASM looks something like
2275 this.
2277 \c %macro  prologue 1
2279 \c         push    ebp
2280 \c         mov     ebp,esp
2281 \c         sub     esp,%1
2283 \c %endmacro
2285 This defines a C-like function prologue as a macro: so you would
2286 invoke the macro with a call such as
2288 \c myfunc:   prologue 12
2290 which would expand to the three lines of code
2292 \c myfunc: push    ebp
2293 \c         mov     ebp,esp
2294 \c         sub     esp,12
2296 The number \c{1} after the macro name in the \c{%macro} line defines
2297 the number of parameters the macro \c{prologue} expects to receive.
2298 The use of \c{%1} inside the macro definition refers to the first
2299 parameter to the macro call. With a macro taking more than one
2300 parameter, subsequent parameters would be referred to as \c{%2},
2301 \c{%3} and so on.
2303 Multi-line macros, like single-line macros, are \i{case-sensitive},
2304 unless you define them using the alternative directive \c{%imacro}.
2306 If you need to pass a comma as \e{part} of a parameter to a
2307 multi-line macro, you can do that by enclosing the entire parameter
2308 in \I{braces, around macro parameters}braces. So you could code
2309 things like
2311 \c %macro  silly 2
2313 \c     %2: db      %1
2315 \c %endmacro
2317 \c         silly 'a', letter_a             ; letter_a:  db 'a'
2318 \c         silly 'ab', string_ab           ; string_ab: db 'ab'
2319 \c         silly {13,10}, crlf             ; crlf:      db 13,10
2322 \S{mlmacover} Overloading Multi-Line Macros\I{overloading, multi-line macros}
2324 As with single-line macros, multi-line macros can be overloaded by
2325 defining the same macro name several times with different numbers of
2326 parameters. This time, no exception is made for macros with no
2327 parameters at all. So you could define
2329 \c %macro  prologue 0
2331 \c         push    ebp
2332 \c         mov     ebp,esp
2334 \c %endmacro
2336 to define an alternative form of the function prologue which
2337 allocates no local stack space.
2339 Sometimes, however, you might want to `overload' a machine
2340 instruction; for example, you might want to define
2342 \c %macro  push 2
2344 \c         push    %1
2345 \c         push    %2
2347 \c %endmacro
2349 so that you could code
2351 \c         push    ebx             ; this line is not a macro call
2352 \c         push    eax,ecx         ; but this one is
2354 Ordinarily, NASM will give a warning for the first of the above two
2355 lines, since \c{push} is now defined to be a macro, and is being
2356 invoked with a number of parameters for which no definition has been
2357 given. The correct code will still be generated, but the assembler
2358 will give a warning. This warning can be disabled by the use of the
2359 \c{-w-macro-params} command-line option (see \k{opt-w}).
2362 \S{maclocal} \i{Macro-Local Labels}
2364 NASM allows you to define labels within a multi-line macro
2365 definition in such a way as to make them local to the macro call: so
2366 calling the same macro multiple times will use a different label
2367 each time. You do this by prefixing \i\c{%%} to the label name. So
2368 you can invent an instruction which executes a \c{RET} if the \c{Z}
2369 flag is set by doing this:
2371 \c %macro  retz 0
2373 \c         jnz     %%skip
2374 \c         ret
2375 \c     %%skip:
2377 \c %endmacro
2379 You can call this macro as many times as you want, and every time
2380 you call it NASM will make up a different `real' name to substitute
2381 for the label \c{%%skip}. The names NASM invents are of the form
2382 \c{..@2345.skip}, where the number 2345 changes with every macro
2383 call. The \i\c{..@} prefix prevents macro-local labels from
2384 interfering with the local label mechanism, as described in
2385 \k{locallab}. You should avoid defining your own labels in this form
2386 (the \c{..@} prefix, then a number, then another period) in case
2387 they interfere with macro-local labels.
2390 \S{mlmacgre} \i{Greedy Macro Parameters}
2392 Occasionally it is useful to define a macro which lumps its entire
2393 command line into one parameter definition, possibly after
2394 extracting one or two smaller parameters from the front. An example
2395 might be a macro to write a text string to a file in MS-DOS, where
2396 you might want to be able to write
2398 \c         writefile [filehandle],"hello, world",13,10
2400 NASM allows you to define the last parameter of a macro to be
2401 \e{greedy}, meaning that if you invoke the macro with more
2402 parameters than it expects, all the spare parameters get lumped into
2403 the last defined one along with the separating commas. So if you
2404 code:
2406 \c %macro  writefile 2+
2408 \c         jmp     %%endstr
2409 \c   %%str:        db      %2
2410 \c   %%endstr:
2411 \c         mov     dx,%%str
2412 \c         mov     cx,%%endstr-%%str
2413 \c         mov     bx,%1
2414 \c         mov     ah,0x40
2415 \c         int     0x21
2417 \c %endmacro
2419 then the example call to \c{writefile} above will work as expected:
2420 the text before the first comma, \c{[filehandle]}, is used as the
2421 first macro parameter and expanded when \c{%1} is referred to, and
2422 all the subsequent text is lumped into \c{%2} and placed after the
2423 \c{db}.
2425 The greedy nature of the macro is indicated to NASM by the use of
2426 the \I{+ modifier}\c{+} sign after the parameter count on the
2427 \c{%macro} line.
2429 If you define a greedy macro, you are effectively telling NASM how
2430 it should expand the macro given \e{any} number of parameters from
2431 the actual number specified up to infinity; in this case, for
2432 example, NASM now knows what to do when it sees a call to
2433 \c{writefile} with 2, 3, 4 or more parameters. NASM will take this
2434 into account when overloading macros, and will not allow you to
2435 define another form of \c{writefile} taking 4 parameters (for
2436 example).
2438 Of course, the above macro could have been implemented as a
2439 non-greedy macro, in which case the call to it would have had to
2440 look like
2442 \c           writefile [filehandle], {"hello, world",13,10}
2444 NASM provides both mechanisms for putting \i{commas in macro
2445 parameters}, and you choose which one you prefer for each macro
2446 definition.
2448 See \k{sectmac} for a better way to write the above macro.
2451 \S{mlmacdef} \i{Default Macro Parameters}
2453 NASM also allows you to define a multi-line macro with a \e{range}
2454 of allowable parameter counts. If you do this, you can specify
2455 defaults for \i{omitted parameters}. So, for example:
2457 \c %macro  die 0-1 "Painful program death has occurred."
2459 \c         writefile 2,%1
2460 \c         mov     ax,0x4c01
2461 \c         int     0x21
2463 \c %endmacro
2465 This macro (which makes use of the \c{writefile} macro defined in
2466 \k{mlmacgre}) can be called with an explicit error message, which it
2467 will display on the error output stream before exiting, or it can be
2468 called with no parameters, in which case it will use the default
2469 error message supplied in the macro definition.
2471 In general, you supply a minimum and maximum number of parameters
2472 for a macro of this type; the minimum number of parameters are then
2473 required in the macro call, and then you provide defaults for the
2474 optional ones. So if a macro definition began with the line
2476 \c %macro foobar 1-3 eax,[ebx+2]
2478 then it could be called with between one and three parameters, and
2479 \c{%1} would always be taken from the macro call. \c{%2}, if not
2480 specified by the macro call, would default to \c{eax}, and \c{%3} if
2481 not specified would default to \c{[ebx+2]}.
2483 You can provide extra information to a macro by providing
2484 too many default parameters:
2486 \c %macro quux 1 something
2488 This will trigger a warning by default; see \k{opt-w} for
2489 more information.
2490 When \c{quux} is invoked, it receives not one but two parameters.
2491 \c{something} can be referred to as \c{%2}. The difference
2492 between passing \c{something} this way and writing \c{something}
2493 in the macro body is that with this way \c{something} is evaluated
2494 when the macro is defined, not when it is expanded.
2496 You may omit parameter defaults from the macro definition, in which
2497 case the parameter default is taken to be blank. This can be useful
2498 for macros which can take a variable number of parameters, since the
2499 \i\c{%0} token (see \k{percent0}) allows you to determine how many
2500 parameters were really passed to the macro call.
2502 This defaulting mechanism can be combined with the greedy-parameter
2503 mechanism; so the \c{die} macro above could be made more powerful,
2504 and more useful, by changing the first line of the definition to
2506 \c %macro die 0-1+ "Painful program death has occurred.",13,10
2508 The maximum parameter count can be infinite, denoted by \c{*}. In
2509 this case, of course, it is impossible to provide a \e{full} set of
2510 default parameters. Examples of this usage are shown in \k{rotate}.
2513 \S{percent0} \i\c{%0}: \I{counting macro parameters}Macro Parameter Counter
2515 The parameter reference \c{%0} will return a numeric constant giving the
2516 number of parameters received, that is, if \c{%0} is n then \c{%}n is the
2517 last parameter. \c{%0} is mostly useful for macros that can take a variable
2518 number of parameters. It can be used as an argument to \c{%rep}
2519 (see \k{rep}) in order to iterate through all the parameters of a macro.
2520 Examples are given in \k{rotate}.
2523 \S{rotate} \i\c{%rotate}: \i{Rotating Macro Parameters}
2525 Unix shell programmers will be familiar with the \I{shift
2526 command}\c{shift} shell command, which allows the arguments passed
2527 to a shell script (referenced as \c{$1}, \c{$2} and so on) to be
2528 moved left by one place, so that the argument previously referenced
2529 as \c{$2} becomes available as \c{$1}, and the argument previously
2530 referenced as \c{$1} is no longer available at all.
2532 NASM provides a similar mechanism, in the form of \c{%rotate}. As
2533 its name suggests, it differs from the Unix \c{shift} in that no
2534 parameters are lost: parameters rotated off the left end of the
2535 argument list reappear on the right, and vice versa.
2537 \c{%rotate} is invoked with a single numeric argument (which may be
2538 an expression). The macro parameters are rotated to the left by that
2539 many places. If the argument to \c{%rotate} is negative, the macro
2540 parameters are rotated to the right.
2542 \I{iterating over macro parameters}So a pair of macros to save and
2543 restore a set of registers might work as follows:
2545 \c %macro  multipush 1-*
2547 \c   %rep  %0
2548 \c         push    %1
2549 \c   %rotate 1
2550 \c   %endrep
2552 \c %endmacro
2554 This macro invokes the \c{PUSH} instruction on each of its arguments
2555 in turn, from left to right. It begins by pushing its first
2556 argument, \c{%1}, then invokes \c{%rotate} to move all the arguments
2557 one place to the left, so that the original second argument is now
2558 available as \c{%1}. Repeating this procedure as many times as there
2559 were arguments (achieved by supplying \c{%0} as the argument to
2560 \c{%rep}) causes each argument in turn to be pushed.
2562 Note also the use of \c{*} as the maximum parameter count,
2563 indicating that there is no upper limit on the number of parameters
2564 you may supply to the \i\c{multipush} macro.
2566 It would be convenient, when using this macro, to have a \c{POP}
2567 equivalent, which \e{didn't} require the arguments to be given in
2568 reverse order. Ideally, you would write the \c{multipush} macro
2569 call, then cut-and-paste the line to where the pop needed to be
2570 done, and change the name of the called macro to \c{multipop}, and
2571 the macro would take care of popping the registers in the opposite
2572 order from the one in which they were pushed.
2574 This can be done by the following definition:
2576 \c %macro  multipop 1-*
2578 \c   %rep %0
2579 \c   %rotate -1
2580 \c         pop     %1
2581 \c   %endrep
2583 \c %endmacro
2585 This macro begins by rotating its arguments one place to the
2586 \e{right}, so that the original \e{last} argument appears as \c{%1}.
2587 This is then popped, and the arguments are rotated right again, so
2588 the second-to-last argument becomes \c{%1}. Thus the arguments are
2589 iterated through in reverse order.
2592 \S{concat} \i{Concatenating Macro Parameters}
2594 NASM can concatenate macro parameters and macro indirection constructs
2595 on to other text surrounding them. This allows you to declare a family
2596 of symbols, for example, in a macro definition. If, for example, you
2597 wanted to generate a table of key codes along with offsets into the
2598 table, you could code something like
2600 \c %macro keytab_entry 2
2602 \c     keypos%1    equ     $-keytab
2603 \c                 db      %2
2605 \c %endmacro
2607 \c keytab:
2608 \c           keytab_entry F1,128+1
2609 \c           keytab_entry F2,128+2
2610 \c           keytab_entry Return,13
2612 which would expand to
2614 \c keytab:
2615 \c keyposF1        equ     $-keytab
2616 \c                 db     128+1
2617 \c keyposF2        equ     $-keytab
2618 \c                 db      128+2
2619 \c keyposReturn    equ     $-keytab
2620 \c                 db      13
2622 You can just as easily concatenate text on to the other end of a
2623 macro parameter, by writing \c{%1foo}.
2625 If you need to append a \e{digit} to a macro parameter, for example
2626 defining labels \c{foo1} and \c{foo2} when passed the parameter
2627 \c{foo}, you can't code \c{%11} because that would be taken as the
2628 eleventh macro parameter. Instead, you must code
2629 \I{braces, after % sign}\c{%\{1\}1}, which will separate the first
2630 \c{1} (giving the number of the macro parameter) from the second
2631 (literal text to be concatenated to the parameter).
2633 This concatenation can also be applied to other preprocessor in-line
2634 objects, such as macro-local labels (\k{maclocal}) and context-local
2635 labels (\k{ctxlocal}). In all cases, ambiguities in syntax can be
2636 resolved by enclosing everything after the \c{%} sign and before the
2637 literal text in braces: so \c{%\{%foo\}bar} concatenates the text
2638 \c{bar} to the end of the real name of the macro-local label
2639 \c{%%foo}. (This is unnecessary, since the form NASM uses for the
2640 real names of macro-local labels means that the two usages
2641 \c{%\{%foo\}bar} and \c{%%foobar} would both expand to the same
2642 thing anyway; nevertheless, the capability is there.)
2644 The single-line macro indirection construct, \c{%[...]}
2645 (\k{indmacro}), behaves the same way as macro parameters for the
2646 purpose of concatenation.
2648 See also the \c{%+} operator, \k{concat%+}.
2651 \S{mlmaccc} \i{Condition Codes as Macro Parameters}
2653 NASM can give special treatment to a macro parameter which contains
2654 a condition code. For a start, you can refer to the macro parameter
2655 \c{%1} by means of the alternative syntax \i\c{%+1}, which informs
2656 NASM that this macro parameter is supposed to contain a condition
2657 code, and will cause the preprocessor to report an error message if
2658 the macro is called with a parameter which is \e{not} a valid
2659 condition code.
2661 Far more usefully, though, you can refer to the macro parameter by
2662 means of \i\c{%-1}, which NASM will expand as the \e{inverse}
2663 condition code. So the \c{retz} macro defined in \k{maclocal} can be
2664 replaced by a general \i{conditional-return macro} like this:
2666 \c %macro  retc 1
2668 \c         j%-1    %%skip
2669 \c         ret
2670 \c   %%skip:
2672 \c %endmacro
2674 This macro can now be invoked using calls like \c{retc ne}, which
2675 will cause the conditional-jump instruction in the macro expansion
2676 to come out as \c{JE}, or \c{retc po} which will make the jump a
2677 \c{JPE}.
2679 The \c{%+1} macro-parameter reference is quite happy to interpret
2680 the arguments \c{CXZ} and \c{ECXZ} as valid condition codes;
2681 however, \c{%-1} will report an error if passed either of these,
2682 because no inverse condition code exists.
2685 \S{nolist} \i{Disabling Listing Expansion}\I\c{.nolist}
2687 When NASM is generating a listing file from your program, it will
2688 generally expand multi-line macros by means of writing the macro
2689 call and then listing each line of the expansion. This allows you to
2690 see which instructions in the macro expansion are generating what
2691 code; however, for some macros this clutters the listing up
2692 unnecessarily.
2694 NASM therefore provides the \c{.nolist} qualifier, which you can
2695 include in a macro definition to inhibit the expansion of the macro
2696 in the listing file. The \c{.nolist} qualifier comes directly after
2697 the number of parameters, like this:
2699 \c %macro foo 1.nolist
2701 Or like this:
2703 \c %macro bar 1-5+.nolist a,b,c,d,e,f,g,h
2705 \S{unmacro} Undefining Multi-Line Macros: \i\c{%unmacro}
2707 Multi-line macros can be removed with the \c{%unmacro} directive.
2708 Unlike the \c{%undef} directive, however, \c{%unmacro} takes an
2709 argument specification, and will only remove \i{exact matches} with
2710 that argument specification.
2712 For example:
2714 \c %macro foo 1-3
2715 \c         ; Do something
2716 \c %endmacro
2717 \c %unmacro foo 1-3
2719 removes the previously defined macro \c{foo}, but
2721 \c %macro bar 1-3
2722 \c         ; Do something
2723 \c %endmacro
2724 \c %unmacro bar 1
2726 does \e{not} remove the macro \c{bar}, since the argument
2727 specification does not match exactly.
2729 \H{condasm} \i{Conditional Assembly}\I\c{%if}
2731 Similarly to the C preprocessor, NASM allows sections of a source
2732 file to be assembled only if certain conditions are met. The general
2733 syntax of this feature looks like this:
2735 \c %if<condition>
2736 \c     ; some code which only appears if <condition> is met
2737 \c %elif<condition2>
2738 \c     ; only appears if <condition> is not met but <condition2> is
2739 \c %else
2740 \c     ; this appears if neither <condition> nor <condition2> was met
2741 \c %endif
2743 The inverse forms \i\c{%ifn} and \i\c{%elifn} are also supported.
2745 The \i\c{%else} clause is optional, as is the \i\c{%elif} clause.
2746 You can have more than one \c{%elif} clause as well.
2748 There are a number of variants of the \c{%if} directive.  Each has its
2749 corresponding \c{%elif}, \c{%ifn}, and \c{%elifn} directives; for
2750 example, the equivalents to the \c{%ifdef} directive are \c{%elifdef},
2751 \c{%ifndef}, and \c{%elifndef}.
2753 \S{ifdef} \i\c{%ifdef}: Testing Single-Line Macro Existence\I{testing,
2754 single-line macro existence}
2756 Beginning a conditional-assembly block with the line \c{%ifdef
2757 MACRO} will assemble the subsequent code if, and only if, a
2758 single-line macro called \c{MACRO} is defined. If not, then the
2759 \c{%elif} and \c{%else} blocks (if any) will be processed instead.
2761 For example, when debugging a program, you might want to write code
2762 such as
2764 \c           ; perform some function
2765 \c %ifdef DEBUG
2766 \c           writefile 2,"Function performed successfully",13,10
2767 \c %endif
2768 \c           ; go and do something else
2770 Then you could use the command-line option \c{-dDEBUG} to create a
2771 version of the program which produced debugging messages, and remove
2772 the option to generate the final release version of the program.
2774 You can test for a macro \e{not} being defined by using
2775 \i\c{%ifndef} instead of \c{%ifdef}. You can also test for macro
2776 definitions in \c{%elif} blocks by using \i\c{%elifdef} and
2777 \i\c{%elifndef}.
2780 \S{ifmacro} \i\c{%ifmacro}: Testing Multi-Line Macro
2781 Existence\I{testing, multi-line macro existence}
2783 The \c{%ifmacro} directive operates in the same way as the \c{%ifdef}
2784 directive, except that it checks for the existence of a multi-line macro.
2786 For example, you may be working with a large project and not have control
2787 over the macros in a library. You may want to create a macro with one
2788 name if it doesn't already exist, and another name if one with that name
2789 does exist.
2791 The \c{%ifmacro} is considered true if defining a macro with the given name
2792 and number of arguments would cause a definitions conflict. For example:
2794 \c %ifmacro MyMacro 1-3
2796 \c      %error "MyMacro 1-3" causes a conflict with an existing macro.
2798 \c %else
2800 \c      %macro MyMacro 1-3
2802 \c              ; insert code to define the macro
2804 \c      %endmacro
2806 \c %endif
2808 This will create the macro "MyMacro 1-3" if no macro already exists which
2809 would conflict with it, and emits a warning if there would be a definition
2810 conflict.
2812 You can test for the macro not existing by using the \i\c{%ifnmacro} instead
2813 of \c{%ifmacro}. Additional tests can be performed in \c{%elif} blocks by using
2814 \i\c{%elifmacro} and \i\c{%elifnmacro}.
2817 \S{ifctx} \i\c{%ifctx}: Testing the Context Stack\I{testing, context
2818 stack}
2820 The conditional-assembly construct \c{%ifctx} will cause the
2821 subsequent code to be assembled if and only if the top context on
2822 the preprocessor's context stack has the same name as one of the arguments.
2823 As with \c{%ifdef}, the inverse and \c{%elif} forms \i\c{%ifnctx},
2824 \i\c{%elifctx} and \i\c{%elifnctx} are also supported.
2826 For more details of the context stack, see \k{ctxstack}. For a
2827 sample use of \c{%ifctx}, see \k{blockif}.
2830 \S{if} \i\c{%if}: Testing Arbitrary Numeric Expressions\I{testing,
2831 arbitrary numeric expressions}
2833 The conditional-assembly construct \c{%if expr} will cause the
2834 subsequent code to be assembled if and only if the value of the
2835 numeric expression \c{expr} is non-zero. An example of the use of
2836 this feature is in deciding when to break out of a \c{%rep}
2837 preprocessor loop: see \k{rep} for a detailed example.
2839 The expression given to \c{%if}, and its counterpart \i\c{%elif}, is
2840 a critical expression (see \k{crit}).
2842 \c{%if} extends the normal NASM expression syntax, by providing a
2843 set of \i{relational operators} which are not normally available in
2844 expressions. The operators \i\c{=}, \i\c{<}, \i\c{>}, \i\c{<=},
2845 \i\c{>=} and \i\c{<>} test equality, less-than, greater-than,
2846 less-or-equal, greater-or-equal and not-equal respectively. The
2847 C-like forms \i\c{==} and \i\c{!=} are supported as alternative
2848 forms of \c{=} and \c{<>}. In addition, low-priority logical
2849 operators \i\c{&&}, \i\c{^^} and \i\c{||} are provided, supplying
2850 \i{logical AND}, \i{logical XOR} and \i{logical OR}. These work like
2851 the C logical operators (although C has no logical XOR), in that
2852 they always return either 0 or 1, and treat any non-zero input as 1
2853 (so that \c{^^}, for example, returns 1 if exactly one of its inputs
2854 is zero, and 0 otherwise). The relational operators also return 1
2855 for true and 0 for false.
2857 Like other \c{%if} constructs, \c{%if} has a counterpart
2858 \i\c{%elif}, and negative forms \i\c{%ifn} and \i\c{%elifn}.
2860 \S{ifidn} \i\c{%ifidn} and \i\c{%ifidni}: Testing Exact Text
2861 Identity\I{testing, exact text identity}
2863 The construct \c{%ifidn text1,text2} will cause the subsequent code
2864 to be assembled if and only if \c{text1} and \c{text2}, after
2865 expanding single-line macros, are identical pieces of text.
2866 Differences in white space are not counted.
2868 \c{%ifidni} is similar to \c{%ifidn}, but is \i{case-insensitive}.
2870 For example, the following macro pushes a register or number on the
2871 stack, and allows you to treat \c{IP} as a real register:
2873 \c %macro  pushparam 1
2875 \c   %ifidni %1,ip
2876 \c         call    %%label
2877 \c   %%label:
2878 \c   %else
2879 \c         push    %1
2880 \c   %endif
2882 \c %endmacro
2884 Like other \c{%if} constructs, \c{%ifidn} has a counterpart
2885 \i\c{%elifidn}, and negative forms \i\c{%ifnidn} and \i\c{%elifnidn}.
2886 Similarly, \c{%ifidni} has counterparts \i\c{%elifidni},
2887 \i\c{%ifnidni} and \i\c{%elifnidni}.
2889 \S{iftyp} \i\c{%ifid}, \i\c{%ifnum}, \i\c{%ifstr}: Testing Token
2890 Types\I{testing, token types}
2892 Some macros will want to perform different tasks depending on
2893 whether they are passed a number, a string, or an identifier. For
2894 example, a string output macro might want to be able to cope with
2895 being passed either a string constant or a pointer to an existing
2896 string.
2898 The conditional assembly construct \c{%ifid}, taking one parameter
2899 (which may be blank), assembles the subsequent code if and only if
2900 the first token in the parameter exists and is an identifier.
2901 \c{%ifnum} works similarly, but tests for the token being a numeric
2902 constant; \c{%ifstr} tests for it being a string.
2904 For example, the \c{writefile} macro defined in \k{mlmacgre} can be
2905 extended to take advantage of \c{%ifstr} in the following fashion:
2907 \c %macro writefile 2-3+
2909 \c   %ifstr %2
2910 \c         jmp     %%endstr
2911 \c     %if %0 = 3
2912 \c       %%str:    db      %2,%3
2913 \c     %else
2914 \c       %%str:    db      %2
2915 \c     %endif
2916 \c       %%endstr: mov     dx,%%str
2917 \c                 mov     cx,%%endstr-%%str
2918 \c   %else
2919 \c                 mov     dx,%2
2920 \c                 mov     cx,%3
2921 \c   %endif
2922 \c                 mov     bx,%1
2923 \c                 mov     ah,0x40
2924 \c                 int     0x21
2926 \c %endmacro
2928 Then the \c{writefile} macro can cope with being called in either of
2929 the following two ways:
2931 \c         writefile [file], strpointer, length
2932 \c         writefile [file], "hello", 13, 10
2934 In the first, \c{strpointer} is used as the address of an
2935 already-declared string, and \c{length} is used as its length; in
2936 the second, a string is given to the macro, which therefore declares
2937 it itself and works out the address and length for itself.
2939 Note the use of \c{%if} inside the \c{%ifstr}: this is to detect
2940 whether the macro was passed two arguments (so the string would be a
2941 single string constant, and \c{db %2} would be adequate) or more (in
2942 which case, all but the first two would be lumped together into
2943 \c{%3}, and \c{db %2,%3} would be required).
2945 The usual \I\c{%elifid}\I\c{%elifnum}\I\c{%elifstr}\c{%elif}...,
2946 \I\c{%ifnid}\I\c{%ifnnum}\I\c{%ifnstr}\c{%ifn}..., and
2947 \I\c{%elifnid}\I\c{%elifnnum}\I\c{%elifnstr}\c{%elifn}... versions
2948 exist for each of \c{%ifid}, \c{%ifnum} and \c{%ifstr}.
2950 \S{iftoken} \i\c{%iftoken}: Test for a Single Token
2952 Some macros will want to do different things depending on if it is
2953 passed a single token (e.g. paste it to something else using \c{%+})
2954 versus a multi-token sequence.
2956 The conditional assembly construct \c{%iftoken} assembles the
2957 subsequent code if and only if the expanded parameters consist of
2958 exactly one token, possibly surrounded by whitespace.
2960 For example:
2962 \c %iftoken 1
2964 will assemble the subsequent code, but
2966 \c %iftoken -1
2968 will not, since \c{-1} contains two tokens: the unary minus operator
2969 \c{-}, and the number \c{1}.
2971 The usual \i\c{%eliftoken}, \i\c\{%ifntoken}, and \i\c{%elifntoken}
2972 variants are also provided.
2974 \S{ifempty} \i\c{%ifempty}: Test for Empty Expansion
2976 The conditional assembly construct \c{%ifempty} assembles the
2977 subsequent code if and only if the expanded parameters do not contain
2978 any tokens at all, whitespace excepted.
2980 The usual \i\c{%elifempty}, \i\c\{%ifnempty}, and \i\c{%elifnempty}
2981 variants are also provided.
2983 \H{rep} \i{Preprocessor Loops}\I{repeating code}: \i\c{%rep}
2985 NASM's \c{TIMES} prefix, though useful, cannot be used to invoke a
2986 multi-line macro multiple times, because it is processed by NASM
2987 after macros have already been expanded. Therefore NASM provides
2988 another form of loop, this time at the preprocessor level: \c{%rep}.
2990 The directives \c{%rep} and \i\c{%endrep} (\c{%rep} takes a numeric
2991 argument, which can be an expression; \c{%endrep} takes no
2992 arguments) can be used to enclose a chunk of code, which is then
2993 replicated as many times as specified by the preprocessor:
2995 \c %assign i 0
2996 \c %rep    64
2997 \c         inc     word [table+2*i]
2998 \c %assign i i+1
2999 \c %endrep
3001 This will generate a sequence of 64 \c{INC} instructions,
3002 incrementing every word of memory from \c{[table]} to
3003 \c{[table+126]}.
3005 For more complex termination conditions, or to break out of a repeat
3006 loop part way along, you can use the \i\c{%exitrep} directive to
3007 terminate the loop, like this:
3009 \c fibonacci:
3010 \c %assign i 0
3011 \c %assign j 1
3012 \c %rep 100
3013 \c %if j > 65535
3014 \c     %exitrep
3015 \c %endif
3016 \c         dw j
3017 \c %assign k j+i
3018 \c %assign i j
3019 \c %assign j k
3020 \c %endrep
3022 \c fib_number equ ($-fibonacci)/2
3024 This produces a list of all the Fibonacci numbers that will fit in
3025 16 bits. Note that a maximum repeat count must still be given to
3026 \c{%rep}. This is to prevent the possibility of NASM getting into an
3027 infinite loop in the preprocessor, which (on multitasking or
3028 multi-user systems) would typically cause all the system memory to
3029 be gradually used up and other applications to start crashing.
3032 \H{files} Source Files and Dependencies
3034 These commands allow you to split your sources into multiple files.
3036 \S{include} \i\c{%include}: \i{Including Other Files} 
3038 Using, once again, a very similar syntax to the C preprocessor,
3039 NASM's preprocessor lets you include other source files into your
3040 code. This is done by the use of the \i\c{%include} directive:
3042 \c %include "macros.mac"
3044 will include the contents of the file \c{macros.mac} into the source
3045 file containing the \c{%include} directive.
3047 Include files are \I{searching for include files}searched for in the
3048 current directory (the directory you're in when you run NASM, as
3049 opposed to the location of the NASM executable or the location of
3050 the source file), plus any directories specified on the NASM command
3051 line using the \c{-i} option.
3053 The standard C idiom for preventing a file being included more than
3054 once is just as applicable in NASM: if the file \c{macros.mac} has
3055 the form
3057 \c %ifndef MACROS_MAC
3058 \c     %define MACROS_MAC
3059 \c     ; now define some macros
3060 \c %endif
3062 then including the file more than once will not cause errors,
3063 because the second time the file is included nothing will happen
3064 because the macro \c{MACROS_MAC} will already be defined.
3066 You can force a file to be included even if there is no \c{%include}
3067 directive that explicitly includes it, by using the \i\c{-p} option
3068 on the NASM command line (see \k{opt-p}).
3071 \S{pathsearch} \i\c{%pathsearch}: Search the Include Path
3073 The \c{%pathsearch} directive takes a single-line macro name and a
3074 filename, and declare or redefines the specified single-line macro to
3075 be the include-path-resolved verson of the filename, if the file
3076 exists (otherwise, it is passed unchanged.)
3078 For example,
3080 \c %pathsearch MyFoo "foo.bin"
3082 ... with \c{-Ibins/} in the include path may end up defining the macro
3083 \c{MyFoo} to be \c{"bins/foo.bin"}.
3086 \S{depend} \i\c{%depend}: Add Dependent Files
3088 The \c{%depend} directive takes a filename and adds it to the list of
3089 files to be emitted as dependency generation when the \c{-M} options
3090 and its relatives (see \k{opt-M}) are used.  It produces no output.
3092 This is generally used in conjunction with \c{%pathsearch}.  For
3093 example, a simplified version of the standard macro wrapper for the
3094 \c{INCBIN} directive looks like:
3096 \c %imacro incbin 1-2+ 0
3097 \c %pathsearch dep %1
3098 \c %depend dep
3099 \c         incbin dep,%2
3100 \c %endmacro
3102 This first resolves the location of the file into the macro \c{dep},
3103 then adds it to the dependency lists, and finally issues the
3104 assembler-level \c{INCBIN} directive.
3107 \S{use} \i\c{%use}: Include Standard Macro Package
3109 The \c{%use} directive is similar to \c{%include}, but rather than
3110 including the contents of a file, it includes a named standard macro
3111 package.  The standard macro packages are part of NASM, and are
3112 described in \k{macropkg}.
3114 Unlike the \c{%include} directive, package names for the \c{%use}
3115 directive do not require quotes, but quotes are permitted.  In NASM
3116 2.04 and 2.05 the unquoted form would be macro-expanded; this is no
3117 longer true.  Thus, the following lines are equivalent:
3119 \c %use altreg
3120 \c %use 'altreg'
3122 Standard macro packages are protected from multiple inclusion.  When a
3123 standard macro package is used, a testable single-line macro of the
3124 form \c{__USE_}\e{package}\c{__} is also defined, see \k{use_def}.
3126 \H{ctxstack} The \i{Context Stack}
3128 Having labels that are local to a macro definition is sometimes not
3129 quite powerful enough: sometimes you want to be able to share labels
3130 between several macro calls. An example might be a \c{REPEAT} ...
3131 \c{UNTIL} loop, in which the expansion of the \c{REPEAT} macro
3132 would need to be able to refer to a label which the \c{UNTIL} macro
3133 had defined. However, for such a macro you would also want to be
3134 able to nest these loops.
3136 NASM provides this level of power by means of a \e{context stack}.
3137 The preprocessor maintains a stack of \e{contexts}, each of which is
3138 characterized by a name. You add a new context to the stack using
3139 the \i\c{%push} directive, and remove one using \i\c{%pop}. You can
3140 define labels that are local to a particular context on the stack.
3143 \S{pushpop} \i\c{%push} and \i\c{%pop}: \I{creating
3144 contexts}\I{removing contexts}Creating and Removing Contexts
3146 The \c{%push} directive is used to create a new context and place it
3147 on the top of the context stack. \c{%push} takes an optional argument,
3148 which is the name of the context. For example:
3150 \c %push    foobar
3152 This pushes a new context called \c{foobar} on the stack. You can have
3153 several contexts on the stack with the same name: they can still be
3154 distinguished.  If no name is given, the context is unnamed (this is
3155 normally used when both the \c{%push} and the \c{%pop} are inside a
3156 single macro definition.)
3158 The directive \c{%pop}, taking one optional argument, removes the top
3159 context from the context stack and destroys it, along with any
3160 labels associated with it.  If an argument is given, it must match the
3161 name of the current context, otherwise it will issue an error.
3164 \S{ctxlocal} \i{Context-Local Labels}
3166 Just as the usage \c{%%foo} defines a label which is local to the
3167 particular macro call in which it is used, the usage \I{%$}\c{%$foo}
3168 is used to define a label which is local to the context on the top
3169 of the context stack. So the \c{REPEAT} and \c{UNTIL} example given
3170 above could be implemented by means of:
3172 \c %macro repeat 0
3174 \c     %push   repeat
3175 \c     %$begin:
3177 \c %endmacro
3179 \c %macro until 1
3181 \c         j%-1    %$begin
3182 \c     %pop
3184 \c %endmacro
3186 and invoked by means of, for example,
3188 \c         mov     cx,string
3189 \c         repeat
3190 \c         add     cx,3
3191 \c         scasb
3192 \c         until   e
3194 which would scan every fourth byte of a string in search of the byte
3195 in \c{AL}.
3197 If you need to define, or access, labels local to the context
3198 \e{below} the top one on the stack, you can use \I{%$$}\c{%$$foo}, or
3199 \c{%$$$foo} for the context below that, and so on.
3202 \S{ctxdefine} \i{Context-Local Single-Line Macros}
3204 NASM also allows you to define single-line macros which are local to
3205 a particular context, in just the same way:
3207 \c %define %$localmac 3
3209 will define the single-line macro \c{%$localmac} to be local to the
3210 top context on the stack. Of course, after a subsequent \c{%push},
3211 it can then still be accessed by the name \c{%$$localmac}.
3214 \S{ctxrepl} \i\c{%repl}: \I{renaming contexts}Renaming a Context
3216 If you need to change the name of the top context on the stack (in
3217 order, for example, to have it respond differently to \c{%ifctx}),
3218 you can execute a \c{%pop} followed by a \c{%push}; but this will
3219 have the side effect of destroying all context-local labels and
3220 macros associated with the context that was just popped.
3222 NASM provides the directive \c{%repl}, which \e{replaces} a context
3223 with a different name, without touching the associated macros and
3224 labels. So you could replace the destructive code
3226 \c %pop
3227 \c %push   newname
3229 with the non-destructive version \c{%repl newname}.
3232 \S{blockif} Example Use of the \i{Context Stack}: \i{Block IFs}
3234 This example makes use of almost all the context-stack features,
3235 including the conditional-assembly construct \i\c{%ifctx}, to
3236 implement a block IF statement as a set of macros.
3238 \c %macro if 1
3240 \c     %push if
3241 \c     j%-1  %$ifnot
3243 \c %endmacro
3245 \c %macro else 0
3247 \c   %ifctx if
3248 \c         %repl   else
3249 \c         jmp     %$ifend
3250 \c         %$ifnot:
3251 \c   %else
3252 \c         %error  "expected `if' before `else'"
3253 \c   %endif
3255 \c %endmacro
3257 \c %macro endif 0
3259 \c   %ifctx if
3260 \c         %$ifnot:
3261 \c         %pop
3262 \c   %elifctx      else
3263 \c         %$ifend:
3264 \c         %pop
3265 \c   %else
3266 \c         %error  "expected `if' or `else' before `endif'"
3267 \c   %endif
3269 \c %endmacro
3271 This code is more robust than the \c{REPEAT} and \c{UNTIL} macros
3272 given in \k{ctxlocal}, because it uses conditional assembly to check
3273 that the macros are issued in the right order (for example, not
3274 calling \c{endif} before \c{if}) and issues a \c{%error} if they're
3275 not.
3277 In addition, the \c{endif} macro has to be able to cope with the two
3278 distinct cases of either directly following an \c{if}, or following
3279 an \c{else}. It achieves this, again, by using conditional assembly
3280 to do different things depending on whether the context on top of
3281 the stack is \c{if} or \c{else}.
3283 The \c{else} macro has to preserve the context on the stack, in
3284 order to have the \c{%$ifnot} referred to by the \c{if} macro be the
3285 same as the one defined by the \c{endif} macro, but has to change
3286 the context's name so that \c{endif} will know there was an
3287 intervening \c{else}. It does this by the use of \c{%repl}.
3289 A sample usage of these macros might look like:
3291 \c         cmp     ax,bx
3293 \c         if ae
3294 \c                cmp     bx,cx
3296 \c                if ae
3297 \c                        mov     ax,cx
3298 \c                else
3299 \c                        mov     ax,bx
3300 \c                endif
3302 \c         else
3303 \c                cmp     ax,cx
3305 \c                if ae
3306 \c                        mov     ax,cx
3307 \c                endif
3309 \c         endif
3311 The block-\c{IF} macros handle nesting quite happily, by means of
3312 pushing another context, describing the inner \c{if}, on top of the
3313 one describing the outer \c{if}; thus \c{else} and \c{endif} always
3314 refer to the last unmatched \c{if} or \c{else}.
3317 \H{stackrel} \i{Stack Relative Preprocessor Directives}
3319 The following preprocessor directives provide a way to use
3320 labels to refer to local variables allocated on the stack.
3322 \b\c{%arg}  (see \k{arg})
3324 \b\c{%stacksize}  (see \k{stacksize})
3326 \b\c{%local}  (see \k{local})
3329 \S{arg} \i\c{%arg} Directive
3331 The \c{%arg} directive is used to simplify the handling of
3332 parameters passed on the stack. Stack based parameter passing
3333 is used by many high level languages, including C, C++ and Pascal.
3335 While NASM has macros which attempt to duplicate this
3336 functionality (see \k{16cmacro}), the syntax is not particularly
3337 convenient to use. and is not TASM compatible. Here is an example
3338 which shows the use of \c{%arg} without any external macros:
3340 \c some_function:
3342 \c     %push     mycontext        ; save the current context
3343 \c     %stacksize large           ; tell NASM to use bp
3344 \c     %arg      i:word, j_ptr:word
3346 \c         mov     ax,[i]
3347 \c         mov     bx,[j_ptr]
3348 \c         add     ax,[bx]
3349 \c         ret
3351 \c     %pop                       ; restore original context
3353 This is similar to the procedure defined in \k{16cmacro} and adds
3354 the value in i to the value pointed to by j_ptr and returns the
3355 sum in the ax register. See \k{pushpop} for an explanation of
3356 \c{push} and \c{pop} and the use of context stacks.
3359 \S{stacksize} \i\c{%stacksize} Directive
3361 The \c{%stacksize} directive is used in conjunction with the
3362 \c{%arg} (see \k{arg}) and the \c{%local} (see \k{local}) directives.
3363 It tells NASM the default size to use for subsequent \c{%arg} and
3364 \c{%local} directives. The \c{%stacksize} directive takes one
3365 required argument which is one of \c{flat}, \c{flat64}, \c{large} or \c{small}.
3367 \c %stacksize flat
3369 This form causes NASM to use stack-based parameter addressing
3370 relative to \c{ebp} and it assumes that a near form of call was used
3371 to get to this label (i.e. that \c{eip} is on the stack).
3373 \c %stacksize flat64
3375 This form causes NASM to use stack-based parameter addressing
3376 relative to \c{rbp} and it assumes that a near form of call was used
3377 to get to this label (i.e. that \c{rip} is on the stack).
3379 \c %stacksize large
3381 This form uses \c{bp} to do stack-based parameter addressing and
3382 assumes that a far form of call was used to get to this address
3383 (i.e. that \c{ip} and \c{cs} are on the stack).
3385 \c %stacksize small
3387 This form also uses \c{bp} to address stack parameters, but it is
3388 different from \c{large} because it also assumes that the old value
3389 of bp is pushed onto the stack (i.e. it expects an \c{ENTER}
3390 instruction). In other words, it expects that \c{bp}, \c{ip} and
3391 \c{cs} are on the top of the stack, underneath any local space which
3392 may have been allocated by \c{ENTER}. This form is probably most
3393 useful when used in combination with the \c{%local} directive
3394 (see \k{local}).
3397 \S{local} \i\c{%local} Directive
3399 The \c{%local} directive is used to simplify the use of local
3400 temporary stack variables allocated in a stack frame. Automatic
3401 local variables in C are an example of this kind of variable. The
3402 \c{%local} directive is most useful when used with the \c{%stacksize}
3403 (see \k{stacksize} and is also compatible with the \c{%arg} directive
3404 (see \k{arg}). It allows simplified reference to variables on the
3405 stack which have been allocated typically by using the \c{ENTER}
3406 instruction.
3407 \# (see \k{insENTER} for a description of that instruction).
3408 An example of its use is the following:
3410 \c silly_swap:
3412 \c     %push mycontext             ; save the current context
3413 \c     %stacksize small            ; tell NASM to use bp
3414 \c     %assign %$localsize 0       ; see text for explanation
3415 \c     %local old_ax:word, old_dx:word
3417 \c         enter   %$localsize,0   ; see text for explanation
3418 \c         mov     [old_ax],ax     ; swap ax & bx
3419 \c         mov     [old_dx],dx     ; and swap dx & cx
3420 \c         mov     ax,bx
3421 \c         mov     dx,cx
3422 \c         mov     bx,[old_ax]
3423 \c         mov     cx,[old_dx]
3424 \c         leave                   ; restore old bp
3425 \c         ret                     ;
3427 \c     %pop                        ; restore original context
3429 The \c{%$localsize} variable is used internally by the
3430 \c{%local} directive and \e{must} be defined within the
3431 current context before the \c{%local} directive may be used.
3432 Failure to do so will result in one expression syntax error for
3433 each \c{%local} variable declared. It then may be used in
3434 the construction of an appropriately sized ENTER instruction
3435 as shown in the example.
3438 \H{pperror} Reporting \i{User-Defined Errors}: \i\c{%error}, \i\c{%warning}, \i\c{%fatal}
3440 The preprocessor directive \c{%error} will cause NASM to report an
3441 error if it occurs in assembled code. So if other users are going to
3442 try to assemble your source files, you can ensure that they define the
3443 right macros by means of code like this:
3445 \c %ifdef F1
3446 \c     ; do some setup
3447 \c %elifdef F2
3448 \c     ; do some different setup
3449 \c %else
3450 \c     %error "Neither F1 nor F2 was defined."
3451 \c %endif
3453 Then any user who fails to understand the way your code is supposed
3454 to be assembled will be quickly warned of their mistake, rather than
3455 having to wait until the program crashes on being run and then not
3456 knowing what went wrong.
3458 Similarly, \c{%warning} issues a warning, but allows assembly to continue:
3460 \c %ifdef F1
3461 \c     ; do some setup
3462 \c %elifdef F2
3463 \c     ; do some different setup
3464 \c %else
3465 \c     %warning "Neither F1 nor F2 was defined, assuming F1."
3466 \c     %define F1
3467 \c %endif
3469 \c{%error} and \c{%warning} are issued only on the final assembly
3470 pass.  This makes them safe to use in conjunction with tests that
3471 depend on symbol values.
3473 \c{%fatal} terminates assembly immediately, regardless of pass.  This
3474 is useful when there is no point in continuing the assembly further,
3475 and doing so is likely just going to cause a spew of confusing error
3476 messages.
3478 It is optional for the message string after \c{%error}, \c{%warning}
3479 or \c{%fatal} to be quoted.  If it is \e{not}, then single-line macros
3480 are expanded in it, which can be used to display more information to
3481 the user.  For example:
3483 \c %if foo > 64
3484 \c     %assign foo_over foo-64
3485 \c     %error foo is foo_over bytes too large
3486 \c %endif
3489 \H{otherpreproc} \i{Other Preprocessor Directives}
3491 NASM also has preprocessor directives which allow access to
3492 information from external sources. Currently they include:
3494 \b\c{%line} enables NASM to correctly handle the output of another
3495 preprocessor (see \k{line}).
3497 \b\c{%!} enables NASM to read in the value of an environment variable,
3498 which can then be used in your program (see \k{getenv}).
3500 \S{line} \i\c{%line} Directive
3502 The \c{%line} directive is used to notify NASM that the input line
3503 corresponds to a specific line number in another file.  Typically
3504 this other file would be an original source file, with the current
3505 NASM input being the output of a pre-processor.  The \c{%line}
3506 directive allows NASM to output messages which indicate the line
3507 number of the original source file, instead of the file that is being
3508 read by NASM.
3510 This preprocessor directive is not generally of use to programmers,
3511 by may be of interest to preprocessor authors.  The usage of the
3512 \c{%line} preprocessor directive is as follows:
3514 \c %line nnn[+mmm] [filename]
3516 In this directive, \c{nnn} identifies the line of the original source
3517 file which this line corresponds to.  \c{mmm} is an optional parameter
3518 which specifies a line increment value; each line of the input file
3519 read in is considered to correspond to \c{mmm} lines of the original
3520 source file.  Finally, \c{filename} is an optional parameter which
3521 specifies the file name of the original source file.
3523 After reading a \c{%line} preprocessor directive, NASM will report
3524 all file name and line numbers relative to the values specified
3525 therein.
3528 \S{getenv} \i\c{%!}\c{<env>}: Read an environment variable.
3530 The \c{%!<env>} directive makes it possible to read the value of an
3531 environment variable at assembly time. This could, for example, be used
3532 to store the contents of an environment variable into a string, which
3533 could be used at some other point in your code.
3535 For example, suppose that you have an environment variable \c{FOO}, and
3536 you want the contents of \c{FOO} to be embedded in your program. You
3537 could do that as follows:
3539 \c %defstr FOO    %!FOO
3541 See \k{defstr} for notes on the \c{%defstr} directive.
3544 \H{stdmac} \i{Standard Macros}
3546 NASM defines a set of standard macros, which are already defined
3547 when it starts to process any source file. If you really need a
3548 program to be assembled with no pre-defined macros, you can use the
3549 \i\c{%clear} directive to empty the preprocessor of everything but
3550 context-local preprocessor variables and single-line macros.
3552 Most \i{user-level assembler directives} (see \k{directive}) are
3553 implemented as macros which invoke primitive directives; these are
3554 described in \k{directive}. The rest of the standard macro set is
3555 described here.
3558 \S{stdmacver} \i{NASM Version} Macros
3560 The single-line macros \i\c{__NASM_MAJOR__}, \i\c{__NASM_MINOR__},
3561 \i\c{__NASM_SUBMINOR__} and \i\c{___NASM_PATCHLEVEL__} expand to the
3562 major, minor, subminor and patch level parts of the \i{version
3563 number of NASM} being used. So, under NASM 0.98.32p1 for
3564 example, \c{__NASM_MAJOR__} would be defined to be 0, \c{__NASM_MINOR__}
3565 would be defined as 98, \c{__NASM_SUBMINOR__} would be defined to 32,
3566 and \c{___NASM_PATCHLEVEL__} would be defined as 1.
3568 Additionally, the macro \i\c{__NASM_SNAPSHOT__} is defined for
3569 automatically generated snapshot releases \e{only}.
3572 \S{stdmacverid} \i\c{__NASM_VERSION_ID__}: \i{NASM Version ID}
3574 The single-line macro \c{__NASM_VERSION_ID__} expands to a dword integer
3575 representing the full version number of the version of nasm being used.
3576 The value is the equivalent to \c{__NASM_MAJOR__}, \c{__NASM_MINOR__},
3577 \c{__NASM_SUBMINOR__} and \c{___NASM_PATCHLEVEL__} concatenated to
3578 produce a single doubleword. Hence, for 0.98.32p1, the returned number
3579 would be equivalent to:
3581 \c         dd      0x00622001
3585 \c         db      1,32,98,0
3587 Note that the above lines are generate exactly the same code, the second
3588 line is used just to give an indication of the order that the separate
3589 values will be present in memory.
3592 \S{stdmacverstr} \i\c{__NASM_VER__}: \i{NASM Version string}
3594 The single-line macro \c{__NASM_VER__} expands to a string which defines
3595 the version number of nasm being used. So, under NASM 0.98.32 for example,
3597 \c         db      __NASM_VER__
3599 would expand to
3601 \c         db      "0.98.32"
3604 \S{fileline} \i\c{__FILE__} and \i\c{__LINE__}: File Name and Line Number
3606 Like the C preprocessor, NASM allows the user to find out the file
3607 name and line number containing the current instruction. The macro
3608 \c{__FILE__} expands to a string constant giving the name of the
3609 current input file (which may change through the course of assembly
3610 if \c{%include} directives are used), and \c{__LINE__} expands to a
3611 numeric constant giving the current line number in the input file.
3613 These macros could be used, for example, to communicate debugging
3614 information to a macro, since invoking \c{__LINE__} inside a macro
3615 definition (either single-line or multi-line) will return the line
3616 number of the macro \e{call}, rather than \e{definition}. So to
3617 determine where in a piece of code a crash is occurring, for
3618 example, one could write a routine \c{stillhere}, which is passed a
3619 line number in \c{EAX} and outputs something like `line 155: still
3620 here'. You could then write a macro
3622 \c %macro  notdeadyet 0
3624 \c         push    eax
3625 \c         mov     eax,__LINE__
3626 \c         call    stillhere
3627 \c         pop     eax
3629 \c %endmacro
3631 and then pepper your code with calls to \c{notdeadyet} until you
3632 find the crash point.
3635 \S{bitsm} \i\c{__BITS__}: Current BITS Mode
3637 The \c{__BITS__} standard macro is updated every time that the BITS mode is
3638 set using the \c{BITS XX} or \c{[BITS XX]} directive, where XX is a valid mode
3639 number of 16, 32 or 64. \c{__BITS__} receives the specified mode number and
3640 makes it globally available. This can be very useful for those who utilize
3641 mode-dependent macros.
3643 \S{ofmtm} \i\c{__OUTPUT_FORMAT__}: Current Output Format
3645 The \c{__OUTPUT_FORMAT__} standard macro holds the current Output Format,
3646 as given by the \c{-f} option or NASM's default. Type \c{nasm -hf} for a
3647 list.
3649 \c %ifidn __OUTPUT_FORMAT__, win32
3650 \c  %define NEWLINE 13, 10
3651 \c %elifidn __OUTPUT_FORMAT__, elf32
3652 \c  %define NEWLINE 10
3653 \c %endif
3656 \S{datetime} Assembly Date and Time Macros
3658 NASM provides a variety of macros that represent the timestamp of the
3659 assembly session.
3661 \b The \i\c{__DATE__} and \i\c{__TIME__} macros give the assembly date and
3662 time as strings, in ISO 8601 format (\c{"YYYY-MM-DD"} and \c{"HH:MM:SS"},
3663 respectively.)
3665 \b The \i\c{__DATE_NUM__} and \i\c{__TIME_NUM__} macros give the assembly
3666 date and time in numeric form; in the format \c{YYYYMMDD} and
3667 \c{HHMMSS} respectively.
3669 \b The \i\c{__UTC_DATE__} and \i\c{__UTC_TIME__} macros give the assembly
3670 date and time in universal time (UTC) as strings, in ISO 8601 format
3671 (\c{"YYYY-MM-DD"} and \c{"HH:MM:SS"}, respectively.)  If the host
3672 platform doesn't provide UTC time, these macros are undefined.
3674 \b The \i\c{__UTC_DATE_NUM__} and \i\c{__UTC_TIME_NUM__} macros give the
3675 assembly date and time universal time (UTC) in numeric form; in the
3676 format \c{YYYYMMDD} and \c{HHMMSS} respectively.  If the
3677 host platform doesn't provide UTC time, these macros are
3678 undefined.
3680 \b The \c{__POSIX_TIME__} macro is defined as a number containing the
3681 number of seconds since the POSIX epoch, 1 January 1970 00:00:00 UTC;
3682 excluding any leap seconds.  This is computed using UTC time if
3683 available on the host platform, otherwise it is computed using the
3684 local time as if it was UTC.
3686 All instances of time and date macros in the same assembly session
3687 produce consistent output.  For example, in an assembly session
3688 started at 42 seconds after midnight on January 1, 2010 in Moscow
3689 (timezone UTC+3) these macros would have the following values,
3690 assuming, of course, a properly configured environment with a correct
3691 clock:
3693 \c __DATE__             "2010-01-01"
3694 \c __TIME__             "00:00:42"
3695 \c __DATE_NUM__         20100101
3696 \c __TIME_NUM__         000042
3697 \c __UTC_DATE__         "2009-12-31"
3698 \c __UTC_TIME__         "21:00:42"
3699 \c __UTC_DATE_NUM__     20091231
3700 \c __UTC_TIME_NUM__     210042
3701 \c __POSIX_TIME__       1262293242
3704 \S{use_def} \I\c{__USE_*__}\c{__USE_}\e{package}\c{__}: Package
3705 Include Test
3707 When a standard macro package (see \k{macropkg}) is included with the
3708 \c{%use} directive (see \k{use}), a single-line macro of the form
3709 \c{__USE_}\e{package}\c{__} is automatically defined.  This allows
3710 testing if a particular package is invoked or not.
3712 For example, if the \c{altreg} package is included (see
3713 \k{pkg_altreg}), then the macro \c{__USE_ALTREG__} is defined.
3716 \S{pass_macro} \i\c{__PASS__}: Assembly Pass
3718 The macro \c{__PASS__} is defined to be \c{1} on preparatory passes,
3719 and \c{2} on the final pass.  In preprocess-only mode, it is set to
3720 \c{3}, and when running only to generate dependencies (due to the
3721 \c{-M} or \c{-MG} option, see \k{opt-M}) it is set to \c{0}.
3723 \e{Avoid using this macro if at all possible.  It is tremendously easy
3724 to generate very strange errors by misusing it, and the semantics may
3725 change in future versions of NASM.}
3728 \S{struc} \i\c{STRUC} and \i\c{ENDSTRUC}: \i{Declaring Structure} Data Types
3730 The core of NASM contains no intrinsic means of defining data
3731 structures; instead, the preprocessor is sufficiently powerful that
3732 data structures can be implemented as a set of macros. The macros
3733 \c{STRUC} and \c{ENDSTRUC} are used to define a structure data type.
3735 \c{STRUC} takes one parameter, which is the name of the data type.
3736 This name is defined as a symbol with the value zero, and also has
3737 the suffix \c{_size} appended to it and is then defined as an
3738 \c{EQU} giving the size of the structure. Once \c{STRUC} has been
3739 issued, you are defining the structure, and should define fields
3740 using the \c{RESB} family of pseudo-instructions, and then invoke
3741 \c{ENDSTRUC} to finish the definition.
3743 For example, to define a structure called \c{mytype} containing a
3744 longword, a word, a byte and a string of bytes, you might code
3746 \c struc   mytype
3748 \c   mt_long:      resd    1
3749 \c   mt_word:      resw    1
3750 \c   mt_byte:      resb    1
3751 \c   mt_str:       resb    32
3753 \c endstruc
3755 The above code defines six symbols: \c{mt_long} as 0 (the offset
3756 from the beginning of a \c{mytype} structure to the longword field),
3757 \c{mt_word} as 4, \c{mt_byte} as 6, \c{mt_str} as 7, \c{mytype_size}
3758 as 39, and \c{mytype} itself as zero.
3760 The reason why the structure type name is defined at zero is a side
3761 effect of allowing structures to work with the local label
3762 mechanism: if your structure members tend to have the same names in
3763 more than one structure, you can define the above structure like this:
3765 \c struc mytype
3767 \c   .long:        resd    1
3768 \c   .word:        resw    1
3769 \c   .byte:        resb    1
3770 \c   .str:         resb    32
3772 \c endstruc
3774 This defines the offsets to the structure fields as \c{mytype.long},
3775 \c{mytype.word}, \c{mytype.byte} and \c{mytype.str}.
3777 NASM, since it has no \e{intrinsic} structure support, does not
3778 support any form of period notation to refer to the elements of a
3779 structure once you have one (except the above local-label notation),
3780 so code such as \c{mov ax,[mystruc.mt_word]} is not valid.
3781 \c{mt_word} is a constant just like any other constant, so the
3782 correct syntax is \c{mov ax,[mystruc+mt_word]} or \c{mov
3783 ax,[mystruc+mytype.word]}.
3786 \S{istruc} \i\c{ISTRUC}, \i\c{AT} and \i\c{IEND}: Declaring
3787 \i{Instances of Structures}
3789 Having defined a structure type, the next thing you typically want
3790 to do is to declare instances of that structure in your data
3791 segment. NASM provides an easy way to do this in the \c{ISTRUC}
3792 mechanism. To declare a structure of type \c{mytype} in a program,
3793 you code something like this:
3795 \c mystruc:
3796 \c     istruc mytype
3798 \c         at mt_long, dd      123456
3799 \c         at mt_word, dw      1024
3800 \c         at mt_byte, db      'x'
3801 \c         at mt_str,  db      'hello, world', 13, 10, 0
3803 \c     iend
3805 The function of the \c{AT} macro is to make use of the \c{TIMES}
3806 prefix to advance the assembly position to the correct point for the
3807 specified structure field, and then to declare the specified data.
3808 Therefore the structure fields must be declared in the same order as
3809 they were specified in the structure definition.
3811 If the data to go in a structure field requires more than one source
3812 line to specify, the remaining source lines can easily come after
3813 the \c{AT} line. For example:
3815 \c         at mt_str,  db      123,134,145,156,167,178,189
3816 \c                     db      190,100,0
3818 Depending on personal taste, you can also omit the code part of the
3819 \c{AT} line completely, and start the structure field on the next
3820 line:
3822 \c         at mt_str
3823 \c                 db      'hello, world'
3824 \c                 db      13,10,0
3827 \S{align} \i\c{ALIGN} and \i\c{ALIGNB}: Data Alignment
3829 The \c{ALIGN} and \c{ALIGNB} macros provides a convenient way to
3830 align code or data on a word, longword, paragraph or other boundary.
3831 (Some assemblers call this directive \i\c{EVEN}.) The syntax of the
3832 \c{ALIGN} and \c{ALIGNB} macros is
3834 \c         align   4               ; align on 4-byte boundary
3835 \c         align   16              ; align on 16-byte boundary
3836 \c         align   8,db 0          ; pad with 0s rather than NOPs
3837 \c         align   4,resb 1        ; align to 4 in the BSS
3838 \c         alignb  4               ; equivalent to previous line
3840 Both macros require their first argument to be a power of two; they
3841 both compute the number of additional bytes required to bring the
3842 length of the current section up to a multiple of that power of two,
3843 and then apply the \c{TIMES} prefix to their second argument to
3844 perform the alignment.
3846 If the second argument is not specified, the default for \c{ALIGN}
3847 is \c{NOP}, and the default for \c{ALIGNB} is \c{RESB 1}. So if the
3848 second argument is specified, the two macros are equivalent.
3849 Normally, you can just use \c{ALIGN} in code and data sections and
3850 \c{ALIGNB} in BSS sections, and never need the second argument
3851 except for special purposes.
3853 \c{ALIGN} and \c{ALIGNB}, being simple macros, perform no error
3854 checking: they cannot warn you if their first argument fails to be a
3855 power of two, or if their second argument generates more than one
3856 byte of code. In each of these cases they will silently do the wrong
3857 thing.
3859 \c{ALIGNB} (or \c{ALIGN} with a second argument of \c{RESB 1}) can
3860 be used within structure definitions:
3862 \c struc mytype2
3864 \c   mt_byte:
3865 \c         resb 1
3866 \c         alignb 2
3867 \c   mt_word:
3868 \c         resw 1
3869 \c         alignb 4
3870 \c   mt_long:
3871 \c         resd 1
3872 \c   mt_str:
3873 \c         resb 32
3875 \c endstruc
3877 This will ensure that the structure members are sensibly aligned
3878 relative to the base of the structure.
3880 A final caveat: \c{ALIGN} and \c{ALIGNB} work relative to the
3881 beginning of the \e{section}, not the beginning of the address space
3882 in the final executable. Aligning to a 16-byte boundary when the
3883 section you're in is only guaranteed to be aligned to a 4-byte
3884 boundary, for example, is a waste of effort. Again, NASM does not
3885 check that the section's alignment characteristics are sensible for
3886 the use of \c{ALIGN} or \c{ALIGNB}.
3888 See also the \c{smartalign} standard macro package, \k{pkg_smartalign}.
3891 \C{macropkg} \i{Standard Macro Packages}
3893 The \i\c{%use} directive (see \k{use}) includes one of the standard
3894 macro packages included with the NASM distribution and compiled into
3895 the NASM binary.  It operates like the \c{%include} directive (see
3896 \k{include}), but the included contents is provided by NASM itself.
3898 The names of standard macro packages are case insensitive, and can be
3899 quoted or not.
3902 \H{pkg_altreg} \i\c{altreg}: \i{Alternate Register Names}
3904 The \c{altreg} standard macro package provides alternate register
3905 names.  It provides numeric register names for all registers (not just
3906 \c{R8}-\c{R15}), the Intel-defined aliases \c{R8L}-\c{R15L} for the
3907 low bytes of register (as opposed to the NASM/AMD standard names
3908 \c{R8B}-\c{R15B}), and the names \c{R0H}-\c{R3H} (by analogy with
3909 \c{R0L}-\c{R3L}) for \c{AH}, \c{CH}, \c{DH}, and \c{BH}.
3911 Example use:
3913 \c %use altreg
3915 \c proc:
3916 \c       mov r0l,r3h                    ; mov al,bh
3917 \c       ret
3919 See also \k{reg64}.
3922 \H{pkg_smartalign} \i\c{smartalign}\I{align, smart}: Smart \c{ALIGN} Macro
3924 The \c{smartalign} standard macro package provides for an \i\c{ALIGN}
3925 macro which is more powerful than the default (and
3926 backwards-compatible) one (see \k{align}).  When the \c{smartalign}
3927 package is enabled, when \c{ALIGN} is used without a second argument,
3928 NASM will generate a sequence of instructions more efficient than a
3929 series of \c{NOP}.  Furthermore, if the padding exceeds a specific
3930 threshold, then NASM will generate a jump over the entire padding
3931 sequence.
3933 The specific instructions generated can be controlled with the
3934 new \i\c{ALIGNMODE} macro.  This macro takes two parameters: one mode,
3935 and an optional jump threshold override.  The modes are as
3936 follows:
3938 \b \c{generic}: Works on all x86 CPUs and should have reasonable
3939 performance.  The default jump threshold is 8.  This is the
3940 default.
3942 \b \c{nop}: Pad out with \c{NOP} instructions.  The only difference
3943 compared to the standard \c{ALIGN} macro is that NASM can still jump
3944 over a large padding area.  The default jump threshold is 16.
3946 \b \c{k7}: Optimize for the AMD K7 (Athlon/Althon XP).  These
3947 instructions should still work on all x86 CPUs.  The default jump
3948 threshold is 16.
3950 \b \c{k8}: Optimize for the AMD K8 (Opteron/Althon 64).  These
3951 instructions should still work on all x86 CPUs.  The default jump
3952 threshold is 16.
3954 \b \c{p6}: Optimize for Intel CPUs.  This uses the long \c{NOP}
3955 instructions first introduced in Pentium Pro.  This is incompatible
3956 with all CPUs of family 5 or lower, as well as some VIA CPUs and
3957 several virtualization solutions.  The default jump threshold is 16.
3959 The macro \i\c{__ALIGNMODE__} is defined to contain the current
3960 alignment mode.  A number of other macros beginning with \c{__ALIGN_}
3961 are used internally by this macro package.
3964 \C{directive} \i{Assembler Directives}
3966 NASM, though it attempts to avoid the bureaucracy of assemblers like
3967 MASM and TASM, is nevertheless forced to support a \e{few}
3968 directives. These are described in this chapter.
3970 NASM's directives come in two types: \I{user-level
3971 directives}\e{user-level} directives and \I{primitive
3972 directives}\e{primitive} directives. Typically, each directive has a
3973 user-level form and a primitive form. In almost all cases, we
3974 recommend that users use the user-level forms of the directives,
3975 which are implemented as macros which call the primitive forms.
3977 Primitive directives are enclosed in square brackets; user-level
3978 directives are not.
3980 In addition to the universal directives described in this chapter,
3981 each object file format can optionally supply extra directives in
3982 order to control particular features of that file format. These
3983 \I{format-specific directives}\e{format-specific} directives are
3984 documented along with the formats that implement them, in \k{outfmt}.
3987 \H{bits} \i\c{BITS}: Specifying Target \i{Processor Mode}
3989 The \c{BITS} directive specifies whether NASM should generate code
3990 \I{16-bit mode, versus 32-bit mode}designed to run on a processor
3991 operating in 16-bit mode, 32-bit mode or 64-bit mode. The syntax is
3992 \c{BITS XX}, where XX is 16, 32 or 64.
3994 In most cases, you should not need to use \c{BITS} explicitly. The
3995 \c{aout}, \c{coff}, \c{elf}, \c{macho}, \c{win32} and \c{win64}
3996 object formats, which are designed for use in 32-bit or 64-bit
3997 operating systems, all cause NASM to select 32-bit or 64-bit mode,
3998 respectively, by default. The \c{obj} object format allows you
3999 to specify each segment you define as either \c{USE16} or \c{USE32},
4000 and NASM will set its operating mode accordingly, so the use of the
4001 \c{BITS} directive is once again unnecessary.
4003 The most likely reason for using the \c{BITS} directive is to write
4004 32-bit or 64-bit code in a flat binary file; this is because the \c{bin}
4005 output format defaults to 16-bit mode in anticipation of it being
4006 used most frequently to write DOS \c{.COM} programs, DOS \c{.SYS}
4007 device drivers and boot loader software.
4009 You do \e{not} need to specify \c{BITS 32} merely in order to use
4010 32-bit instructions in a 16-bit DOS program; if you do, the
4011 assembler will generate incorrect code because it will be writing
4012 code targeted at a 32-bit platform, to be run on a 16-bit one.
4014 When NASM is in \c{BITS 16} mode, instructions which use 32-bit
4015 data are prefixed with an 0x66 byte, and those referring to 32-bit
4016 addresses have an 0x67 prefix. In \c{BITS 32} mode, the reverse is
4017 true: 32-bit instructions require no prefixes, whereas instructions
4018 using 16-bit data need an 0x66 and those working on 16-bit addresses
4019 need an 0x67.
4021 When NASM is in \c{BITS 64} mode, most instructions operate the same
4022 as they do for \c{BITS 32} mode. However, there are 8 more general and
4023 SSE registers, and 16-bit addressing is no longer supported.
4025 The default address size is 64 bits; 32-bit addressing can be selected
4026 with the 0x67 prefix.  The default operand size is still 32 bits,
4027 however, and the 0x66 prefix selects 16-bit operand size.  The \c{REX}
4028 prefix is used both to select 64-bit operand size, and to access the
4029 new registers. NASM automatically inserts REX prefixes when
4030 necessary.
4032 When the \c{REX} prefix is used, the processor does not know how to
4033 address the AH, BH, CH or DH (high 8-bit legacy) registers. Instead,
4034 it is possible to access the the low 8-bits of the SP, BP SI and DI
4035 registers as SPL, BPL, SIL and DIL, respectively; but only when the
4036 REX prefix is used.
4038 The \c{BITS} directive has an exactly equivalent primitive form,
4039 \c{[BITS 16]}, \c{[BITS 32]} and \c{[BITS 64]}. The user-level form is
4040 a macro which has no function other than to call the primitive form.
4042 Note that the space is neccessary, e.g. \c{BITS32} will \e{not} work!
4044 \S{USE16 & USE32} \i\c{USE16} & \i\c{USE32}: Aliases for BITS
4046 The `\c{USE16}' and `\c{USE32}' directives can be used in place of
4047 `\c{BITS 16}' and `\c{BITS 32}', for compatibility with other assemblers.
4050 \H{default} \i\c{DEFAULT}: Change the assembler defaults
4052 The \c{DEFAULT} directive changes the assembler defaults.  Normally,
4053 NASM defaults to a mode where the programmer is expected to explicitly
4054 specify most features directly.  However, this is occationally
4055 obnoxious, as the explicit form is pretty much the only one one wishes
4056 to use.
4058 Currently, the only \c{DEFAULT} that is settable is whether or not
4059 registerless instructions in 64-bit mode are \c{RIP}-relative or not.
4060 By default, they are absolute unless overridden with the \i\c{REL}
4061 specifier (see \k{effaddr}).  However, if \c{DEFAULT REL} is
4062 specified, \c{REL} is default, unless overridden with the \c{ABS}
4063 specifier, \e{except when used with an FS or GS segment override}.
4065 The special handling of \c{FS} and \c{GS} overrides are due to the
4066 fact that these registers are generally used as thread pointers or
4067 other special functions in 64-bit mode, and generating
4068 \c{RIP}-relative addresses would be extremely confusing.
4070 \c{DEFAULT REL} is disabled with \c{DEFAULT ABS}.
4072 \H{section} \i\c{SECTION} or \i\c{SEGMENT}: Changing and \i{Defining
4073 Sections}
4075 \I{changing sections}\I{switching between sections}The \c{SECTION}
4076 directive (\c{SEGMENT} is an exactly equivalent synonym) changes
4077 which section of the output file the code you write will be
4078 assembled into. In some object file formats, the number and names of
4079 sections are fixed; in others, the user may make up as many as they
4080 wish. Hence \c{SECTION} may sometimes give an error message, or may
4081 define a new section, if you try to switch to a section that does
4082 not (yet) exist.
4084 The Unix object formats, and the \c{bin} object format (but see
4085 \k{multisec}, all support
4086 the \i{standardized section names} \c{.text}, \c{.data} and \c{.bss}
4087 for the code, data and uninitialized-data sections. The \c{obj}
4088 format, by contrast, does not recognize these section names as being
4089 special, and indeed will strip off the leading period of any section
4090 name that has one.
4093 \S{sectmac} The \i\c{__SECT__} Macro
4095 The \c{SECTION} directive is unusual in that its user-level form
4096 functions differently from its primitive form. The primitive form,
4097 \c{[SECTION xyz]}, simply switches the current target section to the
4098 one given. The user-level form, \c{SECTION xyz}, however, first
4099 defines the single-line macro \c{__SECT__} to be the primitive
4100 \c{[SECTION]} directive which it is about to issue, and then issues
4101 it. So the user-level directive
4103 \c         SECTION .text
4105 expands to the two lines
4107 \c %define __SECT__        [SECTION .text]
4108 \c         [SECTION .text]
4110 Users may find it useful to make use of this in their own macros.
4111 For example, the \c{writefile} macro defined in \k{mlmacgre} can be
4112 usefully rewritten in the following more sophisticated form:
4114 \c %macro  writefile 2+
4116 \c         [section .data]
4118 \c   %%str:        db      %2
4119 \c   %%endstr:
4121 \c         __SECT__
4123 \c         mov     dx,%%str
4124 \c         mov     cx,%%endstr-%%str
4125 \c         mov     bx,%1
4126 \c         mov     ah,0x40
4127 \c         int     0x21
4129 \c %endmacro
4131 This form of the macro, once passed a string to output, first
4132 switches temporarily to the data section of the file, using the
4133 primitive form of the \c{SECTION} directive so as not to modify
4134 \c{__SECT__}. It then declares its string in the data section, and
4135 then invokes \c{__SECT__} to switch back to \e{whichever} section
4136 the user was previously working in. It thus avoids the need, in the
4137 previous version of the macro, to include a \c{JMP} instruction to
4138 jump over the data, and also does not fail if, in a complicated
4139 \c{OBJ} format module, the user could potentially be assembling the
4140 code in any of several separate code sections.
4143 \H{absolute} \i\c{ABSOLUTE}: Defining Absolute Labels
4145 The \c{ABSOLUTE} directive can be thought of as an alternative form
4146 of \c{SECTION}: it causes the subsequent code to be directed at no
4147 physical section, but at the hypothetical section starting at the
4148 given absolute address. The only instructions you can use in this
4149 mode are the \c{RESB} family.
4151 \c{ABSOLUTE} is used as follows:
4153 \c absolute 0x1A
4155 \c     kbuf_chr    resw    1
4156 \c     kbuf_free   resw    1
4157 \c     kbuf        resw    16
4159 This example describes a section of the PC BIOS data area, at
4160 segment address 0x40: the above code defines \c{kbuf_chr} to be
4161 0x1A, \c{kbuf_free} to be 0x1C, and \c{kbuf} to be 0x1E.
4163 The user-level form of \c{ABSOLUTE}, like that of \c{SECTION},
4164 redefines the \i\c{__SECT__} macro when it is invoked.
4166 \i\c{STRUC} and \i\c{ENDSTRUC} are defined as macros which use
4167 \c{ABSOLUTE} (and also \c{__SECT__}).
4169 \c{ABSOLUTE} doesn't have to take an absolute constant as an
4170 argument: it can take an expression (actually, a \i{critical
4171 expression}: see \k{crit}) and it can be a value in a segment. For
4172 example, a TSR can re-use its setup code as run-time BSS like this:
4174 \c         org     100h               ; it's a .COM program
4176 \c         jmp     setup              ; setup code comes last
4178 \c         ; the resident part of the TSR goes here
4179 \c setup:
4180 \c         ; now write the code that installs the TSR here
4182 \c absolute setup
4184 \c runtimevar1     resw    1
4185 \c runtimevar2     resd    20
4187 \c tsr_end:
4189 This defines some variables `on top of' the setup code, so that
4190 after the setup has finished running, the space it took up can be
4191 re-used as data storage for the running TSR. The symbol `tsr_end'
4192 can be used to calculate the total size of the part of the TSR that
4193 needs to be made resident.
4196 \H{extern} \i\c{EXTERN}: \i{Importing Symbols} from Other Modules
4198 \c{EXTERN} is similar to the MASM directive \c{EXTRN} and the C
4199 keyword \c{extern}: it is used to declare a symbol which is not
4200 defined anywhere in the module being assembled, but is assumed to be
4201 defined in some other module and needs to be referred to by this
4202 one. Not every object-file format can support external variables:
4203 the \c{bin} format cannot.
4205 The \c{EXTERN} directive takes as many arguments as you like. Each
4206 argument is the name of a symbol:
4208 \c extern  _printf
4209 \c extern  _sscanf,_fscanf
4211 Some object-file formats provide extra features to the \c{EXTERN}
4212 directive. In all cases, the extra features are used by suffixing a
4213 colon to the symbol name followed by object-format specific text.
4214 For example, the \c{obj} format allows you to declare that the
4215 default segment base of an external should be the group \c{dgroup}
4216 by means of the directive
4218 \c extern  _variable:wrt dgroup
4220 The primitive form of \c{EXTERN} differs from the user-level form
4221 only in that it can take only one argument at a time: the support
4222 for multiple arguments is implemented at the preprocessor level.
4224 You can declare the same variable as \c{EXTERN} more than once: NASM
4225 will quietly ignore the second and later redeclarations. You can't
4226 declare a variable as \c{EXTERN} as well as something else, though.
4229 \H{global} \i\c{GLOBAL}: \i{Exporting Symbols} to Other Modules
4231 \c{GLOBAL} is the other end of \c{EXTERN}: if one module declares a
4232 symbol as \c{EXTERN} and refers to it, then in order to prevent
4233 linker errors, some other module must actually \e{define} the
4234 symbol and declare it as \c{GLOBAL}. Some assemblers use the name
4235 \i\c{PUBLIC} for this purpose.
4237 The \c{GLOBAL} directive applying to a symbol must appear \e{before}
4238 the definition of the symbol.
4240 \c{GLOBAL} uses the same syntax as \c{EXTERN}, except that it must
4241 refer to symbols which \e{are} defined in the same module as the
4242 \c{GLOBAL} directive. For example:
4244 \c global _main
4245 \c _main:
4246 \c         ; some code
4248 \c{GLOBAL}, like \c{EXTERN}, allows object formats to define private
4249 extensions by means of a colon. The \c{elf} object format, for
4250 example, lets you specify whether global data items are functions or
4251 data:
4253 \c global  hashlookup:function, hashtable:data
4255 Like \c{EXTERN}, the primitive form of \c{GLOBAL} differs from the
4256 user-level form only in that it can take only one argument at a
4257 time.
4260 \H{common} \i\c{COMMON}: Defining Common Data Areas
4262 The \c{COMMON} directive is used to declare \i\e{common variables}.
4263 A common variable is much like a global variable declared in the
4264 uninitialized data section, so that
4266 \c common  intvar  4
4268 is similar in function to
4270 \c global  intvar
4271 \c section .bss
4273 \c intvar  resd    1
4275 The difference is that if more than one module defines the same
4276 common variable, then at link time those variables will be
4277 \e{merged}, and references to \c{intvar} in all modules will point
4278 at the same piece of memory.
4280 Like \c{GLOBAL} and \c{EXTERN}, \c{COMMON} supports object-format
4281 specific extensions. For example, the \c{obj} format allows common
4282 variables to be NEAR or FAR, and the \c{elf} format allows you to
4283 specify the alignment requirements of a common variable:
4285 \c common  commvar  4:near  ; works in OBJ
4286 \c common  intarray 100:4   ; works in ELF: 4 byte aligned
4288 Once again, like \c{EXTERN} and \c{GLOBAL}, the primitive form of
4289 \c{COMMON} differs from the user-level form only in that it can take
4290 only one argument at a time.
4293 \H{CPU} \i\c{CPU}: Defining CPU Dependencies
4295 The \i\c{CPU} directive restricts assembly to those instructions which
4296 are available on the specified CPU.
4298 Options are:
4300 \b\c{CPU 8086}          Assemble only 8086 instruction set
4302 \b\c{CPU 186}           Assemble instructions up to the 80186 instruction set
4304 \b\c{CPU 286}           Assemble instructions up to the 286 instruction set
4306 \b\c{CPU 386}           Assemble instructions up to the 386 instruction set
4308 \b\c{CPU 486}           486 instruction set
4310 \b\c{CPU 586}           Pentium instruction set
4312 \b\c{CPU PENTIUM}       Same as 586
4314 \b\c{CPU 686}           P6 instruction set
4316 \b\c{CPU PPRO}          Same as 686
4318 \b\c{CPU P2}            Same as 686
4320 \b\c{CPU P3}            Pentium III (Katmai) instruction sets
4322 \b\c{CPU KATMAI}        Same as P3
4324 \b\c{CPU P4}            Pentium 4 (Willamette) instruction set
4326 \b\c{CPU WILLAMETTE}    Same as P4
4328 \b\c{CPU PRESCOTT}      Prescott instruction set
4330 \b\c{CPU X64}           x86-64 (x64/AMD64/Intel 64) instruction set
4332 \b\c{CPU IA64}          IA64 CPU (in x86 mode) instruction set
4334 All options are case insensitive.  All instructions will be selected
4335 only if they apply to the selected CPU or lower.  By default, all
4336 instructions are available.
4339 \H{FLOAT} \i\c{FLOAT}: Handling of \I{floating-point, constants}floating-point constants
4341 By default, floating-point constants are rounded to nearest, and IEEE
4342 denormals are supported.  The following options can be set to alter
4343 this behaviour:
4345 \b\c{FLOAT DAZ}         Flush denormals to zero
4347 \b\c{FLOAT NODAZ}       Do not flush denormals to zero (default)
4349 \b\c{FLOAT NEAR}        Round to nearest (default)
4351 \b\c{FLOAT UP}          Round up (toward +Infinity)
4353 \b\c{FLOAT DOWN}        Round down (toward -Infinity)
4355 \b\c{FLOAT ZERO}        Round toward zero
4357 \b\c{FLOAT DEFAULT}     Restore default settings
4359 The standard macros \i\c{__FLOAT_DAZ__}, \i\c{__FLOAT_ROUND__}, and
4360 \i\c{__FLOAT__} contain the current state, as long as the programmer
4361 has avoided the use of the brackeded primitive form, (\c{[FLOAT]}).
4363 \c{__FLOAT__} contains the full set of floating-point settings; this
4364 value can be saved away and invoked later to restore the setting.
4367 \C{outfmt} \i{Output Formats}
4369 NASM is a portable assembler, designed to be able to compile on any
4370 ANSI C-supporting platform and produce output to run on a variety of
4371 Intel x86 operating systems. For this reason, it has a large number
4372 of available output formats, selected using the \i\c{-f} option on
4373 the NASM \i{command line}. Each of these formats, along with its
4374 extensions to the base NASM syntax, is detailed in this chapter.
4376 As stated in \k{opt-o}, NASM chooses a \i{default name} for your
4377 output file based on the input file name and the chosen output
4378 format. This will be generated by removing the \i{extension}
4379 (\c{.asm}, \c{.s}, or whatever you like to use) from the input file
4380 name, and substituting an extension defined by the output format.
4381 The extensions are given with each format below.
4384 \H{binfmt} \i\c{bin}: \i{Flat-Form Binary}\I{pure binary} Output
4386 The \c{bin} format does not produce object files: it generates
4387 nothing in the output file except the code you wrote. Such `pure
4388 binary' files are used by \i{MS-DOS}: \i\c{.COM} executables and
4389 \i\c{.SYS} device drivers are pure binary files. Pure binary output
4390 is also useful for \i{operating system} and \i{boot loader}
4391 development.
4393 The \c{bin} format supports \i{multiple section names}. For details of
4394 how nasm handles sections in the \c{bin} format, see \k{multisec}.
4396 Using the \c{bin} format puts NASM by default into 16-bit mode (see
4397 \k{bits}). In order to use \c{bin} to write 32-bit or 64-bit code,
4398 such as an OS kernel, you need to explicitly issue the \I\c{BITS}\c{BITS 32}
4399 or \I\c{BITS}\c{BITS 64} directive.
4401 \c{bin} has no default output file name extension: instead, it
4402 leaves your file name as it is once the original extension has been
4403 removed. Thus, the default is for NASM to assemble \c{binprog.asm}
4404 into a binary file called \c{binprog}.
4407 \S{org} \i\c{ORG}: Binary File \i{Program Origin}
4409 The \c{bin} format provides an additional directive to the list
4410 given in \k{directive}: \c{ORG}. The function of the \c{ORG}
4411 directive is to specify the origin address which NASM will assume
4412 the program begins at when it is loaded into memory.
4414 For example, the following code will generate the longword
4415 \c{0x00000104}:
4417 \c         org     0x100
4418 \c         dd      label
4419 \c label:
4421 Unlike the \c{ORG} directive provided by MASM-compatible assemblers,
4422 which allows you to jump around in the object file and overwrite
4423 code you have already generated, NASM's \c{ORG} does exactly what
4424 the directive says: \e{origin}. Its sole function is to specify one
4425 offset which is added to all internal address references within the
4426 section; it does not permit any of the trickery that MASM's version
4427 does. See \k{proborg} for further comments.
4430 \S{binseg} \c{bin} Extensions to the \c{SECTION}
4431 Directive\I{SECTION, bin extensions to}
4433 The \c{bin} output format extends the \c{SECTION} (or \c{SEGMENT})
4434 directive to allow you to specify the alignment requirements of
4435 segments. This is done by appending the \i\c{ALIGN} qualifier to the
4436 end of the section-definition line. For example,
4438 \c section .data   align=16
4440 switches to the section \c{.data} and also specifies that it must be
4441 aligned on a 16-byte boundary.
4443 The parameter to \c{ALIGN} specifies how many low bits of the
4444 section start address must be forced to zero. The alignment value
4445 given may be any power of two.\I{section alignment, in
4446 bin}\I{segment alignment, in bin}\I{alignment, in bin sections}
4449 \S{multisec} \i\c{Multisection}\I{bin, multisection} support for the BIN format.
4451 The \c{bin} format allows the use of multiple sections, of arbitrary names, 
4452 besides the "known" \c{.text}, \c{.data}, and \c{.bss} names.
4454 \b Sections may be designated \i\c{progbits} or \i\c{nobits}. Default 
4455 is \c{progbits} (except \c{.bss}, which defaults to \c{nobits}, 
4456 of course).
4458 \b Sections can be aligned at a specified boundary following the previous 
4459 section with \c{align=}, or at an arbitrary byte-granular position with 
4460 \i\c{start=}.
4462 \b Sections can be given a virtual start address, which will be used 
4463 for the calculation of all memory references within that section 
4464 with \i\c{vstart=}.
4466 \b Sections can be ordered using \i\c{follows=}\c{<section>} or 
4467 \i\c{vfollows=}\c{<section>} as an alternative to specifying an explicit 
4468 start address.
4470 \b Arguments to \c{org}, \c{start}, \c{vstart}, and \c{align=} are 
4471 critical expressions. See \k{crit}. E.g. \c{align=(1 << ALIGN_SHIFT)} 
4472 - \c{ALIGN_SHIFT} must be defined before it is used here.
4474 \b Any code which comes before an explicit \c{SECTION} directive
4475 is directed by default into the \c{.text} section.
4477 \b If an \c{ORG} statement is not given, \c{ORG 0} is used 
4478 by default.
4480 \b The \c{.bss} section will be placed after the last \c{progbits} 
4481 section, unless \c{start=}, \c{vstart=}, \c{follows=}, or \c{vfollows=} 
4482 has been specified.
4484 \b All sections are aligned on dword boundaries, unless a different 
4485 alignment has been specified.
4487 \b Sections may not overlap.
4489 \b NASM creates the \c{section.<secname>.start} for each section, 
4490 which may be used in your code.
4492 \S{map}\i{Map files}
4494 Map files can be generated in \c{-f bin} format by means of the \c{[map]} 
4495 option. Map types of \c{all} (default), \c{brief}, \c{sections}, \c{segments}, 
4496 or \c{symbols} may be specified. Output may be directed to \c{stdout} 
4497 (default), \c{stderr}, or a specified file. E.g.
4498 \c{[map symbols myfile.map]}. No "user form" exists, the square
4499 brackets must be used.
4502 \H{objfmt} \i\c{obj}: \i{Microsoft OMF}\I{OMF} Object Files
4504 The \c{obj} file format (NASM calls it \c{obj} rather than \c{omf}
4505 for historical reasons) is the one produced by \i{MASM} and
4506 \i{TASM}, which is typically fed to 16-bit DOS linkers to produce
4507 \i\c{.EXE} files. It is also the format used by \i{OS/2}.
4509 \c{obj} provides a default output file-name extension of \c{.obj}.
4511 \c{obj} is not exclusively a 16-bit format, though: NASM has full
4512 support for the 32-bit extensions to the format. In particular,
4513 32-bit \c{obj} format files are used by \i{Borland's Win32
4514 compilers}, instead of using Microsoft's newer \i\c{win32} object
4515 file format.
4517 The \c{obj} format does not define any special segment names: you
4518 can call your segments anything you like. Typical names for segments
4519 in \c{obj} format files are \c{CODE}, \c{DATA} and \c{BSS}.
4521 If your source file contains code before specifying an explicit
4522 \c{SEGMENT} directive, then NASM will invent its own segment called
4523 \i\c{__NASMDEFSEG} for you.
4525 When you define a segment in an \c{obj} file, NASM defines the
4526 segment name as a symbol as well, so that you can access the segment
4527 address of the segment. So, for example:
4529 \c segment data
4531 \c dvar:   dw      1234
4533 \c segment code
4535 \c function:
4536 \c         mov     ax,data         ; get segment address of data
4537 \c         mov     ds,ax           ; and move it into DS
4538 \c         inc     word [dvar]     ; now this reference will work
4539 \c         ret
4541 The \c{obj} format also enables the use of the \i\c{SEG} and
4542 \i\c{WRT} operators, so that you can write code which does things
4543 like
4545 \c extern  foo
4547 \c       mov   ax,seg foo            ; get preferred segment of foo
4548 \c       mov   ds,ax
4549 \c       mov   ax,data               ; a different segment
4550 \c       mov   es,ax
4551 \c       mov   ax,[ds:foo]           ; this accesses `foo'
4552 \c       mov   [es:foo wrt data],bx  ; so does this
4555 \S{objseg} \c{obj} Extensions to the \c{SEGMENT}
4556 Directive\I{SEGMENT, obj extensions to}
4558 The \c{obj} output format extends the \c{SEGMENT} (or \c{SECTION})
4559 directive to allow you to specify various properties of the segment
4560 you are defining. This is done by appending extra qualifiers to the
4561 end of the segment-definition line. For example,
4563 \c segment code private align=16
4565 defines the segment \c{code}, but also declares it to be a private
4566 segment, and requires that the portion of it described in this code
4567 module must be aligned on a 16-byte boundary.
4569 The available qualifiers are:
4571 \b \i\c{PRIVATE}, \i\c{PUBLIC}, \i\c{COMMON} and \i\c{STACK} specify
4572 the combination characteristics of the segment. \c{PRIVATE} segments
4573 do not get combined with any others by the linker; \c{PUBLIC} and
4574 \c{STACK} segments get concatenated together at link time; and
4575 \c{COMMON} segments all get overlaid on top of each other rather
4576 than stuck end-to-end.
4578 \b \i\c{ALIGN} is used, as shown above, to specify how many low bits
4579 of the segment start address must be forced to zero. The alignment
4580 value given may be any power of two from 1 to 4096; in reality, the
4581 only values supported are 1, 2, 4, 16, 256 and 4096, so if 8 is
4582 specified it will be rounded up to 16, and 32, 64 and 128 will all
4583 be rounded up to 256, and so on. Note that alignment to 4096-byte
4584 boundaries is a \i{PharLap} extension to the format and may not be
4585 supported by all linkers.\I{section alignment, in OBJ}\I{segment
4586 alignment, in OBJ}\I{alignment, in OBJ sections}
4588 \b \i\c{CLASS} can be used to specify the segment class; this feature
4589 indicates to the linker that segments of the same class should be
4590 placed near each other in the output file. The class name can be any
4591 word, e.g. \c{CLASS=CODE}.
4593 \b \i\c{OVERLAY}, like \c{CLASS}, is specified with an arbitrary word
4594 as an argument, and provides overlay information to an
4595 overlay-capable linker.
4597 \b Segments can be declared as \i\c{USE16} or \i\c{USE32}, which has
4598 the effect of recording the choice in the object file and also
4599 ensuring that NASM's default assembly mode when assembling in that
4600 segment is 16-bit or 32-bit respectively.
4602 \b When writing \i{OS/2} object files, you should declare 32-bit
4603 segments as \i\c{FLAT}, which causes the default segment base for
4604 anything in the segment to be the special group \c{FLAT}, and also
4605 defines the group if it is not already defined.
4607 \b The \c{obj} file format also allows segments to be declared as
4608 having a pre-defined absolute segment address, although no linkers
4609 are currently known to make sensible use of this feature;
4610 nevertheless, NASM allows you to declare a segment such as
4611 \c{SEGMENT SCREEN ABSOLUTE=0xB800} if you need to. The \i\c{ABSOLUTE}
4612 and \c{ALIGN} keywords are mutually exclusive.
4614 NASM's default segment attributes are \c{PUBLIC}, \c{ALIGN=1}, no
4615 class, no overlay, and \c{USE16}.
4618 \S{group} \i\c{GROUP}: Defining Groups of Segments\I{segments, groups of}
4620 The \c{obj} format also allows segments to be grouped, so that a
4621 single segment register can be used to refer to all the segments in
4622 a group. NASM therefore supplies the \c{GROUP} directive, whereby
4623 you can code
4625 \c segment data
4627 \c         ; some data
4629 \c segment bss
4631 \c         ; some uninitialized data
4633 \c group dgroup data bss
4635 which will define a group called \c{dgroup} to contain the segments
4636 \c{data} and \c{bss}. Like \c{SEGMENT}, \c{GROUP} causes the group
4637 name to be defined as a symbol, so that you can refer to a variable
4638 \c{var} in the \c{data} segment as \c{var wrt data} or as \c{var wrt
4639 dgroup}, depending on which segment value is currently in your
4640 segment register.
4642 If you just refer to \c{var}, however, and \c{var} is declared in a
4643 segment which is part of a group, then NASM will default to giving
4644 you the offset of \c{var} from the beginning of the \e{group}, not
4645 the \e{segment}. Therefore \c{SEG var}, also, will return the group
4646 base rather than the segment base.
4648 NASM will allow a segment to be part of more than one group, but
4649 will generate a warning if you do this. Variables declared in a
4650 segment which is part of more than one group will default to being
4651 relative to the first group that was defined to contain the segment.
4653 A group does not have to contain any segments; you can still make
4654 \c{WRT} references to a group which does not contain the variable
4655 you are referring to. OS/2, for example, defines the special group
4656 \c{FLAT} with no segments in it.
4659 \S{uppercase} \i\c{UPPERCASE}: Disabling Case Sensitivity in Output
4661 Although NASM itself is \i{case sensitive}, some OMF linkers are
4662 not; therefore it can be useful for NASM to output single-case
4663 object files. The \c{UPPERCASE} format-specific directive causes all
4664 segment, group and symbol names that are written to the object file
4665 to be forced to upper case just before being written. Within a
4666 source file, NASM is still case-sensitive; but the object file can
4667 be written entirely in upper case if desired.
4669 \c{UPPERCASE} is used alone on a line; it requires no parameters.
4672 \S{import} \i\c{IMPORT}: Importing DLL Symbols\I{DLL symbols,
4673 importing}\I{symbols, importing from DLLs}
4675 The \c{IMPORT} format-specific directive defines a symbol to be
4676 imported from a DLL, for use if you are writing a DLL's \i{import
4677 library} in NASM. You still need to declare the symbol as \c{EXTERN}
4678 as well as using the \c{IMPORT} directive.
4680 The \c{IMPORT} directive takes two required parameters, separated by
4681 white space, which are (respectively) the name of the symbol you
4682 wish to import and the name of the library you wish to import it
4683 from. For example:
4685 \c     import  WSAStartup wsock32.dll
4687 A third optional parameter gives the name by which the symbol is
4688 known in the library you are importing it from, in case this is not
4689 the same as the name you wish the symbol to be known by to your code
4690 once you have imported it. For example:
4692 \c     import  asyncsel wsock32.dll WSAAsyncSelect
4695 \S{export} \i\c{EXPORT}: Exporting DLL Symbols\I{DLL symbols,
4696 exporting}\I{symbols, exporting from DLLs}
4698 The \c{EXPORT} format-specific directive defines a global symbol to
4699 be exported as a DLL symbol, for use if you are writing a DLL in
4700 NASM. You still need to declare the symbol as \c{GLOBAL} as well as
4701 using the \c{EXPORT} directive.
4703 \c{EXPORT} takes one required parameter, which is the name of the
4704 symbol you wish to export, as it was defined in your source file. An
4705 optional second parameter (separated by white space from the first)
4706 gives the \e{external} name of the symbol: the name by which you
4707 wish the symbol to be known to programs using the DLL. If this name
4708 is the same as the internal name, you may leave the second parameter
4709 off.
4711 Further parameters can be given to define attributes of the exported
4712 symbol. These parameters, like the second, are separated by white
4713 space. If further parameters are given, the external name must also
4714 be specified, even if it is the same as the internal name. The
4715 available attributes are:
4717 \b \c{resident} indicates that the exported name is to be kept
4718 resident by the system loader. This is an optimisation for
4719 frequently used symbols imported by name.
4721 \b \c{nodata} indicates that the exported symbol is a function which
4722 does not make use of any initialized data.
4724 \b \c{parm=NNN}, where \c{NNN} is an integer, sets the number of
4725 parameter words for the case in which the symbol is a call gate
4726 between 32-bit and 16-bit segments.
4728 \b An attribute which is just a number indicates that the symbol
4729 should be exported with an identifying number (ordinal), and gives
4730 the desired number.
4732 For example:
4734 \c     export  myfunc
4735 \c     export  myfunc TheRealMoreFormalLookingFunctionName
4736 \c     export  myfunc myfunc 1234  ; export by ordinal
4737 \c     export  myfunc myfunc resident parm=23 nodata
4740 \S{dotdotstart} \i\c{..start}: Defining the \i{Program Entry
4741 Point}
4743 \c{OMF} linkers require exactly one of the object files being linked to
4744 define the program entry point, where execution will begin when the
4745 program is run. If the object file that defines the entry point is
4746 assembled using NASM, you specify the entry point by declaring the
4747 special symbol \c{..start} at the point where you wish execution to
4748 begin.
4751 \S{objextern} \c{obj} Extensions to the \c{EXTERN}
4752 Directive\I{EXTERN, obj extensions to}
4754 If you declare an external symbol with the directive
4756 \c     extern  foo
4758 then references such as \c{mov ax,foo} will give you the offset of
4759 \c{foo} from its preferred segment base (as specified in whichever
4760 module \c{foo} is actually defined in). So to access the contents of
4761 \c{foo} you will usually need to do something like
4763 \c         mov     ax,seg foo      ; get preferred segment base
4764 \c         mov     es,ax           ; move it into ES
4765 \c         mov     ax,[es:foo]     ; and use offset `foo' from it
4767 This is a little unwieldy, particularly if you know that an external
4768 is going to be accessible from a given segment or group, say
4769 \c{dgroup}. So if \c{DS} already contained \c{dgroup}, you could
4770 simply code
4772 \c         mov     ax,[foo wrt dgroup]
4774 However, having to type this every time you want to access \c{foo}
4775 can be a pain; so NASM allows you to declare \c{foo} in the
4776 alternative form
4778 \c     extern  foo:wrt dgroup
4780 This form causes NASM to pretend that the preferred segment base of
4781 \c{foo} is in fact \c{dgroup}; so the expression \c{seg foo} will
4782 now return \c{dgroup}, and the expression \c{foo} is equivalent to
4783 \c{foo wrt dgroup}.
4785 This \I{default-WRT mechanism}default-\c{WRT} mechanism can be used
4786 to make externals appear to be relative to any group or segment in
4787 your program. It can also be applied to common variables: see
4788 \k{objcommon}.
4791 \S{objcommon} \c{obj} Extensions to the \c{COMMON}
4792 Directive\I{COMMON, obj extensions to}
4794 The \c{obj} format allows common variables to be either near\I{near
4795 common variables} or far\I{far common variables}; NASM allows you to
4796 specify which your variables should be by the use of the syntax
4798 \c common  nearvar 2:near   ; `nearvar' is a near common
4799 \c common  farvar  10:far   ; and `farvar' is far
4801 Far common variables may be greater in size than 64Kb, and so the
4802 OMF specification says that they are declared as a number of
4803 \e{elements} of a given size. So a 10-byte far common variable could
4804 be declared as ten one-byte elements, five two-byte elements, two
4805 five-byte elements or one ten-byte element.
4807 Some \c{OMF} linkers require the \I{element size, in common
4808 variables}\I{common variables, element size}element size, as well as
4809 the variable size, to match when resolving common variables declared
4810 in more than one module. Therefore NASM must allow you to specify
4811 the element size on your far common variables. This is done by the
4812 following syntax:
4814 \c common  c_5by2  10:far 5        ; two five-byte elements
4815 \c common  c_2by5  10:far 2        ; five two-byte elements
4817 If no element size is specified, the default is 1. Also, the \c{FAR}
4818 keyword is not required when an element size is specified, since
4819 only far commons may have element sizes at all. So the above
4820 declarations could equivalently be
4822 \c common  c_5by2  10:5            ; two five-byte elements
4823 \c common  c_2by5  10:2            ; five two-byte elements
4825 In addition to these extensions, the \c{COMMON} directive in \c{obj}
4826 also supports default-\c{WRT} specification like \c{EXTERN} does
4827 (explained in \k{objextern}). So you can also declare things like
4829 \c common  foo     10:wrt dgroup
4830 \c common  bar     16:far 2:wrt data
4831 \c common  baz     24:wrt data:6
4834 \H{win32fmt} \i\c{win32}: Microsoft Win32 Object Files
4836 The \c{win32} output format generates Microsoft Win32 object files,
4837 suitable for passing to Microsoft linkers such as \i{Visual C++}.
4838 Note that Borland Win32 compilers do not use this format, but use
4839 \c{obj} instead (see \k{objfmt}).
4841 \c{win32} provides a default output file-name extension of \c{.obj}.
4843 Note that although Microsoft say that Win32 object files follow the
4844 \c{COFF} (Common Object File Format) standard, the object files produced
4845 by Microsoft Win32 compilers are not compatible with COFF linkers
4846 such as DJGPP's, and vice versa. This is due to a difference of
4847 opinion over the precise semantics of PC-relative relocations. To
4848 produce COFF files suitable for DJGPP, use NASM's \c{coff} output
4849 format; conversely, the \c{coff} format does not produce object
4850 files that Win32 linkers can generate correct output from.
4853 \S{win32sect} \c{win32} Extensions to the \c{SECTION}
4854 Directive\I{SECTION, win32 extensions to}
4856 Like the \c{obj} format, \c{win32} allows you to specify additional
4857 information on the \c{SECTION} directive line, to control the type
4858 and properties of sections you declare. Section types and properties
4859 are generated automatically by NASM for the \i{standard section names}
4860 \c{.text}, \c{.data} and \c{.bss}, but may still be overridden by
4861 these qualifiers.
4863 The available qualifiers are:
4865 \b \c{code}, or equivalently \c{text}, defines the section to be a
4866 code section. This marks the section as readable and executable, but
4867 not writable, and also indicates to the linker that the type of the
4868 section is code.
4870 \b \c{data} and \c{bss} define the section to be a data section,
4871 analogously to \c{code}. Data sections are marked as readable and
4872 writable, but not executable. \c{data} declares an initialized data
4873 section, whereas \c{bss} declares an uninitialized data section.
4875 \b \c{rdata} declares an initialized data section that is readable
4876 but not writable. Microsoft compilers use this section to place
4877 constants in it.
4879 \b \c{info} defines the section to be an \i{informational section},
4880 which is not included in the executable file by the linker, but may
4881 (for example) pass information \e{to} the linker. For example,
4882 declaring an \c{info}-type section called \i\c{.drectve} causes the
4883 linker to interpret the contents of the section as command-line
4884 options.
4886 \b \c{align=}, used with a trailing number as in \c{obj}, gives the
4887 \I{section alignment, in win32}\I{alignment, in win32
4888 sections}alignment requirements of the section. The maximum you may
4889 specify is 64: the Win32 object file format contains no means to
4890 request a greater section alignment than this. If alignment is not
4891 explicitly specified, the defaults are 16-byte alignment for code
4892 sections, 8-byte alignment for rdata sections and 4-byte alignment
4893 for data (and BSS) sections.
4894 Informational sections get a default alignment of 1 byte (no
4895 alignment), though the value does not matter.
4897 The defaults assumed by NASM if you do not specify the above
4898 qualifiers are:
4900 \c section .text    code  align=16
4901 \c section .data    data  align=4
4902 \c section .rdata   rdata align=8
4903 \c section .bss     bss   align=4
4905 Any other section name is treated by default like \c{.text}.
4907 \S{win32safeseh} \c{win32}: Safe Structured Exception Handling
4909 Among other improvements in Windows XP SP2 and Windows Server 2003
4910 Microsoft has introduced concept of "safe structured exception
4911 handling." General idea is to collect handlers' entry points in
4912 designated read-only table and have alleged entry point verified
4913 against this table prior exception control is passed to the handler. In
4914 order for an executable module to be equipped with such "safe exception
4915 handler table," all object modules on linker command line has to comply
4916 with certain criteria. If one single module among them does not, then
4917 the table in question is omitted and above mentioned run-time checks
4918 will not be performed for application in question. Table omission is by
4919 default silent and therefore can be easily overlooked. One can instruct
4920 linker to refuse to produce binary without such table by passing
4921 \c{/safeseh} command line option.
4923 Without regard to this run-time check merits it's natural to expect
4924 NASM to be capable of generating modules suitable for \c{/safeseh}
4925 linking. From developer's viewpoint the problem is two-fold:
4927 \b how to adapt modules not deploying exception handlers of their own;
4929 \b how to adapt/develop modules utilizing custom exception handling;
4931 Former can be easily achieved with any NASM version by adding following
4932 line to source code:
4934 \c $@feat.00 equ 1
4936 As of version 2.03 NASM adds this absolute symbol automatically. If
4937 it's not already present to be precise. I.e. if for whatever reason
4938 developer would choose to assign another value in source file, it would
4939 still be perfectly possible.
4941 Registering custom exception handler on the other hand requires certain
4942 "magic." As of version 2.03 additional directive is implemented,
4943 \c{safeseh}, which instructs the assembler to produce appropriately
4944 formatted input data for above mentioned "safe exception handler 
4945 table." Its typical use would be:
4947 \c section .text
4948 \c extern  _MessageBoxA@16
4949 \c %if     __NASM_VERSION_ID__ >= 0x02030000
4950 \c safeseh handler         ; register handler as "safe handler"
4951 \c %endif
4952 \c handler:
4953 \c         push    DWORD 1 ; MB_OKCANCEL
4954 \c         push    DWORD caption
4955 \c         push    DWORD text
4956 \c         push    DWORD 0
4957 \c         call    _MessageBoxA@16
4958 \c         sub     eax,1   ; incidentally suits as return value
4959 \c                         ; for exception handler
4960 \c         ret
4961 \c global  _main
4962 \c _main:
4963 \c         push    DWORD handler
4964 \c         push    DWORD [fs:0]
4965 \c         mov     DWORD [fs:0],esp ; engage exception handler
4966 \c         xor     eax,eax
4967 \c         mov     eax,DWORD[eax]   ; cause exception
4968 \c         pop     DWORD [fs:0]     ; disengage exception handler
4969 \c         add     esp,4
4970 \c         ret
4971 \c text:   db      'OK to rethrow, CANCEL to generate core dump',0
4972 \c caption:db      'SEGV',0
4973 \c 
4974 \c section .drectve info
4975 \c         db      '/defaultlib:user32.lib /defaultlib:msvcrt.lib '
4977 As you might imagine, it's perfectly possible to produce .exe binary
4978 with "safe exception handler table" and yet engage unregistered
4979 exception handler. Indeed, handler is engaged by simply manipulating
4980 \c{[fs:0]} location at run-time, something linker has no power over, 
4981 run-time that is. It should be explicitly mentioned that such failure
4982 to register handler's entry point with \c{safeseh} directive has
4983 undesired side effect at run-time. If exception is raised and
4984 unregistered handler is to be executed, the application is abruptly
4985 terminated without any notification whatsoever. One can argue that
4986 system could  at least have logged some kind "non-safe exception
4987 handler in x.exe at address n" message in event log, but no, literally
4988 no notification is provided and user is left with no clue on what
4989 caused application failure.
4991 Finally, all mentions of linker in this paragraph refer to Microsoft
4992 linker version 7.x and later. Presence of \c{@feat.00} symbol and input
4993 data for "safe exception handler table" causes no backward
4994 incompatibilities and "safeseh" modules generated by NASM 2.03 and
4995 later can still be linked by earlier versions or non-Microsoft linkers.
4998 \H{win64fmt} \i\c{win64}: Microsoft Win64 Object Files
5000 The \c{win64} output format generates Microsoft Win64 object files, 
5001 which is nearly 100% identical to the \c{win32} object format (\k{win32fmt})
5002 with the exception that it is meant to target 64-bit code and the x86-64
5003 platform altogether. This object file is used exactly the same as the \c{win32}
5004 object format (\k{win32fmt}), in NASM, with regard to this exception.
5006 \S{win64pic} \c{win64}: Writing Position-Independent Code
5008 While \c{REL} takes good care of RIP-relative addressing, there is one
5009 aspect that is easy to overlook for a Win64 programmer: indirect
5010 references. Consider a switch dispatch table:
5012 \c         jmp     QWORD[dsptch+rax*8]
5013 \c         ...
5014 \c dsptch: dq      case0
5015 \c         dq      case1
5016 \c         ...
5018 Even novice Win64 assembler programmer will soon realize that the code
5019 is not 64-bit savvy. Most notably linker will refuse to link it with
5020 "\c{'ADDR32' relocation to '.text' invalid without
5021 /LARGEADDRESSAWARE:NO}". So [s]he will have to split jmp instruction as
5022 following:
5024 \c         lea     rbx,[rel dsptch]
5025 \c         jmp     QWORD[rbx+rax*8]
5027 What happens behind the scene is that effective address in \c{lea} is
5028 encoded relative to instruction pointer, or in perfectly
5029 position-independent manner. But this is only part of the problem!
5030 Trouble is that in .dll context \c{caseN} relocations will make their
5031 way to the final module and might have to be adjusted at .dll load
5032 time. To be specific when it can't be loaded at preferred address. And
5033 when this occurs, pages with such relocations will be rendered private
5034 to current process, which kind of undermines the idea of sharing .dll.
5035 But no worry, it's trivial to fix:
5037 \c         lea     rbx,[rel dsptch]
5038 \c         add     rbx,QWORD[rbx+rax*8]
5039 \c         jmp     rbx
5040 \c         ...
5041 \c dsptch: dq      case0-dsptch
5042 \c         dq      case1-dsptch
5043 \c         ...
5045 NASM version 2.03 and later provides another alternative, \c{wrt
5046 ..imagebase} operator, which returns offset from base address of the
5047 current image, be it .exe or .dll module, therefore the name. For those
5048 acquainted with PE-COFF format base address denotes start of
5049 \c{IMAGE_DOS_HEADER} structure. Here is how to implement switch with
5050 these image-relative references:
5052 \c         lea     rbx,[rel dsptch]
5053 \c         mov     eax,DWORD[rbx+rax*4]
5054 \c         sub     rbx,dsptch wrt ..imagebase
5055 \c         add     rbx,rax
5056 \c         jmp     rbx
5057 \c         ...
5058 \c dsptch: dd      case0 wrt ..imagebase
5059 \c         dd      case1 wrt ..imagebase
5061 One can argue that the operator is redundant. Indeed,  snippet before
5062 last works just fine with any NASM version and is not even Windows
5063 specific... The real reason for implementing \c{wrt ..imagebase} will
5064 become apparent in next paragraph.
5066 It should be noted that \c{wrt ..imagebase} is defined as 32-bit
5067 operand only:
5069 \c         dd      label wrt ..imagebase           ; ok
5070 \c         dq      label wrt ..imagebase           ; bad
5071 \c         mov     eax,label wrt ..imagebase       ; ok
5072 \c         mov     rax,label wrt ..imagebase       ; bad
5074 \S{win64seh} \c{win64}: Structured Exception Handling
5076 Structured exception handing in Win64 is completely different matter
5077 from Win32. Upon exception program counter value is noted, and
5078 linker-generated table comprising start and end addresses of all the
5079 functions [in given executable module] is traversed and compared to the
5080 saved program counter. Thus so called \c{UNWIND_INFO} structure is
5081 identified. If it's not found, then offending subroutine is assumed to
5082 be "leaf" and just mentioned lookup procedure is attempted for its
5083 caller. In Win64 leaf function is such function that does not call any
5084 other function \e{nor} modifies any Win64 non-volatile registers,
5085 including stack pointer. The latter ensures that it's possible to
5086 identify leaf function's caller by simply pulling the value from the
5087 top of the stack.
5089 While majority of subroutines written in assembler are not calling any
5090 other function, requirement for non-volatile registers' immutability
5091 leaves developer with not more than 7 registers and no stack frame,
5092 which is not necessarily what [s]he counted with. Customarily one would
5093 meet the requirement by saving non-volatile registers on stack and
5094 restoring them upon return, so what can go wrong? If [and only if] an
5095 exception is raised at run-time and no \c{UNWIND_INFO} structure is
5096 associated with such "leaf" function, the stack unwind procedure will
5097 expect to find caller's return address on the top of stack immediately
5098 followed by its frame. Given that developer pushed caller's
5099 non-volatile registers on stack, would the value on top point at some
5100 code segment or even addressable space? Well, developer can attempt
5101 copying caller's return address to the top of stack and this would
5102 actually work in some very specific circumstances. But unless developer
5103 can guarantee that these circumstances are always met, it's more
5104 appropriate to assume worst case scenario, i.e. stack unwind procedure
5105 going berserk. Relevant question is what happens then? Application is
5106 abruptly terminated without any notification whatsoever. Just like in
5107 Win32 case, one can argue that system could at least have logged
5108 "unwind procedure went berserk in x.exe at address n" in event log, but
5109 no, no trace of failure is left.
5111 Now, when we understand significance of the \c{UNWIND_INFO} structure,
5112 let's discuss what's in it and/or how it's processed. First of all it
5113 is checked for presence of reference to custom language-specific
5114 exception handler. If there is one, then it's invoked. Depending on the
5115 return value, execution flow is resumed (exception is said to be
5116 "handled"), \e{or} rest of \c{UNWIND_INFO} structure is processed as
5117 following. Beside optional reference to custom handler, it carries
5118 information about current callee's stack frame and where non-volatile
5119 registers are saved. Information is detailed enough to be able to
5120 reconstruct contents of caller's non-volatile registers upon call to
5121 current callee. And so caller's context is reconstructed, and then
5122 unwind procedure is repeated, i.e. another \c{UNWIND_INFO} structure is
5123 associated, this time, with caller's instruction pointer, which is then
5124 checked for presence of reference to language-specific handler, etc.
5125 The procedure is recursively repeated till exception is handled. As
5126 last resort system "handles" it by generating memory core dump and
5127 terminating the application.
5129 As for the moment of this writing NASM unfortunately does not
5130 facilitate generation of above mentioned detailed information about
5131 stack frame layout. But as of version 2.03 it implements building
5132 blocks for generating structures involved in stack unwinding. As
5133 simplest example, here is how to deploy custom exception handler for
5134 leaf function:
5136 \c default rel
5137 \c section .text
5138 \c extern  MessageBoxA
5139 \c handler:
5140 \c         sub     rsp,40
5141 \c         mov     rcx,0
5142 \c         lea     rdx,[text]
5143 \c         lea     r8,[caption]
5144 \c         mov     r9,1    ; MB_OKCANCEL
5145 \c         call    MessageBoxA
5146 \c         sub     eax,1   ; incidentally suits as return value
5147 \c                         ; for exception handler
5148 \c         add     rsp,40
5149 \c         ret
5150 \c global  main
5151 \c main:
5152 \c         xor     rax,rax
5153 \c         mov     rax,QWORD[rax]  ; cause exception
5154 \c         ret
5155 \c main_end:
5156 \c text:   db      'OK to rethrow, CANCEL to generate core dump',0
5157 \c caption:db      'SEGV',0
5158 \c 
5159 \c section .pdata  rdata align=4
5160 \c         dd      main wrt ..imagebase
5161 \c         dd      main_end wrt ..imagebase
5162 \c         dd      xmain wrt ..imagebase
5163 \c section .xdata  rdata align=8
5164 \c xmain:  db      9,0,0,0
5165 \c         dd      handler wrt ..imagebase
5166 \c section .drectve info
5167 \c         db      '/defaultlib:user32.lib /defaultlib:msvcrt.lib '
5169 What you see in \c{.pdata} section is element of the "table comprising
5170 start and end addresses of function" along with reference to associated
5171 \c{UNWIND_INFO} structure. And what you see in \c{.xdata} section is
5172 \c{UNWIND_INFO} structure describing function with no frame, but with
5173 designated exception handler. References are \e{required} to be
5174 image-relative (which is the real reason for implementing \c{wrt
5175 ..imagebase} operator). It should be noted that \c{rdata align=n}, as
5176 well as \c{wrt ..imagebase}, are optional in these two segments'
5177 contexts, i.e. can be omitted. Latter means that \e{all} 32-bit
5178 references, not only above listed required ones, placed into these two
5179 segments turn out image-relative. Why is it important to understand?
5180 Developer is allowed to append handler-specific data to \c{UNWIND_INFO}
5181 structure, and if [s]he adds a 32-bit reference, then [s]he will have
5182 to remember to adjust its value to obtain the real pointer.
5184 As already mentioned, in Win64 terms leaf function is one that does not
5185 call any other function \e{nor} modifies any non-volatile register,
5186 including stack pointer. But it's not uncommon that assembler
5187 programmer plans to utilize every single register and sometimes even
5188 have variable stack frame. Is there anything one can do with bare
5189 building blocks? I.e. besides manually composing fully-fledged
5190 \c{UNWIND_INFO} structure, which would surely be considered
5191 error-prone? Yes, there is. Recall that exception handler is called
5192 first, before stack layout is analyzed. As it turned out, it's
5193 perfectly possible to manipulate current callee's context in custom
5194 handler in manner that permits further stack unwinding. General idea is
5195 that handler would not actually "handle" the exception, but instead
5196 restore callee's context, as it was at its entry point and thus mimic
5197 leaf function. In other words, handler would simply undertake part of
5198 unwinding procedure. Consider following example:
5200 \c function:
5201 \c         mov     rax,rsp         ; copy rsp to volatile register
5202 \c         push    r15             ; save non-volatile registers
5203 \c         push    rbx
5204 \c         push    rbp
5205 \c         mov     r11,rsp         ; prepare variable stack frame
5206 \c         sub     r11,rcx
5207 \c         and     r11,-64
5208 \c         mov     QWORD[r11],rax  ; check for exceptions
5209 \c         mov     rsp,r11         ; allocate stack frame
5210 \c         mov     QWORD[rsp],rax  ; save original rsp value
5211 \c magic_point:
5212 \c         ...
5213 \c         mov     r11,QWORD[rsp]  ; pull original rsp value
5214 \c         mov     rbp,QWORD[r11-24]
5215 \c         mov     rbx,QWORD[r11-16]
5216 \c         mov     r15,QWORD[r11-8]
5217 \c         mov     rsp,r11         ; destroy frame
5218 \c         ret
5220 The keyword is that up to \c{magic_point} original \c{rsp} value
5221 remains in chosen volatile register and no non-volatile register,
5222 except for \c{rsp}, is modified. While past \c{magic_point} \c{rsp}
5223 remains constant till the very end of the \c{function}. In this case
5224 custom language-specific exception handler would look like this:
5226 \c EXCEPTION_DISPOSITION handler (EXCEPTION_RECORD *rec,ULONG64 frame,
5227 \c         CONTEXT *context,DISPATCHER_CONTEXT *disp)
5228 \c {   ULONG64 *rsp;
5229 \c     if (context->Rip<(ULONG64)magic_point)
5230 \c         rsp = (ULONG64 *)context->Rax;
5231 \c     else
5232 \c     {   rsp = ((ULONG64 **)context->Rsp)[0];
5233 \c         context->Rbp = rsp[-3];
5234 \c         context->Rbx = rsp[-2];
5235 \c         context->R15 = rsp[-1];
5236 \c     }
5237 \c     context->Rsp = (ULONG64)rsp;
5238 \c 
5239 \c     memcpy (disp->ContextRecord,context,sizeof(CONTEXT));
5240 \c     RtlVirtualUnwind(UNW_FLAG_NHANDLER,disp->ImageBase,
5241 \c         dips->ControlPc,disp->FunctionEntry,disp->ContextRecord,
5242 \c         &disp->HandlerData,&disp->EstablisherFrame,NULL);
5243 \c     return ExceptionContinueSearch;
5244 \c }
5246 As custom handler mimics leaf function, corresponding \c{UNWIND_INFO}
5247 structure does not have to contain any information about stack frame
5248 and its layout.
5250 \H{cofffmt} \i\c{coff}: \i{Common Object File Format}
5252 The \c{coff} output type produces \c{COFF} object files suitable for
5253 linking with the \i{DJGPP} linker.
5255 \c{coff} provides a default output file-name extension of \c{.o}.
5257 The \c{coff} format supports the same extensions to the \c{SECTION}
5258 directive as \c{win32} does, except that the \c{align} qualifier and
5259 the \c{info} section type are not supported.
5261 \H{machofmt} \i\c{macho}: \i{Mach Object File Format}
5263 The \c{macho} output type produces \c{Mach-O} object files suitable for
5264 linking with the \i{Mac OSX} linker.
5266 \c{macho} provides a default output file-name extension of \c{.o}.
5268 \H{elffmt} \i\c{elf, elf32, and elf64}: \I{ELF}\I{linux, elf}\i{Executable and Linkable
5269 Format} Object Files
5271 The \c{elf32} and \c{elf64} output formats generate \c{ELF32 and ELF64} (Executable and Linkable Format) object files, as used by Linux as well as \i{Unix System V},
5272 including \i{Solaris x86}, \i{UnixWare} and \i{SCO Unix}. \c{elf}
5273 provides a default output file-name extension of \c{.o}.
5274 \c{elf} is a synonym for \c{elf32}.
5276 \S{abisect} ELF specific directive \i\c{osabi}
5278 The ELF header specifies the application binary interface for the target operating system (OSABI).
5279 This field can be set by using the \c{osabi} directive with the numeric value (0-255) of the target
5280  system. If this directive is not used, the default value will be "UNIX System V ABI" (0) which will work on
5281  most systems which support ELF.
5283 \S{elfsect} \c{elf} Extensions to the \c{SECTION}
5284 Directive\I{SECTION, elf extensions to}
5286 Like the \c{obj} format, \c{elf} allows you to specify additional
5287 information on the \c{SECTION} directive line, to control the type
5288 and properties of sections you declare. Section types and properties
5289 are generated automatically by NASM for the \i{standard section
5290 names}, but may still be
5291 overridden by these qualifiers.
5293 The available qualifiers are:
5295 \b \i\c{alloc} defines the section to be one which is loaded into
5296 memory when the program is run. \i\c{noalloc} defines it to be one
5297 which is not, such as an informational or comment section.
5299 \b \i\c{exec} defines the section to be one which should have execute
5300 permission when the program is run. \i\c{noexec} defines it as one
5301 which should not.
5303 \b \i\c{write} defines the section to be one which should be writable
5304 when the program is run. \i\c{nowrite} defines it as one which should
5305 not.
5307 \b \i\c{progbits} defines the section to be one with explicit contents
5308 stored in the object file: an ordinary code or data section, for
5309 example, \i\c{nobits} defines the section to be one with no explicit
5310 contents given, such as a BSS section.
5312 \b \c{align=}, used with a trailing number as in \c{obj}, gives the
5313 \I{section alignment, in elf}\I{alignment, in elf sections}alignment
5314 requirements of the section.
5316 \b \i\c{tls} defines the section to be one which contains
5317 thread local variables.
5319 The defaults assumed by NASM if you do not specify the above
5320 qualifiers are:
5322 \I\c{.text} \I\c{.data} \I\c{.bss} \I\c{.rodata} \I\c{.tdata} \I\c{.tbss}
5324 \c section .text    progbits  alloc  exec    nowrite  align=16
5325 \c section .rodata  progbits  alloc  noexec  nowrite  align=4
5326 \c section .data    progbits  alloc  noexec  write    align=4
5327 \c section .bss     nobits    alloc  noexec  write    align=4
5328 \c section .tdata   progbits  alloc  noexec  write    align=4    tls
5329 \c section .tbss    nobits    alloc  noexec  write    align=4    tls
5330 \c section other    progbits  alloc  noexec  nowrite  align=1
5332 (Any section name other than those in the above table
5333  is treated by default like \c{other} in the above table.
5334  Please note that section names are case sensitive.)
5337 \S{elfwrt} \i{Position-Independent Code}\I{PIC}: \c{elf} Special
5338 Symbols and \i\c{WRT}
5340 The \c{ELF} specification contains enough features to allow
5341 position-independent code (PIC) to be written, which makes \i{ELF
5342 shared libraries} very flexible. However, it also means NASM has to
5343 be able to generate a variety of ELF specific relocation types in ELF
5344 object files, if it is to be an assembler which can write PIC.
5346 Since \c{ELF} does not support segment-base references, the \c{WRT}
5347 operator is not used for its normal purpose; therefore NASM's
5348 \c{elf} output format makes use of \c{WRT} for a different purpose,
5349 namely the PIC-specific \I{relocations, PIC-specific}relocation
5350 types.
5352 \c{elf} defines five special symbols which you can use as the
5353 right-hand side of the \c{WRT} operator to obtain PIC relocation
5354 types. They are \i\c{..gotpc}, \i\c{..gotoff}, \i\c{..got},
5355 \i\c{..plt} and \i\c{..sym}. Their functions are summarized here:
5357 \b Referring to the symbol marking the global offset table base
5358 using \c{wrt ..gotpc} will end up giving the distance from the
5359 beginning of the current section to the global offset table.
5360 (\i\c{_GLOBAL_OFFSET_TABLE_} is the standard symbol name used to
5361 refer to the \i{GOT}.) So you would then need to add \i\c{$$} to the
5362 result to get the real address of the GOT.
5364 \b Referring to a location in one of your own sections using \c{wrt
5365 ..gotoff} will give the distance from the beginning of the GOT to
5366 the specified location, so that adding on the address of the GOT
5367 would give the real address of the location you wanted.
5369 \b Referring to an external or global symbol using \c{wrt ..got}
5370 causes the linker to build an entry \e{in} the GOT containing the
5371 address of the symbol, and the reference gives the distance from the
5372 beginning of the GOT to the entry; so you can add on the address of
5373 the GOT, load from the resulting address, and end up with the
5374 address of the symbol.
5376 \b Referring to a procedure name using \c{wrt ..plt} causes the
5377 linker to build a \i{procedure linkage table} entry for the symbol,
5378 and the reference gives the address of the \i{PLT} entry. You can
5379 only use this in contexts which would generate a PC-relative
5380 relocation normally (i.e. as the destination for \c{CALL} or
5381 \c{JMP}), since ELF contains no relocation type to refer to PLT
5382 entries absolutely.
5384 \b Referring to a symbol name using \c{wrt ..sym} causes NASM to
5385 write an ordinary relocation, but instead of making the relocation
5386 relative to the start of the section and then adding on the offset
5387 to the symbol, it will write a relocation record aimed directly at
5388 the symbol in question. The distinction is a necessary one due to a
5389 peculiarity of the dynamic linker.
5391 A fuller explanation of how to use these relocation types to write
5392 shared libraries entirely in NASM is given in \k{picdll}.
5394 \S{elftls} \i{Thread Local Storage}\I{TLS}: \c{elf} Special
5395 Symbols and \i\c{WRT}
5397 \b In ELF32 mode, referring to an external or global symbol using
5398 \c{wrt ..tlsie} \I\c{..tlsie}
5399 causes the linker to build an entry \e{in} the GOT containing the
5400 offset of the symbol within the TLS block, so you can access the value
5401 of the symbol with code such as:
5403 \c        mov  eax,[tid wrt ..tlsie]
5404 \c        mov  [gs:eax],ebx
5407 \b In ELF64 mode, referring to an external or global symbol using
5408 \c{wrt ..gottpoff} \I\c{..gottpoff}
5409 causes the linker to build an entry \e{in} the GOT containing the
5410 offset of the symbol within the TLS block, so you can access the value
5411 of the symbol with code such as:
5413 \c        mov   rax,[rel tid wrt ..gottpoff]
5414 \c        mov   rcx,[fs:rax]
5417 \S{elfglob} \c{elf} Extensions to the \c{GLOBAL} Directive\I{GLOBAL,
5418 elf extensions to}\I{GLOBAL, aoutb extensions to}
5420 \c{ELF} object files can contain more information about a global symbol
5421 than just its address: they can contain the \I{symbol sizes,
5422 specifying}\I{size, of symbols}size of the symbol and its \I{symbol
5423 types, specifying}\I{type, of symbols}type as well. These are not
5424 merely debugger conveniences, but are actually necessary when the
5425 program being written is a \i{shared library}. NASM therefore
5426 supports some extensions to the \c{GLOBAL} directive, allowing you
5427 to specify these features.
5429 You can specify whether a global variable is a function or a data
5430 object by suffixing the name with a colon and the word
5431 \i\c{function} or \i\c{data}. (\i\c{object} is a synonym for
5432 \c{data}.) For example:
5434 \c global   hashlookup:function, hashtable:data
5436 exports the global symbol \c{hashlookup} as a function and
5437 \c{hashtable} as a data object.
5439 Optionally, you can control the ELF visibility of the symbol.  Just
5440 add one of the visibility keywords: \i\c{default}, \i\c{internal},
5441 \i\c{hidden}, or \i\c{protected}.  The default is \i\c{default} of
5442 course.  For example, to make \c{hashlookup} hidden:
5444 \c global   hashlookup:function hidden
5446 You can also specify the size of the data associated with the
5447 symbol, as a numeric expression (which may involve labels, and even
5448 forward references) after the type specifier. Like this:
5450 \c global  hashtable:data (hashtable.end - hashtable)
5452 \c hashtable:
5453 \c         db this,that,theother  ; some data here
5454 \c .end:
5456 This makes NASM automatically calculate the length of the table and
5457 place that information into the \c{ELF} symbol table.
5459 Declaring the type and size of global symbols is necessary when
5460 writing shared library code. For more information, see
5461 \k{picglobal}.
5464 \S{elfcomm} \c{elf} Extensions to the \c{COMMON} Directive
5465 \I{COMMON, elf extensions to}
5467 \c{ELF} also allows you to specify alignment requirements \I{common
5468 variables, alignment in elf}\I{alignment, of elf common variables}on
5469 common variables. This is done by putting a number (which must be a
5470 power of two) after the name and size of the common variable,
5471 separated (as usual) by a colon. For example, an array of
5472 doublewords would benefit from 4-byte alignment:
5474 \c common  dwordarray 128:4
5476 This declares the total size of the array to be 128 bytes, and
5477 requires that it be aligned on a 4-byte boundary.
5480 \S{elf16} 16-bit code and ELF
5481 \I{ELF, 16-bit code and}
5483 The \c{ELF32} specification doesn't provide relocations for 8- and
5484 16-bit values, but the GNU \c{ld} linker adds these as an extension.
5485 NASM can generate GNU-compatible relocations, to allow 16-bit code to
5486 be linked as ELF using GNU \c{ld}. If NASM is used with the
5487 \c{-w+gnu-elf-extensions} option, a warning is issued when one of
5488 these relocations is generated.
5490 \S{elfdbg} Debug formats and ELF
5491 \I{ELF, Debug formats and}
5493 \c{ELF32} and \c{ELF64} provide debug information in \c{STABS} and \c{DWARF} formats.
5494 Line number information is generated for all executable sections, but please
5495 note that only the ".text" section is executable by default.
5497 \H{aoutfmt} \i\c{aout}: Linux \I{a.out, Linux version}\I{linux, a.out}\c{a.out} Object Files
5499 The \c{aout} format generates \c{a.out} object files, in the form used
5500 by early Linux systems (current Linux systems use ELF, see
5501 \k{elffmt}.) These differ from other \c{a.out} object files in that
5502 the magic number in the first four bytes of the file is
5503 different; also, some implementations of \c{a.out}, for example
5504 NetBSD's, support position-independent code, which Linux's
5505 implementation does not.
5507 \c{a.out} provides a default output file-name extension of \c{.o}.
5509 \c{a.out} is a very simple object format. It supports no special
5510 directives, no special symbols, no use of \c{SEG} or \c{WRT}, and no
5511 extensions to any standard directives. It supports only the three
5512 \i{standard section names} \i\c{.text}, \i\c{.data} and \i\c{.bss}.
5515 \H{aoutfmt} \i\c{aoutb}: \i{NetBSD}/\i{FreeBSD}/\i{OpenBSD}
5516 \I{a.out, BSD version}\c{a.out} Object Files
5518 The \c{aoutb} format generates \c{a.out} object files, in the form
5519 used by the various free \c{BSD Unix} clones, \c{NetBSD}, \c{FreeBSD}
5520 and \c{OpenBSD}. For simple object files, this object format is exactly
5521 the same as \c{aout} except for the magic number in the first four bytes
5522 of the file. However, the \c{aoutb} format supports
5523 \I{PIC}\i{position-independent code} in the same way as the \c{elf}
5524 format, so you can use it to write \c{BSD} \i{shared libraries}.
5526 \c{aoutb} provides a default output file-name extension of \c{.o}.
5528 \c{aoutb} supports no special directives, no special symbols, and
5529 only the three \i{standard section names} \i\c{.text}, \i\c{.data}
5530 and \i\c{.bss}. However, it also supports the same use of \i\c{WRT} as
5531 \c{elf} does, to provide position-independent code relocation types.
5532 See \k{elfwrt} for full documentation of this feature.
5534 \c{aoutb} also supports the same extensions to the \c{GLOBAL}
5535 directive as \c{elf} does: see \k{elfglob} for documentation of
5536 this.
5539 \H{as86fmt} \c{as86}: \i{Minix}/Linux\I{linux, as86} \i\c{as86} Object Files
5541 The Minix/Linux 16-bit assembler \c{as86} has its own non-standard
5542 object file format. Although its companion linker \i\c{ld86} produces
5543 something close to ordinary \c{a.out} binaries as output, the object
5544 file format used to communicate between \c{as86} and \c{ld86} is not
5545 itself \c{a.out}.
5547 NASM supports this format, just in case it is useful, as \c{as86}.
5548 \c{as86} provides a default output file-name extension of \c{.o}.
5550 \c{as86} is a very simple object format (from the NASM user's point
5551 of view). It supports no special directives, no special symbols, no
5552 use of \c{SEG} or \c{WRT}, and no extensions to any standard
5553 directives. It supports only the three \i{standard section names}
5554 \i\c{.text}, \i\c{.data} and \i\c{.bss}.
5557 \H{rdffmt} \I{RDOFF}\i\c{rdf}: \i{Relocatable Dynamic Object File
5558 Format}
5560 The \c{rdf} output format produces \c{RDOFF} object files. \c{RDOFF}
5561 (Relocatable Dynamic Object File Format) is a home-grown object-file
5562 format, designed alongside NASM itself and reflecting in its file
5563 format the internal structure of the assembler.
5565 \c{RDOFF} is not used by any well-known operating systems. Those
5566 writing their own systems, however, may well wish to use \c{RDOFF}
5567 as their object format, on the grounds that it is designed primarily
5568 for simplicity and contains very little file-header bureaucracy.
5570 The Unix NASM archive, and the DOS archive which includes sources,
5571 both contain an \I{rdoff subdirectory}\c{rdoff} subdirectory holding
5572 a set of RDOFF utilities: an RDF linker, an \c{RDF} static-library
5573 manager, an RDF file dump utility, and a program which will load and
5574 execute an RDF executable under Linux.
5576 \c{rdf} supports only the \i{standard section names} \i\c{.text},
5577 \i\c{.data} and \i\c{.bss}.
5580 \S{rdflib} Requiring a Library: The \i\c{LIBRARY} Directive
5582 \c{RDOFF} contains a mechanism for an object file to demand a given
5583 library to be linked to the module, either at load time or run time.
5584 This is done by the \c{LIBRARY} directive, which takes one argument
5585 which is the name of the module:
5587 \c     library  mylib.rdl
5590 \S{rdfmod} Specifying a Module Name: The \i\c{MODULE} Directive
5592 Special \c{RDOFF} header record is used to store the name of the module.
5593 It can be used, for example, by run-time loader to perform dynamic
5594 linking. \c{MODULE} directive takes one argument which is the name
5595 of current module:
5597 \c     module  mymodname
5599 Note that when you statically link modules and tell linker to strip
5600 the symbols from output file, all module names will be stripped too.
5601 To avoid it, you should start module names with \I{$, prefix}\c{$}, like:
5603 \c     module  $kernel.core
5606 \S{rdfglob} \c{rdf} Extensions to the \c{GLOBAL} directive\I{GLOBAL,
5607 rdf extensions to}
5609 \c{RDOFF} global symbols can contain additional information needed by
5610 the static linker. You can mark a global symbol as exported, thus
5611 telling the linker do not strip it from target executable or library
5612 file. Like in \c{ELF}, you can also specify whether an exported symbol
5613 is a procedure (function) or data object.
5615 Suffixing the name with a colon and the word \i\c{export} you make the
5616 symbol exported:
5618 \c     global  sys_open:export
5620 To specify that exported symbol is a procedure (function), you add the
5621 word \i\c{proc} or \i\c{function} after declaration:
5623 \c     global  sys_open:export proc
5625 Similarly, to specify exported data object, add the word \i\c{data}
5626 or \i\c{object} to the directive:
5628 \c     global  kernel_ticks:export data
5631 \S{rdfimpt} \c{rdf} Extensions to the \c{EXTERN} directive\I{EXTERN,
5632 rdf extensions to}
5634 By default the \c{EXTERN} directive in \c{RDOFF} declares a "pure external" 
5635 symbol (i.e. the static linker will complain if such a symbol is not resolved).
5636 To declare an "imported" symbol, which must be resolved later during a dynamic
5637 linking phase, \c{RDOFF} offers an additional \c{import} modifier. As in
5638 \c{GLOBAL}, you can also specify whether an imported symbol is a procedure
5639 (function) or data object. For example:
5641 \c     library $libc
5642 \c     extern  _open:import
5643 \c     extern  _printf:import proc
5644 \c     extern  _errno:import data
5646 Here the directive \c{LIBRARY} is also included, which gives the dynamic linker
5647 a hint as to where to find requested symbols.
5650 \H{dbgfmt} \i\c{dbg}: Debugging Format
5652 The \c{dbg} output format is not built into NASM in the default
5653 configuration. If you are building your own NASM executable from the
5654 sources, you can define \i\c{OF_DBG} in \c{outform.h} or on the
5655 compiler command line, and obtain the \c{dbg} output format.
5657 The \c{dbg} format does not output an object file as such; instead,
5658 it outputs a text file which contains a complete list of all the
5659 transactions between the main body of NASM and the output-format
5660 back end module. It is primarily intended to aid people who want to
5661 write their own output drivers, so that they can get a clearer idea
5662 of the various requests the main program makes of the output driver,
5663 and in what order they happen.
5665 For simple files, one can easily use the \c{dbg} format like this:
5667 \c nasm -f dbg filename.asm
5669 which will generate a diagnostic file called \c{filename.dbg}.
5670 However, this will not work well on files which were designed for a
5671 different object format, because each object format defines its own
5672 macros (usually user-level forms of directives), and those macros
5673 will not be defined in the \c{dbg} format. Therefore it can be
5674 useful to run NASM twice, in order to do the preprocessing with the
5675 native object format selected:
5677 \c nasm -e -f rdf -o rdfprog.i rdfprog.asm
5678 \c nasm -a -f dbg rdfprog.i
5680 This preprocesses \c{rdfprog.asm} into \c{rdfprog.i}, keeping the
5681 \c{rdf} object format selected in order to make sure RDF special
5682 directives are converted into primitive form correctly. Then the
5683 preprocessed source is fed through the \c{dbg} format to generate
5684 the final diagnostic output.
5686 This workaround will still typically not work for programs intended
5687 for \c{obj} format, because the \c{obj} \c{SEGMENT} and \c{GROUP}
5688 directives have side effects of defining the segment and group names
5689 as symbols; \c{dbg} will not do this, so the program will not
5690 assemble. You will have to work around that by defining the symbols
5691 yourself (using \c{EXTERN}, for example) if you really need to get a
5692 \c{dbg} trace of an \c{obj}-specific source file.
5694 \c{dbg} accepts any section name and any directives at all, and logs
5695 them all to its output file.
5698 \C{16bit} Writing 16-bit Code (DOS, Windows 3/3.1)
5700 This chapter attempts to cover some of the common issues encountered
5701 when writing 16-bit code to run under \c{MS-DOS} or \c{Windows 3.x}. It
5702 covers how to link programs to produce \c{.EXE} or \c{.COM} files,
5703 how to write \c{.SYS} device drivers, and how to interface assembly
5704 language code with 16-bit C compilers and with Borland Pascal.
5707 \H{exefiles} Producing \i\c{.EXE} Files
5709 Any large program written under DOS needs to be built as a \c{.EXE}
5710 file: only \c{.EXE} files have the necessary internal structure
5711 required to span more than one 64K segment. \i{Windows} programs,
5712 also, have to be built as \c{.EXE} files, since Windows does not
5713 support the \c{.COM} format.
5715 In general, you generate \c{.EXE} files by using the \c{obj} output
5716 format to produce one or more \i\c{.OBJ} files, and then linking
5717 them together using a linker. However, NASM also supports the direct
5718 generation of simple DOS \c{.EXE} files using the \c{bin} output
5719 format (by using \c{DB} and \c{DW} to construct the \c{.EXE} file
5720 header), and a macro package is supplied to do this. Thanks to
5721 Yann Guidon for contributing the code for this.
5723 NASM may also support \c{.EXE} natively as another output format in
5724 future releases.
5727 \S{objexe} Using the \c{obj} Format To Generate \c{.EXE} Files
5729 This section describes the usual method of generating \c{.EXE} files
5730 by linking \c{.OBJ} files together.
5732 Most 16-bit programming language packages come with a suitable
5733 linker; if you have none of these, there is a free linker called
5734 \i{VAL}\I{linker, free}, available in \c{LZH} archive format from
5735 \W{ftp://x2ftp.oulu.fi/pub/msdos/programming/lang/}\i\c{x2ftp.oulu.fi}.
5736 An LZH archiver can be found at
5737 \W{ftp://ftp.simtel.net/pub/simtelnet/msdos/arcers}\i\c{ftp.simtel.net}.
5738 There is another `free' linker (though this one doesn't come with
5739 sources) called \i{FREELINK}, available from
5740 \W{http://www.pcorner.com/tpc/old/3-101.html}\i\c{www.pcorner.com}.
5741 A third, \i\c{djlink}, written by DJ Delorie, is available at
5742 \W{http://www.delorie.com/djgpp/16bit/djlink/}\i\c{www.delorie.com}.
5743 A fourth linker, \i\c{ALINK}, written by Anthony A.J. Williams, is
5744 available at \W{http://alink.sourceforge.net}\i\c{alink.sourceforge.net}.
5746 When linking several \c{.OBJ} files into a \c{.EXE} file, you should
5747 ensure that exactly one of them has a start point defined (using the
5748 \I{program entry point}\i\c{..start} special symbol defined by the
5749 \c{obj} format: see \k{dotdotstart}). If no module defines a start
5750 point, the linker will not know what value to give the entry-point
5751 field in the output file header; if more than one defines a start
5752 point, the linker will not know \e{which} value to use.
5754 An example of a NASM source file which can be assembled to a
5755 \c{.OBJ} file and linked on its own to a \c{.EXE} is given here. It
5756 demonstrates the basic principles of defining a stack, initialising
5757 the segment registers, and declaring a start point. This file is
5758 also provided in the \I{test subdirectory}\c{test} subdirectory of
5759 the NASM archives, under the name \c{objexe.asm}.
5761 \c segment code
5763 \c ..start:
5764 \c         mov     ax,data
5765 \c         mov     ds,ax
5766 \c         mov     ax,stack
5767 \c         mov     ss,ax
5768 \c         mov     sp,stacktop
5770 This initial piece of code sets up \c{DS} to point to the data
5771 segment, and initializes \c{SS} and \c{SP} to point to the top of
5772 the provided stack. Notice that interrupts are implicitly disabled
5773 for one instruction after a move into \c{SS}, precisely for this
5774 situation, so that there's no chance of an interrupt occurring
5775 between the loads of \c{SS} and \c{SP} and not having a stack to
5776 execute on.
5778 Note also that the special symbol \c{..start} is defined at the
5779 beginning of this code, which means that will be the entry point
5780 into the resulting executable file.
5782 \c         mov     dx,hello
5783 \c         mov     ah,9
5784 \c         int     0x21
5786 The above is the main program: load \c{DS:DX} with a pointer to the
5787 greeting message (\c{hello} is implicitly relative to the segment
5788 \c{data}, which was loaded into \c{DS} in the setup code, so the
5789 full pointer is valid), and call the DOS print-string function.
5791 \c         mov     ax,0x4c00
5792 \c         int     0x21
5794 This terminates the program using another DOS system call.
5796 \c segment data
5798 \c hello:  db      'hello, world', 13, 10, '$'
5800 The data segment contains the string we want to display.
5802 \c segment stack stack
5803 \c         resb 64
5804 \c stacktop:
5806 The above code declares a stack segment containing 64 bytes of
5807 uninitialized stack space, and points \c{stacktop} at the top of it.
5808 The directive \c{segment stack stack} defines a segment \e{called}
5809 \c{stack}, and also of \e{type} \c{STACK}. The latter is not
5810 necessary to the correct running of the program, but linkers are
5811 likely to issue warnings or errors if your program has no segment of
5812 type \c{STACK}.
5814 The above file, when assembled into a \c{.OBJ} file, will link on
5815 its own to a valid \c{.EXE} file, which when run will print `hello,
5816 world' and then exit.
5819 \S{binexe} Using the \c{bin} Format To Generate \c{.EXE} Files
5821 The \c{.EXE} file format is simple enough that it's possible to
5822 build a \c{.EXE} file by writing a pure-binary program and sticking
5823 a 32-byte header on the front. This header is simple enough that it
5824 can be generated using \c{DB} and \c{DW} commands by NASM itself, so
5825 that you can use the \c{bin} output format to directly generate
5826 \c{.EXE} files.
5828 Included in the NASM archives, in the \I{misc subdirectory}\c{misc}
5829 subdirectory, is a file \i\c{exebin.mac} of macros. It defines three
5830 macros: \i\c{EXE_begin}, \i\c{EXE_stack} and \i\c{EXE_end}.
5832 To produce a \c{.EXE} file using this method, you should start by
5833 using \c{%include} to load the \c{exebin.mac} macro package into
5834 your source file. You should then issue the \c{EXE_begin} macro call
5835 (which takes no arguments) to generate the file header data. Then
5836 write code as normal for the \c{bin} format - you can use all three
5837 standard sections \c{.text}, \c{.data} and \c{.bss}. At the end of
5838 the file you should call the \c{EXE_end} macro (again, no arguments),
5839 which defines some symbols to mark section sizes, and these symbols
5840 are referred to in the header code generated by \c{EXE_begin}.
5842 In this model, the code you end up writing starts at \c{0x100}, just
5843 like a \c{.COM} file - in fact, if you strip off the 32-byte header
5844 from the resulting \c{.EXE} file, you will have a valid \c{.COM}
5845 program. All the segment bases are the same, so you are limited to a
5846 64K program, again just like a \c{.COM} file. Note that an \c{ORG}
5847 directive is issued by the \c{EXE_begin} macro, so you should not
5848 explicitly issue one of your own.
5850 You can't directly refer to your segment base value, unfortunately,
5851 since this would require a relocation in the header, and things
5852 would get a lot more complicated. So you should get your segment
5853 base by copying it out of \c{CS} instead.
5855 On entry to your \c{.EXE} file, \c{SS:SP} are already set up to
5856 point to the top of a 2Kb stack. You can adjust the default stack
5857 size of 2Kb by calling the \c{EXE_stack} macro. For example, to
5858 change the stack size of your program to 64 bytes, you would call
5859 \c{EXE_stack 64}.
5861 A sample program which generates a \c{.EXE} file in this way is
5862 given in the \c{test} subdirectory of the NASM archive, as
5863 \c{binexe.asm}.
5866 \H{comfiles} Producing \i\c{.COM} Files
5868 While large DOS programs must be written as \c{.EXE} files, small
5869 ones are often better written as \c{.COM} files. \c{.COM} files are
5870 pure binary, and therefore most easily produced using the \c{bin}
5871 output format.
5874 \S{combinfmt} Using the \c{bin} Format To Generate \c{.COM} Files
5876 \c{.COM} files expect to be loaded at offset \c{100h} into their
5877 segment (though the segment may change). Execution then begins at
5878 \I\c{ORG}\c{100h}, i.e. right at the start of the program. So to
5879 write a \c{.COM} program, you would create a source file looking
5880 like
5882 \c         org 100h
5884 \c section .text
5886 \c start:
5887 \c         ; put your code here
5889 \c section .data
5891 \c         ; put data items here
5893 \c section .bss
5895 \c         ; put uninitialized data here
5897 The \c{bin} format puts the \c{.text} section first in the file, so
5898 you can declare data or BSS items before beginning to write code if
5899 you want to and the code will still end up at the front of the file
5900 where it belongs.
5902 The BSS (uninitialized data) section does not take up space in the
5903 \c{.COM} file itself: instead, addresses of BSS items are resolved
5904 to point at space beyond the end of the file, on the grounds that
5905 this will be free memory when the program is run. Therefore you
5906 should not rely on your BSS being initialized to all zeros when you
5907 run.
5909 To assemble the above program, you should use a command line like
5911 \c nasm myprog.asm -fbin -o myprog.com
5913 The \c{bin} format would produce a file called \c{myprog} if no
5914 explicit output file name were specified, so you have to override it
5915 and give the desired file name.
5918 \S{comobjfmt} Using the \c{obj} Format To Generate \c{.COM} Files
5920 If you are writing a \c{.COM} program as more than one module, you
5921 may wish to assemble several \c{.OBJ} files and link them together
5922 into a \c{.COM} program. You can do this, provided you have a linker
5923 capable of outputting \c{.COM} files directly (\i{TLINK} does this),
5924 or alternatively a converter program such as \i\c{EXE2BIN} to
5925 transform the \c{.EXE} file output from the linker into a \c{.COM}
5926 file.
5928 If you do this, you need to take care of several things:
5930 \b The first object file containing code should start its code
5931 segment with a line like \c{RESB 100h}. This is to ensure that the
5932 code begins at offset \c{100h} relative to the beginning of the code
5933 segment, so that the linker or converter program does not have to
5934 adjust address references within the file when generating the
5935 \c{.COM} file. Other assemblers use an \i\c{ORG} directive for this
5936 purpose, but \c{ORG} in NASM is a format-specific directive to the
5937 \c{bin} output format, and does not mean the same thing as it does
5938 in MASM-compatible assemblers.
5940 \b You don't need to define a stack segment.
5942 \b All your segments should be in the same group, so that every time
5943 your code or data references a symbol offset, all offsets are
5944 relative to the same segment base. This is because, when a \c{.COM}
5945 file is loaded, all the segment registers contain the same value.
5948 \H{sysfiles} Producing \i\c{.SYS} Files
5950 \i{MS-DOS device drivers} - \c{.SYS} files - are pure binary files,
5951 similar to \c{.COM} files, except that they start at origin zero
5952 rather than \c{100h}. Therefore, if you are writing a device driver
5953 using the \c{bin} format, you do not need the \c{ORG} directive,
5954 since the default origin for \c{bin} is zero. Similarly, if you are
5955 using \c{obj}, you do not need the \c{RESB 100h} at the start of
5956 your code segment.
5958 \c{.SYS} files start with a header structure, containing pointers to
5959 the various routines inside the driver which do the work. This
5960 structure should be defined at the start of the code segment, even
5961 though it is not actually code.
5963 For more information on the format of \c{.SYS} files, and the data
5964 which has to go in the header structure, a list of books is given in
5965 the Frequently Asked Questions list for the newsgroup
5966 \W{news:comp.os.msdos.programmer}\i\c{comp.os.msdos.programmer}.
5969 \H{16c} Interfacing to 16-bit C Programs
5971 This section covers the basics of writing assembly routines that
5972 call, or are called from, C programs. To do this, you would
5973 typically write an assembly module as a \c{.OBJ} file, and link it
5974 with your C modules to produce a \i{mixed-language program}.
5977 \S{16cunder} External Symbol Names
5979 \I{C symbol names}\I{underscore, in C symbols}C compilers have the
5980 convention that the names of all global symbols (functions or data)
5981 they define are formed by prefixing an underscore to the name as it
5982 appears in the C program. So, for example, the function a C
5983 programmer thinks of as \c{printf} appears to an assembly language
5984 programmer as \c{_printf}. This means that in your assembly
5985 programs, you can define symbols without a leading underscore, and
5986 not have to worry about name clashes with C symbols.
5988 If you find the underscores inconvenient, you can define macros to
5989 replace the \c{GLOBAL} and \c{EXTERN} directives as follows:
5991 \c %macro  cglobal 1
5993 \c   global  _%1
5994 \c   %define %1 _%1
5996 \c %endmacro
5998 \c %macro  cextern 1
6000 \c   extern  _%1
6001 \c   %define %1 _%1
6003 \c %endmacro
6005 (These forms of the macros only take one argument at a time; a
6006 \c{%rep} construct could solve this.)
6008 If you then declare an external like this:
6010 \c cextern printf
6012 then the macro will expand it as
6014 \c extern  _printf
6015 \c %define printf _printf
6017 Thereafter, you can reference \c{printf} as if it was a symbol, and
6018 the preprocessor will put the leading underscore on where necessary.
6020 The \c{cglobal} macro works similarly. You must use \c{cglobal}
6021 before defining the symbol in question, but you would have had to do
6022 that anyway if you used \c{GLOBAL}.
6024 Also see \k{opt-pfix}.
6026 \S{16cmodels} \i{Memory Models}
6028 NASM contains no mechanism to support the various C memory models
6029 directly; you have to keep track yourself of which one you are
6030 writing for. This means you have to keep track of the following
6031 things:
6033 \b In models using a single code segment (tiny, small and compact),
6034 functions are near. This means that function pointers, when stored
6035 in data segments or pushed on the stack as function arguments, are
6036 16 bits long and contain only an offset field (the \c{CS} register
6037 never changes its value, and always gives the segment part of the
6038 full function address), and that functions are called using ordinary
6039 near \c{CALL} instructions and return using \c{RETN} (which, in
6040 NASM, is synonymous with \c{RET} anyway). This means both that you
6041 should write your own routines to return with \c{RETN}, and that you
6042 should call external C routines with near \c{CALL} instructions.
6044 \b In models using more than one code segment (medium, large and
6045 huge), functions are far. This means that function pointers are 32
6046 bits long (consisting of a 16-bit offset followed by a 16-bit
6047 segment), and that functions are called using \c{CALL FAR} (or
6048 \c{CALL seg:offset}) and return using \c{RETF}. Again, you should
6049 therefore write your own routines to return with \c{RETF} and use
6050 \c{CALL FAR} to call external routines.
6052 \b In models using a single data segment (tiny, small and medium),
6053 data pointers are 16 bits long, containing only an offset field (the
6054 \c{DS} register doesn't change its value, and always gives the
6055 segment part of the full data item address).
6057 \b In models using more than one data segment (compact, large and
6058 huge), data pointers are 32 bits long, consisting of a 16-bit offset
6059 followed by a 16-bit segment. You should still be careful not to
6060 modify \c{DS} in your routines without restoring it afterwards, but
6061 \c{ES} is free for you to use to access the contents of 32-bit data
6062 pointers you are passed.
6064 \b The huge memory model allows single data items to exceed 64K in
6065 size. In all other memory models, you can access the whole of a data
6066 item just by doing arithmetic on the offset field of the pointer you
6067 are given, whether a segment field is present or not; in huge model,
6068 you have to be more careful of your pointer arithmetic.
6070 \b In most memory models, there is a \e{default} data segment, whose
6071 segment address is kept in \c{DS} throughout the program. This data
6072 segment is typically the same segment as the stack, kept in \c{SS},
6073 so that functions' local variables (which are stored on the stack)
6074 and global data items can both be accessed easily without changing
6075 \c{DS}. Particularly large data items are typically stored in other
6076 segments. However, some memory models (though not the standard
6077 ones, usually) allow the assumption that \c{SS} and \c{DS} hold the
6078 same value to be removed. Be careful about functions' local
6079 variables in this latter case.
6081 In models with a single code segment, the segment is called
6082 \i\c{_TEXT}, so your code segment must also go by this name in order
6083 to be linked into the same place as the main code segment. In models
6084 with a single data segment, or with a default data segment, it is
6085 called \i\c{_DATA}.
6088 \S{16cfunc} Function Definitions and Function Calls
6090 \I{functions, C calling convention}The \i{C calling convention} in
6091 16-bit programs is as follows. In the following description, the
6092 words \e{caller} and \e{callee} are used to denote the function
6093 doing the calling and the function which gets called.
6095 \b The caller pushes the function's parameters on the stack, one
6096 after another, in reverse order (right to left, so that the first
6097 argument specified to the function is pushed last).
6099 \b The caller then executes a \c{CALL} instruction to pass control
6100 to the callee. This \c{CALL} is either near or far depending on the
6101 memory model.
6103 \b The callee receives control, and typically (although this is not
6104 actually necessary, in functions which do not need to access their
6105 parameters) starts by saving the value of \c{SP} in \c{BP} so as to
6106 be able to use \c{BP} as a base pointer to find its parameters on
6107 the stack. However, the caller was probably doing this too, so part
6108 of the calling convention states that \c{BP} must be preserved by
6109 any C function. Hence the callee, if it is going to set up \c{BP} as
6110 a \i\e{frame pointer}, must push the previous value first.
6112 \b The callee may then access its parameters relative to \c{BP}.
6113 The word at \c{[BP]} holds the previous value of \c{BP} as it was
6114 pushed; the next word, at \c{[BP+2]}, holds the offset part of the
6115 return address, pushed implicitly by \c{CALL}. In a small-model
6116 (near) function, the parameters start after that, at \c{[BP+4]}; in
6117 a large-model (far) function, the segment part of the return address
6118 lives at \c{[BP+4]}, and the parameters begin at \c{[BP+6]}. The
6119 leftmost parameter of the function, since it was pushed last, is
6120 accessible at this offset from \c{BP}; the others follow, at
6121 successively greater offsets. Thus, in a function such as \c{printf}
6122 which takes a variable number of parameters, the pushing of the
6123 parameters in reverse order means that the function knows where to
6124 find its first parameter, which tells it the number and type of the
6125 remaining ones.
6127 \b The callee may also wish to decrease \c{SP} further, so as to
6128 allocate space on the stack for local variables, which will then be
6129 accessible at negative offsets from \c{BP}.
6131 \b The callee, if it wishes to return a value to the caller, should
6132 leave the value in \c{AL}, \c{AX} or \c{DX:AX} depending on the size
6133 of the value. Floating-point results are sometimes (depending on the
6134 compiler) returned in \c{ST0}.
6136 \b Once the callee has finished processing, it restores \c{SP} from
6137 \c{BP} if it had allocated local stack space, then pops the previous
6138 value of \c{BP}, and returns via \c{RETN} or \c{RETF} depending on
6139 memory model.
6141 \b When the caller regains control from the callee, the function
6142 parameters are still on the stack, so it typically adds an immediate
6143 constant to \c{SP} to remove them (instead of executing a number of
6144 slow \c{POP} instructions). Thus, if a function is accidentally
6145 called with the wrong number of parameters due to a prototype
6146 mismatch, the stack will still be returned to a sensible state since
6147 the caller, which \e{knows} how many parameters it pushed, does the
6148 removing.
6150 It is instructive to compare this calling convention with that for
6151 Pascal programs (described in \k{16bpfunc}). Pascal has a simpler
6152 convention, since no functions have variable numbers of parameters.
6153 Therefore the callee knows how many parameters it should have been
6154 passed, and is able to deallocate them from the stack itself by
6155 passing an immediate argument to the \c{RET} or \c{RETF}
6156 instruction, so the caller does not have to do it. Also, the
6157 parameters are pushed in left-to-right order, not right-to-left,
6158 which means that a compiler can give better guarantees about
6159 sequence points without performance suffering.
6161 Thus, you would define a function in C style in the following way.
6162 The following example is for small model:
6164 \c global  _myfunc
6166 \c _myfunc:
6167 \c         push    bp
6168 \c         mov     bp,sp
6169 \c         sub     sp,0x40         ; 64 bytes of local stack space
6170 \c         mov     bx,[bp+4]       ; first parameter to function
6172 \c         ; some more code
6174 \c         mov     sp,bp           ; undo "sub sp,0x40" above
6175 \c         pop     bp
6176 \c         ret
6178 For a large-model function, you would replace \c{RET} by \c{RETF},
6179 and look for the first parameter at \c{[BP+6]} instead of
6180 \c{[BP+4]}. Of course, if one of the parameters is a pointer, then
6181 the offsets of \e{subsequent} parameters will change depending on
6182 the memory model as well: far pointers take up four bytes on the
6183 stack when passed as a parameter, whereas near pointers take up two.
6185 At the other end of the process, to call a C function from your
6186 assembly code, you would do something like this:
6188 \c extern  _printf
6190 \c       ; and then, further down...
6192 \c       push    word [myint]        ; one of my integer variables
6193 \c       push    word mystring       ; pointer into my data segment
6194 \c       call    _printf
6195 \c       add     sp,byte 4           ; `byte' saves space
6197 \c       ; then those data items...
6199 \c segment _DATA
6201 \c myint         dw    1234
6202 \c mystring      db    'This number -> %d <- should be 1234',10,0
6204 This piece of code is the small-model assembly equivalent of the C
6205 code
6207 \c     int myint = 1234;
6208 \c     printf("This number -> %d <- should be 1234\n", myint);
6210 In large model, the function-call code might look more like this. In
6211 this example, it is assumed that \c{DS} already holds the segment
6212 base of the segment \c{_DATA}. If not, you would have to initialize
6213 it first.
6215 \c       push    word [myint]
6216 \c       push    word seg mystring   ; Now push the segment, and...
6217 \c       push    word mystring       ; ... offset of "mystring"
6218 \c       call    far _printf
6219 \c       add    sp,byte 6
6221 The integer value still takes up one word on the stack, since large
6222 model does not affect the size of the \c{int} data type. The first
6223 argument (pushed last) to \c{printf}, however, is a data pointer,
6224 and therefore has to contain a segment and offset part. The segment
6225 should be stored second in memory, and therefore must be pushed
6226 first. (Of course, \c{PUSH DS} would have been a shorter instruction
6227 than \c{PUSH WORD SEG mystring}, if \c{DS} was set up as the above
6228 example assumed.) Then the actual call becomes a far call, since
6229 functions expect far calls in large model; and \c{SP} has to be
6230 increased by 6 rather than 4 afterwards to make up for the extra
6231 word of parameters.
6234 \S{16cdata} Accessing Data Items
6236 To get at the contents of C variables, or to declare variables which
6237 C can access, you need only declare the names as \c{GLOBAL} or
6238 \c{EXTERN}. (Again, the names require leading underscores, as stated
6239 in \k{16cunder}.) Thus, a C variable declared as \c{int i} can be
6240 accessed from assembler as
6242 \c extern _i
6244 \c         mov ax,[_i]
6246 And to declare your own integer variable which C programs can access
6247 as \c{extern int j}, you do this (making sure you are assembling in
6248 the \c{_DATA} segment, if necessary):
6250 \c global  _j
6252 \c _j      dw      0
6254 To access a C array, you need to know the size of the components of
6255 the array. For example, \c{int} variables are two bytes long, so if
6256 a C program declares an array as \c{int a[10]}, you can access
6257 \c{a[3]} by coding \c{mov ax,[_a+6]}. (The byte offset 6 is obtained
6258 by multiplying the desired array index, 3, by the size of the array
6259 element, 2.) The sizes of the C base types in 16-bit compilers are:
6260 1 for \c{char}, 2 for \c{short} and \c{int}, 4 for \c{long} and
6261 \c{float}, and 8 for \c{double}.
6263 To access a C \i{data structure}, you need to know the offset from
6264 the base of the structure to the field you are interested in. You
6265 can either do this by converting the C structure definition into a
6266 NASM structure definition (using \i\c{STRUC}), or by calculating the
6267 one offset and using just that.
6269 To do either of these, you should read your C compiler's manual to
6270 find out how it organizes data structures. NASM gives no special
6271 alignment to structure members in its own \c{STRUC} macro, so you
6272 have to specify alignment yourself if the C compiler generates it.
6273 Typically, you might find that a structure like
6275 \c struct {
6276 \c     char c;
6277 \c     int i;
6278 \c } foo;
6280 might be four bytes long rather than three, since the \c{int} field
6281 would be aligned to a two-byte boundary. However, this sort of
6282 feature tends to be a configurable option in the C compiler, either
6283 using command-line options or \c{#pragma} lines, so you have to find
6284 out how your own compiler does it.
6287 \S{16cmacro} \i\c{c16.mac}: Helper Macros for the 16-bit C Interface
6289 Included in the NASM archives, in the \I{misc subdirectory}\c{misc}
6290 directory, is a file \c{c16.mac} of macros. It defines three macros:
6291 \i\c{proc}, \i\c{arg} and \i\c{endproc}. These are intended to be
6292 used for C-style procedure definitions, and they automate a lot of
6293 the work involved in keeping track of the calling convention.
6295 (An alternative, TASM compatible form of \c{arg} is also now built
6296 into NASM's preprocessor. See \k{stackrel} for details.)
6298 An example of an assembly function using the macro set is given
6299 here:
6301 \c proc    _nearproc
6303 \c %$i     arg
6304 \c %$j     arg
6305 \c         mov     ax,[bp + %$i]
6306 \c         mov     bx,[bp + %$j]
6307 \c         add     ax,[bx]
6309 \c endproc
6311 This defines \c{_nearproc} to be a procedure taking two arguments,
6312 the first (\c{i}) an integer and the second (\c{j}) a pointer to an
6313 integer. It returns \c{i + *j}.
6315 Note that the \c{arg} macro has an \c{EQU} as the first line of its
6316 expansion, and since the label before the macro call gets prepended
6317 to the first line of the expanded macro, the \c{EQU} works, defining
6318 \c{%$i} to be an offset from \c{BP}. A context-local variable is
6319 used, local to the context pushed by the \c{proc} macro and popped
6320 by the \c{endproc} macro, so that the same argument name can be used
6321 in later procedures. Of course, you don't \e{have} to do that.
6323 The macro set produces code for near functions (tiny, small and
6324 compact-model code) by default. You can have it generate far
6325 functions (medium, large and huge-model code) by means of coding
6326 \I\c{FARCODE}\c{%define FARCODE}. This changes the kind of return
6327 instruction generated by \c{endproc}, and also changes the starting
6328 point for the argument offsets. The macro set contains no intrinsic
6329 dependency on whether data pointers are far or not.
6331 \c{arg} can take an optional parameter, giving the size of the
6332 argument. If no size is given, 2 is assumed, since it is likely that
6333 many function parameters will be of type \c{int}.
6335 The large-model equivalent of the above function would look like this:
6337 \c %define FARCODE
6339 \c proc    _farproc
6341 \c %$i     arg
6342 \c %$j     arg     4
6343 \c         mov     ax,[bp + %$i]
6344 \c         mov     bx,[bp + %$j]
6345 \c         mov     es,[bp + %$j + 2]
6346 \c         add     ax,[bx]
6348 \c endproc
6350 This makes use of the argument to the \c{arg} macro to define a
6351 parameter of size 4, because \c{j} is now a far pointer. When we
6352 load from \c{j}, we must load a segment and an offset.
6355 \H{16bp} Interfacing to \i{Borland Pascal} Programs
6357 Interfacing to Borland Pascal programs is similar in concept to
6358 interfacing to 16-bit C programs. The differences are:
6360 \b The leading underscore required for interfacing to C programs is
6361 not required for Pascal.
6363 \b The memory model is always large: functions are far, data
6364 pointers are far, and no data item can be more than 64K long.
6365 (Actually, some functions are near, but only those functions that
6366 are local to a Pascal unit and never called from outside it. All
6367 assembly functions that Pascal calls, and all Pascal functions that
6368 assembly routines are able to call, are far.) However, all static
6369 data declared in a Pascal program goes into the default data
6370 segment, which is the one whose segment address will be in \c{DS}
6371 when control is passed to your assembly code. The only things that
6372 do not live in the default data segment are local variables (they
6373 live in the stack segment) and dynamically allocated variables. All
6374 data \e{pointers}, however, are far.
6376 \b The function calling convention is different - described below.
6378 \b Some data types, such as strings, are stored differently.
6380 \b There are restrictions on the segment names you are allowed to
6381 use - Borland Pascal will ignore code or data declared in a segment
6382 it doesn't like the name of. The restrictions are described below.
6385 \S{16bpfunc} The Pascal Calling Convention
6387 \I{functions, Pascal calling convention}\I{Pascal calling
6388 convention}The 16-bit Pascal calling convention is as follows. In
6389 the following description, the words \e{caller} and \e{callee} are
6390 used to denote the function doing the calling and the function which
6391 gets called.
6393 \b The caller pushes the function's parameters on the stack, one
6394 after another, in normal order (left to right, so that the first
6395 argument specified to the function is pushed first).
6397 \b The caller then executes a far \c{CALL} instruction to pass
6398 control to the callee.
6400 \b The callee receives control, and typically (although this is not
6401 actually necessary, in functions which do not need to access their
6402 parameters) starts by saving the value of \c{SP} in \c{BP} so as to
6403 be able to use \c{BP} as a base pointer to find its parameters on
6404 the stack. However, the caller was probably doing this too, so part
6405 of the calling convention states that \c{BP} must be preserved by
6406 any function. Hence the callee, if it is going to set up \c{BP} as a
6407 \i{frame pointer}, must push the previous value first.
6409 \b The callee may then access its parameters relative to \c{BP}.
6410 The word at \c{[BP]} holds the previous value of \c{BP} as it was
6411 pushed. The next word, at \c{[BP+2]}, holds the offset part of the
6412 return address, and the next one at \c{[BP+4]} the segment part. The
6413 parameters begin at \c{[BP+6]}. The rightmost parameter of the
6414 function, since it was pushed last, is accessible at this offset
6415 from \c{BP}; the others follow, at successively greater offsets.
6417 \b The callee may also wish to decrease \c{SP} further, so as to
6418 allocate space on the stack for local variables, which will then be
6419 accessible at negative offsets from \c{BP}.
6421 \b The callee, if it wishes to return a value to the caller, should
6422 leave the value in \c{AL}, \c{AX} or \c{DX:AX} depending on the size
6423 of the value. Floating-point results are returned in \c{ST0}.
6424 Results of type \c{Real} (Borland's own custom floating-point data
6425 type, not handled directly by the FPU) are returned in \c{DX:BX:AX}.
6426 To return a result of type \c{String}, the caller pushes a pointer
6427 to a temporary string before pushing the parameters, and the callee
6428 places the returned string value at that location. The pointer is
6429 not a parameter, and should not be removed from the stack by the
6430 \c{RETF} instruction.
6432 \b Once the callee has finished processing, it restores \c{SP} from
6433 \c{BP} if it had allocated local stack space, then pops the previous
6434 value of \c{BP}, and returns via \c{RETF}. It uses the form of
6435 \c{RETF} with an immediate parameter, giving the number of bytes
6436 taken up by the parameters on the stack. This causes the parameters
6437 to be removed from the stack as a side effect of the return
6438 instruction.
6440 \b When the caller regains control from the callee, the function
6441 parameters have already been removed from the stack, so it needs to
6442 do nothing further.
6444 Thus, you would define a function in Pascal style, taking two
6445 \c{Integer}-type parameters, in the following way:
6447 \c global  myfunc
6449 \c myfunc: push    bp
6450 \c         mov     bp,sp
6451 \c         sub     sp,0x40         ; 64 bytes of local stack space
6452 \c         mov     bx,[bp+8]       ; first parameter to function
6453 \c         mov     bx,[bp+6]       ; second parameter to function
6455 \c         ; some more code
6457 \c         mov     sp,bp           ; undo "sub sp,0x40" above
6458 \c         pop     bp
6459 \c         retf    4               ; total size of params is 4
6461 At the other end of the process, to call a Pascal function from your
6462 assembly code, you would do something like this:
6464 \c extern  SomeFunc
6466 \c        ; and then, further down...
6468 \c        push   word seg mystring   ; Now push the segment, and...
6469 \c        push   word mystring       ; ... offset of "mystring"
6470 \c        push   word [myint]        ; one of my variables
6471 \c        call   far SomeFunc
6473 This is equivalent to the Pascal code
6475 \c procedure SomeFunc(String: PChar; Int: Integer);
6476 \c     SomeFunc(@mystring, myint);
6479 \S{16bpseg} Borland Pascal \I{segment names, Borland Pascal}Segment
6480 Name Restrictions
6482 Since Borland Pascal's internal unit file format is completely
6483 different from \c{OBJ}, it only makes a very sketchy job of actually
6484 reading and understanding the various information contained in a
6485 real \c{OBJ} file when it links that in. Therefore an object file
6486 intended to be linked to a Pascal program must obey a number of
6487 restrictions:
6489 \b Procedures and functions must be in a segment whose name is
6490 either \c{CODE}, \c{CSEG}, or something ending in \c{_TEXT}.
6492 \b initialized data must be in a segment whose name is either
6493 \c{CONST} or something ending in \c{_DATA}.
6495 \b Uninitialized data must be in a segment whose name is either
6496 \c{DATA}, \c{DSEG}, or something ending in \c{_BSS}.
6498 \b Any other segments in the object file are completely ignored.
6499 \c{GROUP} directives and segment attributes are also ignored.
6502 \S{16bpmacro} Using \i\c{c16.mac} With Pascal Programs
6504 The \c{c16.mac} macro package, described in \k{16cmacro}, can also
6505 be used to simplify writing functions to be called from Pascal
6506 programs, if you code \I\c{PASCAL}\c{%define PASCAL}. This
6507 definition ensures that functions are far (it implies
6508 \i\c{FARCODE}), and also causes procedure return instructions to be
6509 generated with an operand.
6511 Defining \c{PASCAL} does not change the code which calculates the
6512 argument offsets; you must declare your function's arguments in
6513 reverse order. For example:
6515 \c %define PASCAL
6517 \c proc    _pascalproc
6519 \c %$j     arg 4
6520 \c %$i     arg
6521 \c         mov     ax,[bp + %$i]
6522 \c         mov     bx,[bp + %$j]
6523 \c         mov     es,[bp + %$j + 2]
6524 \c         add     ax,[bx]
6526 \c endproc
6528 This defines the same routine, conceptually, as the example in
6529 \k{16cmacro}: it defines a function taking two arguments, an integer
6530 and a pointer to an integer, which returns the sum of the integer
6531 and the contents of the pointer. The only difference between this
6532 code and the large-model C version is that \c{PASCAL} is defined
6533 instead of \c{FARCODE}, and that the arguments are declared in
6534 reverse order.
6537 \C{32bit} Writing 32-bit Code (Unix, Win32, DJGPP)
6539 This chapter attempts to cover some of the common issues involved
6540 when writing 32-bit code, to run under \i{Win32} or Unix, or to be
6541 linked with C code generated by a Unix-style C compiler such as
6542 \i{DJGPP}. It covers how to write assembly code to interface with
6543 32-bit C routines, and how to write position-independent code for
6544 shared libraries.
6546 Almost all 32-bit code, and in particular all code running under
6547 \c{Win32}, \c{DJGPP} or any of the PC Unix variants, runs in \I{flat
6548 memory model}\e{flat} memory model. This means that the segment registers
6549 and paging have already been set up to give you the same 32-bit 4Gb
6550 address space no matter what segment you work relative to, and that
6551 you should ignore all segment registers completely. When writing
6552 flat-model application code, you never need to use a segment
6553 override or modify any segment register, and the code-section
6554 addresses you pass to \c{CALL} and \c{JMP} live in the same address
6555 space as the data-section addresses you access your variables by and
6556 the stack-section addresses you access local variables and procedure
6557 parameters by. Every address is 32 bits long and contains only an
6558 offset part.
6561 \H{32c} Interfacing to 32-bit C Programs
6563 A lot of the discussion in \k{16c}, about interfacing to 16-bit C
6564 programs, still applies when working in 32 bits. The absence of
6565 memory models or segmentation worries simplifies things a lot.
6568 \S{32cunder} External Symbol Names
6570 Most 32-bit C compilers share the convention used by 16-bit
6571 compilers, that the names of all global symbols (functions or data)
6572 they define are formed by prefixing an underscore to the name as it
6573 appears in the C program. However, not all of them do: the \c{ELF}
6574 specification states that C symbols do \e{not} have a leading
6575 underscore on their assembly-language names.
6577 The older Linux \c{a.out} C compiler, all \c{Win32} compilers,
6578 \c{DJGPP}, and \c{NetBSD} and \c{FreeBSD}, all use the leading
6579 underscore; for these compilers, the macros \c{cextern} and
6580 \c{cglobal}, as given in \k{16cunder}, will still work. For \c{ELF},
6581 though, the leading underscore should not be used.
6583 See also \k{opt-pfix}.
6585 \S{32cfunc} Function Definitions and Function Calls
6587 \I{functions, C calling convention}The \i{C calling convention}
6588 in 32-bit programs is as follows. In the following description,
6589 the words \e{caller} and \e{callee} are used to denote
6590 the function doing the calling and the function which gets called.
6592 \b The caller pushes the function's parameters on the stack, one
6593 after another, in reverse order (right to left, so that the first
6594 argument specified to the function is pushed last).
6596 \b The caller then executes a near \c{CALL} instruction to pass
6597 control to the callee.
6599 \b The callee receives control, and typically (although this is not
6600 actually necessary, in functions which do not need to access their
6601 parameters) starts by saving the value of \c{ESP} in \c{EBP} so as
6602 to be able to use \c{EBP} as a base pointer to find its parameters
6603 on the stack. However, the caller was probably doing this too, so
6604 part of the calling convention states that \c{EBP} must be preserved
6605 by any C function. Hence the callee, if it is going to set up
6606 \c{EBP} as a \i{frame pointer}, must push the previous value first.
6608 \b The callee may then access its parameters relative to \c{EBP}.
6609 The doubleword at \c{[EBP]} holds the previous value of \c{EBP} as
6610 it was pushed; the next doubleword, at \c{[EBP+4]}, holds the return
6611 address, pushed implicitly by \c{CALL}. The parameters start after
6612 that, at \c{[EBP+8]}. The leftmost parameter of the function, since
6613 it was pushed last, is accessible at this offset from \c{EBP}; the
6614 others follow, at successively greater offsets. Thus, in a function
6615 such as \c{printf} which takes a variable number of parameters, the
6616 pushing of the parameters in reverse order means that the function
6617 knows where to find its first parameter, which tells it the number
6618 and type of the remaining ones.
6620 \b The callee may also wish to decrease \c{ESP} further, so as to
6621 allocate space on the stack for local variables, which will then be
6622 accessible at negative offsets from \c{EBP}.
6624 \b The callee, if it wishes to return a value to the caller, should
6625 leave the value in \c{AL}, \c{AX} or \c{EAX} depending on the size
6626 of the value. Floating-point results are typically returned in
6627 \c{ST0}.
6629 \b Once the callee has finished processing, it restores \c{ESP} from
6630 \c{EBP} if it had allocated local stack space, then pops the previous
6631 value of \c{EBP}, and returns via \c{RET} (equivalently, \c{RETN}).
6633 \b When the caller regains control from the callee, the function
6634 parameters are still on the stack, so it typically adds an immediate
6635 constant to \c{ESP} to remove them (instead of executing a number of
6636 slow \c{POP} instructions). Thus, if a function is accidentally
6637 called with the wrong number of parameters due to a prototype
6638 mismatch, the stack will still be returned to a sensible state since
6639 the caller, which \e{knows} how many parameters it pushed, does the
6640 removing.
6642 There is an alternative calling convention used by Win32 programs
6643 for Windows API calls, and also for functions called \e{by} the
6644 Windows API such as window procedures: they follow what Microsoft
6645 calls the \c{__stdcall} convention. This is slightly closer to the
6646 Pascal convention, in that the callee clears the stack by passing a
6647 parameter to the \c{RET} instruction. However, the parameters are
6648 still pushed in right-to-left order.
6650 Thus, you would define a function in C style in the following way:
6652 \c global  _myfunc
6654 \c _myfunc:
6655 \c         push    ebp
6656 \c         mov     ebp,esp
6657 \c         sub     esp,0x40        ; 64 bytes of local stack space
6658 \c         mov     ebx,[ebp+8]     ; first parameter to function
6660 \c         ; some more code
6662 \c         leave                   ; mov esp,ebp / pop ebp
6663 \c         ret
6665 At the other end of the process, to call a C function from your
6666 assembly code, you would do something like this:
6668 \c extern  _printf
6670 \c         ; and then, further down...
6672 \c         push    dword [myint]   ; one of my integer variables
6673 \c         push    dword mystring  ; pointer into my data segment
6674 \c         call    _printf
6675 \c         add     esp,byte 8      ; `byte' saves space
6677 \c         ; then those data items...
6679 \c segment _DATA
6681 \c myint       dd   1234
6682 \c mystring    db   'This number -> %d <- should be 1234',10,0
6684 This piece of code is the assembly equivalent of the C code
6686 \c     int myint = 1234;
6687 \c     printf("This number -> %d <- should be 1234\n", myint);
6690 \S{32cdata} Accessing Data Items
6692 To get at the contents of C variables, or to declare variables which
6693 C can access, you need only declare the names as \c{GLOBAL} or
6694 \c{EXTERN}. (Again, the names require leading underscores, as stated
6695 in \k{32cunder}.) Thus, a C variable declared as \c{int i} can be
6696 accessed from assembler as
6698 \c           extern _i
6699 \c           mov eax,[_i]
6701 And to declare your own integer variable which C programs can access
6702 as \c{extern int j}, you do this (making sure you are assembling in
6703 the \c{_DATA} segment, if necessary):
6705 \c           global _j
6706 \c _j        dd 0
6708 To access a C array, you need to know the size of the components of
6709 the array. For example, \c{int} variables are four bytes long, so if
6710 a C program declares an array as \c{int a[10]}, you can access
6711 \c{a[3]} by coding \c{mov ax,[_a+12]}. (The byte offset 12 is obtained
6712 by multiplying the desired array index, 3, by the size of the array
6713 element, 4.) The sizes of the C base types in 32-bit compilers are:
6714 1 for \c{char}, 2 for \c{short}, 4 for \c{int}, \c{long} and
6715 \c{float}, and 8 for \c{double}. Pointers, being 32-bit addresses,
6716 are also 4 bytes long.
6718 To access a C \i{data structure}, you need to know the offset from
6719 the base of the structure to the field you are interested in. You
6720 can either do this by converting the C structure definition into a
6721 NASM structure definition (using \c{STRUC}), or by calculating the
6722 one offset and using just that.
6724 To do either of these, you should read your C compiler's manual to
6725 find out how it organizes data structures. NASM gives no special
6726 alignment to structure members in its own \i\c{STRUC} macro, so you
6727 have to specify alignment yourself if the C compiler generates it.
6728 Typically, you might find that a structure like
6730 \c struct {
6731 \c     char c;
6732 \c     int i;
6733 \c } foo;
6735 might be eight bytes long rather than five, since the \c{int} field
6736 would be aligned to a four-byte boundary. However, this sort of
6737 feature is sometimes a configurable option in the C compiler, either
6738 using command-line options or \c{#pragma} lines, so you have to find
6739 out how your own compiler does it.
6742 \S{32cmacro} \i\c{c32.mac}: Helper Macros for the 32-bit C Interface
6744 Included in the NASM archives, in the \I{misc directory}\c{misc}
6745 directory, is a file \c{c32.mac} of macros. It defines three macros:
6746 \i\c{proc}, \i\c{arg} and \i\c{endproc}. These are intended to be
6747 used for C-style procedure definitions, and they automate a lot of
6748 the work involved in keeping track of the calling convention.
6750 An example of an assembly function using the macro set is given
6751 here:
6753 \c proc    _proc32
6755 \c %$i     arg
6756 \c %$j     arg
6757 \c         mov     eax,[ebp + %$i]
6758 \c         mov     ebx,[ebp + %$j]
6759 \c         add     eax,[ebx]
6761 \c endproc
6763 This defines \c{_proc32} to be a procedure taking two arguments, the
6764 first (\c{i}) an integer and the second (\c{j}) a pointer to an
6765 integer. It returns \c{i + *j}.
6767 Note that the \c{arg} macro has an \c{EQU} as the first line of its
6768 expansion, and since the label before the macro call gets prepended
6769 to the first line of the expanded macro, the \c{EQU} works, defining
6770 \c{%$i} to be an offset from \c{BP}. A context-local variable is
6771 used, local to the context pushed by the \c{proc} macro and popped
6772 by the \c{endproc} macro, so that the same argument name can be used
6773 in later procedures. Of course, you don't \e{have} to do that.
6775 \c{arg} can take an optional parameter, giving the size of the
6776 argument. If no size is given, 4 is assumed, since it is likely that
6777 many function parameters will be of type \c{int} or pointers.
6780 \H{picdll} Writing NetBSD/FreeBSD/OpenBSD and Linux/ELF \i{Shared
6781 Libraries}
6783 \c{ELF} replaced the older \c{a.out} object file format under Linux
6784 because it contains support for \i{position-independent code}
6785 (\i{PIC}), which makes writing shared libraries much easier. NASM
6786 supports the \c{ELF} position-independent code features, so you can
6787 write Linux \c{ELF} shared libraries in NASM.
6789 \i{NetBSD}, and its close cousins \i{FreeBSD} and \i{OpenBSD}, take
6790 a different approach by hacking PIC support into the \c{a.out}
6791 format. NASM supports this as the \i\c{aoutb} output format, so you
6792 can write \i{BSD} shared libraries in NASM too.
6794 The operating system loads a PIC shared library by memory-mapping
6795 the library file at an arbitrarily chosen point in the address space
6796 of the running process. The contents of the library's code section
6797 must therefore not depend on where it is loaded in memory.
6799 Therefore, you cannot get at your variables by writing code like
6800 this:
6802 \c         mov     eax,[myvar]             ; WRONG
6804 Instead, the linker provides an area of memory called the
6805 \i\e{global offset table}, or \i{GOT}; the GOT is situated at a
6806 constant distance from your library's code, so if you can find out
6807 where your library is loaded (which is typically done using a
6808 \c{CALL} and \c{POP} combination), you can obtain the address of the
6809 GOT, and you can then load the addresses of your variables out of
6810 linker-generated entries in the GOT.
6812 The \e{data} section of a PIC shared library does not have these
6813 restrictions: since the data section is writable, it has to be
6814 copied into memory anyway rather than just paged in from the library
6815 file, so as long as it's being copied it can be relocated too. So
6816 you can put ordinary types of relocation in the data section without
6817 too much worry (but see \k{picglobal} for a caveat).
6820 \S{picgot} Obtaining the Address of the GOT
6822 Each code module in your shared library should define the GOT as an
6823 external symbol:
6825 \c extern  _GLOBAL_OFFSET_TABLE_   ; in ELF
6826 \c extern  __GLOBAL_OFFSET_TABLE_  ; in BSD a.out
6828 At the beginning of any function in your shared library which plans
6829 to access your data or BSS sections, you must first calculate the
6830 address of the GOT. This is typically done by writing the function
6831 in this form:
6833 \c func:   push    ebp
6834 \c         mov     ebp,esp
6835 \c         push    ebx
6836 \c         call    .get_GOT
6837 \c .get_GOT:
6838 \c         pop     ebx
6839 \c         add     ebx,_GLOBAL_OFFSET_TABLE_+$$-.get_GOT wrt ..gotpc
6841 \c         ; the function body comes here
6843 \c         mov     ebx,[ebp-4]
6844 \c         mov     esp,ebp
6845 \c         pop     ebp
6846 \c         ret
6848 (For BSD, again, the symbol \c{_GLOBAL_OFFSET_TABLE} requires a
6849 second leading underscore.)
6851 The first two lines of this function are simply the standard C
6852 prologue to set up a stack frame, and the last three lines are
6853 standard C function epilogue. The third line, and the fourth to last
6854 line, save and restore the \c{EBX} register, because PIC shared
6855 libraries use this register to store the address of the GOT.
6857 The interesting bit is the \c{CALL} instruction and the following
6858 two lines. The \c{CALL} and \c{POP} combination obtains the address
6859 of the label \c{.get_GOT}, without having to know in advance where
6860 the program was loaded (since the \c{CALL} instruction is encoded
6861 relative to the current position). The \c{ADD} instruction makes use
6862 of one of the special PIC relocation types: \i{GOTPC relocation}.
6863 With the \i\c{WRT ..gotpc} qualifier specified, the symbol
6864 referenced (here \c{_GLOBAL_OFFSET_TABLE_}, the special symbol
6865 assigned to the GOT) is given as an offset from the beginning of the
6866 section. (Actually, \c{ELF} encodes it as the offset from the operand
6867 field of the \c{ADD} instruction, but NASM simplifies this
6868 deliberately, so you do things the same way for both \c{ELF} and
6869 \c{BSD}.) So the instruction then \e{adds} the beginning of the section,
6870 to get the real address of the GOT, and subtracts the value of
6871 \c{.get_GOT} which it knows is in \c{EBX}. Therefore, by the time
6872 that instruction has finished, \c{EBX} contains the address of the GOT.
6874 If you didn't follow that, don't worry: it's never necessary to
6875 obtain the address of the GOT by any other means, so you can put
6876 those three instructions into a macro and safely ignore them:
6878 \c %macro  get_GOT 0
6880 \c         call    %%getgot
6881 \c   %%getgot:
6882 \c         pop     ebx
6883 \c         add     ebx,_GLOBAL_OFFSET_TABLE_+$$-%%getgot wrt ..gotpc
6885 \c %endmacro
6887 \S{piclocal} Finding Your Local Data Items
6889 Having got the GOT, you can then use it to obtain the addresses of
6890 your data items. Most variables will reside in the sections you have
6891 declared; they can be accessed using the \I{GOTOFF
6892 relocation}\c{..gotoff} special \I\c{WRT ..gotoff}\c{WRT} type. The
6893 way this works is like this:
6895 \c         lea     eax,[ebx+myvar wrt ..gotoff]
6897 The expression \c{myvar wrt ..gotoff} is calculated, when the shared
6898 library is linked, to be the offset to the local variable \c{myvar}
6899 from the beginning of the GOT. Therefore, adding it to \c{EBX} as
6900 above will place the real address of \c{myvar} in \c{EAX}.
6902 If you declare variables as \c{GLOBAL} without specifying a size for
6903 them, they are shared between code modules in the library, but do
6904 not get exported from the library to the program that loaded it.
6905 They will still be in your ordinary data and BSS sections, so you
6906 can access them in the same way as local variables, using the above
6907 \c{..gotoff} mechanism.
6909 Note that due to a peculiarity of the way BSD \c{a.out} format
6910 handles this relocation type, there must be at least one non-local
6911 symbol in the same section as the address you're trying to access.
6914 \S{picextern} Finding External and Common Data Items
6916 If your library needs to get at an external variable (external to
6917 the \e{library}, not just to one of the modules within it), you must
6918 use the \I{GOT relocations}\I\c{WRT ..got}\c{..got} type to get at
6919 it. The \c{..got} type, instead of giving you the offset from the
6920 GOT base to the variable, gives you the offset from the GOT base to
6921 a GOT \e{entry} containing the address of the variable. The linker
6922 will set up this GOT entry when it builds the library, and the
6923 dynamic linker will place the correct address in it at load time. So
6924 to obtain the address of an external variable \c{extvar} in \c{EAX},
6925 you would code
6927 \c         mov     eax,[ebx+extvar wrt ..got]
6929 This loads the address of \c{extvar} out of an entry in the GOT. The
6930 linker, when it builds the shared library, collects together every
6931 relocation of type \c{..got}, and builds the GOT so as to ensure it
6932 has every necessary entry present.
6934 Common variables must also be accessed in this way.
6937 \S{picglobal} Exporting Symbols to the Library User
6939 If you want to export symbols to the user of the library, you have
6940 to declare whether they are functions or data, and if they are data,
6941 you have to give the size of the data item. This is because the
6942 dynamic linker has to build \I{PLT}\i{procedure linkage table}
6943 entries for any exported functions, and also moves exported data
6944 items away from the library's data section in which they were
6945 declared.
6947 So to export a function to users of the library, you must use
6949 \c global  func:function           ; declare it as a function
6951 \c func:   push    ebp
6953 \c         ; etc.
6955 And to export a data item such as an array, you would have to code
6957 \c global  array:data array.end-array      ; give the size too
6959 \c array:  resd    128
6960 \c .end:
6962 Be careful: If you export a variable to the library user, by
6963 declaring it as \c{GLOBAL} and supplying a size, the variable will
6964 end up living in the data section of the main program, rather than
6965 in your library's data section, where you declared it. So you will
6966 have to access your own global variable with the \c{..got} mechanism
6967 rather than \c{..gotoff}, as if it were external (which,
6968 effectively, it has become).
6970 Equally, if you need to store the address of an exported global in
6971 one of your data sections, you can't do it by means of the standard
6972 sort of code:
6974 \c dataptr:        dd      global_data_item        ; WRONG
6976 NASM will interpret this code as an ordinary relocation, in which
6977 \c{global_data_item} is merely an offset from the beginning of the
6978 \c{.data} section (or whatever); so this reference will end up
6979 pointing at your data section instead of at the exported global
6980 which resides elsewhere.
6982 Instead of the above code, then, you must write
6984 \c dataptr:        dd      global_data_item wrt ..sym
6986 which makes use of the special \c{WRT} type \I\c{WRT ..sym}\c{..sym}
6987 to instruct NASM to search the symbol table for a particular symbol
6988 at that address, rather than just relocating by section base.
6990 Either method will work for functions: referring to one of your
6991 functions by means of
6993 \c funcptr:        dd      my_function
6995 will give the user the address of the code you wrote, whereas
6997 \c funcptr:        dd      my_function wrt .sym
6999 will give the address of the procedure linkage table for the
7000 function, which is where the calling program will \e{believe} the
7001 function lives. Either address is a valid way to call the function.
7004 \S{picproc} Calling Procedures Outside the Library
7006 Calling procedures outside your shared library has to be done by
7007 means of a \i\e{procedure linkage table}, or \i{PLT}. The PLT is
7008 placed at a known offset from where the library is loaded, so the
7009 library code can make calls to the PLT in a position-independent
7010 way. Within the PLT there is code to jump to offsets contained in
7011 the GOT, so function calls to other shared libraries or to routines
7012 in the main program can be transparently passed off to their real
7013 destinations.
7015 To call an external routine, you must use another special PIC
7016 relocation type, \I{PLT relocations}\i\c{WRT ..plt}. This is much
7017 easier than the GOT-based ones: you simply replace calls such as
7018 \c{CALL printf} with the PLT-relative version \c{CALL printf WRT
7019 ..plt}.
7022 \S{link} Generating the Library File
7024 Having written some code modules and assembled them to \c{.o} files,
7025 you then generate your shared library with a command such as
7027 \c ld -shared -o library.so module1.o module2.o       # for ELF
7028 \c ld -Bshareable -o library.so module1.o module2.o   # for BSD
7030 For ELF, if your shared library is going to reside in system
7031 directories such as \c{/usr/lib} or \c{/lib}, it is usually worth
7032 using the \i\c{-soname} flag to the linker, to store the final
7033 library file name, with a version number, into the library:
7035 \c ld -shared -soname library.so.1 -o library.so.1.2 *.o
7037 You would then copy \c{library.so.1.2} into the library directory,
7038 and create \c{library.so.1} as a symbolic link to it.
7041 \C{mixsize} Mixing 16 and 32 Bit Code
7043 This chapter tries to cover some of the issues, largely related to
7044 unusual forms of addressing and jump instructions, encountered when
7045 writing operating system code such as protected-mode initialisation
7046 routines, which require code that operates in mixed segment sizes,
7047 such as code in a 16-bit segment trying to modify data in a 32-bit
7048 one, or jumps between different-size segments.
7051 \H{mixjump} Mixed-Size Jumps\I{jumps, mixed-size}
7053 \I{operating system, writing}\I{writing operating systems}The most
7054 common form of \i{mixed-size instruction} is the one used when
7055 writing a 32-bit OS: having done your setup in 16-bit mode, such as
7056 loading the kernel, you then have to boot it by switching into
7057 protected mode and jumping to the 32-bit kernel start address. In a
7058 fully 32-bit OS, this tends to be the \e{only} mixed-size
7059 instruction you need, since everything before it can be done in pure
7060 16-bit code, and everything after it can be pure 32-bit.
7062 This jump must specify a 48-bit far address, since the target
7063 segment is a 32-bit one. However, it must be assembled in a 16-bit
7064 segment, so just coding, for example,
7066 \c         jmp     0x1234:0x56789ABC       ; wrong!
7068 will not work, since the offset part of the address will be
7069 truncated to \c{0x9ABC} and the jump will be an ordinary 16-bit far
7070 one.
7072 The Linux kernel setup code gets round the inability of \c{as86} to
7073 generate the required instruction by coding it manually, using
7074 \c{DB} instructions. NASM can go one better than that, by actually
7075 generating the right instruction itself. Here's how to do it right:
7077 \c         jmp     dword 0x1234:0x56789ABC         ; right
7079 \I\c{JMP DWORD}The \c{DWORD} prefix (strictly speaking, it should
7080 come \e{after} the colon, since it is declaring the \e{offset} field
7081 to be a doubleword; but NASM will accept either form, since both are
7082 unambiguous) forces the offset part to be treated as far, in the
7083 assumption that you are deliberately writing a jump from a 16-bit
7084 segment to a 32-bit one.
7086 You can do the reverse operation, jumping from a 32-bit segment to a
7087 16-bit one, by means of the \c{WORD} prefix:
7089 \c         jmp     word 0x8765:0x4321      ; 32 to 16 bit
7091 If the \c{WORD} prefix is specified in 16-bit mode, or the \c{DWORD}
7092 prefix in 32-bit mode, they will be ignored, since each is
7093 explicitly forcing NASM into a mode it was in anyway.
7096 \H{mixaddr} Addressing Between Different-Size Segments\I{addressing,
7097 mixed-size}\I{mixed-size addressing}
7099 If your OS is mixed 16 and 32-bit, or if you are writing a DOS
7100 extender, you are likely to have to deal with some 16-bit segments
7101 and some 32-bit ones. At some point, you will probably end up
7102 writing code in a 16-bit segment which has to access data in a
7103 32-bit segment, or vice versa.
7105 If the data you are trying to access in a 32-bit segment lies within
7106 the first 64K of the segment, you may be able to get away with using
7107 an ordinary 16-bit addressing operation for the purpose; but sooner
7108 or later, you will want to do 32-bit addressing from 16-bit mode.
7110 The easiest way to do this is to make sure you use a register for
7111 the address, since any effective address containing a 32-bit
7112 register is forced to be a 32-bit address. So you can do
7114 \c         mov     eax,offset_into_32_bit_segment_specified_by_fs
7115 \c         mov     dword [fs:eax],0x11223344
7117 This is fine, but slightly cumbersome (since it wastes an
7118 instruction and a register) if you already know the precise offset
7119 you are aiming at. The x86 architecture does allow 32-bit effective
7120 addresses to specify nothing but a 4-byte offset, so why shouldn't
7121 NASM be able to generate the best instruction for the purpose?
7123 It can. As in \k{mixjump}, you need only prefix the address with the
7124 \c{DWORD} keyword, and it will be forced to be a 32-bit address:
7126 \c         mov     dword [fs:dword my_offset],0x11223344
7128 Also as in \k{mixjump}, NASM is not fussy about whether the
7129 \c{DWORD} prefix comes before or after the segment override, so
7130 arguably a nicer-looking way to code the above instruction is
7132 \c         mov     dword [dword fs:my_offset],0x11223344
7134 Don't confuse the \c{DWORD} prefix \e{outside} the square brackets,
7135 which controls the size of the data stored at the address, with the
7136 one \c{inside} the square brackets which controls the length of the
7137 address itself. The two can quite easily be different:
7139 \c         mov     word [dword 0x12345678],0x9ABC
7141 This moves 16 bits of data to an address specified by a 32-bit
7142 offset.
7144 You can also specify \c{WORD} or \c{DWORD} prefixes along with the
7145 \c{FAR} prefix to indirect far jumps or calls. For example:
7147 \c         call    dword far [fs:word 0x4321]
7149 This instruction contains an address specified by a 16-bit offset;
7150 it loads a 48-bit far pointer from that (16-bit segment and 32-bit
7151 offset), and calls that address.
7154 \H{mixother} Other Mixed-Size Instructions
7156 The other way you might want to access data might be using the
7157 string instructions (\c{LODSx}, \c{STOSx} and so on) or the
7158 \c{XLATB} instruction. These instructions, since they take no
7159 parameters, might seem to have no easy way to make them perform
7160 32-bit addressing when assembled in a 16-bit segment.
7162 This is the purpose of NASM's \i\c{a16}, \i\c{a32} and \i\c{a64} prefixes. If
7163 you are coding \c{LODSB} in a 16-bit segment but it is supposed to
7164 be accessing a string in a 32-bit segment, you should load the
7165 desired address into \c{ESI} and then code
7167 \c         a32     lodsb
7169 The prefix forces the addressing size to 32 bits, meaning that
7170 \c{LODSB} loads from \c{[DS:ESI]} instead of \c{[DS:SI]}. To access
7171 a string in a 16-bit segment when coding in a 32-bit one, the
7172 corresponding \c{a16} prefix can be used.
7174 The \c{a16}, \c{a32} and \c{a64} prefixes can be applied to any instruction
7175 in NASM's instruction table, but most of them can generate all the
7176 useful forms without them. The prefixes are necessary only for
7177 instructions with implicit addressing:
7178 \# \c{CMPSx} (\k{insCMPSB}),
7179 \# \c{SCASx} (\k{insSCASB}), \c{LODSx} (\k{insLODSB}), \c{STOSx}
7180 \# (\k{insSTOSB}), \c{MOVSx} (\k{insMOVSB}), \c{INSx} (\k{insINSB}),
7181 \# \c{OUTSx} (\k{insOUTSB}), and \c{XLATB} (\k{insXLATB}).
7182 \c{CMPSx}, \c{SCASx}, \c{LODSx}, \c{STOSx}, \c{MOVSx}, \c{INSx},
7183 \c{OUTSx}, and \c{XLATB}.
7184 Also, the
7185 various push and pop instructions (\c{PUSHA} and \c{POPF} as well as
7186 the more usual \c{PUSH} and \c{POP}) can accept \c{a16}, \c{a32} or \c{a64}
7187 prefixes to force a particular one of \c{SP}, \c{ESP} or \c{RSP} to be used
7188 as a stack pointer, in case the stack segment in use is a different
7189 size from the code segment.
7191 \c{PUSH} and \c{POP}, when applied to segment registers in 32-bit
7192 mode, also have the slightly odd behaviour that they push and pop 4
7193 bytes at a time, of which the top two are ignored and the bottom two
7194 give the value of the segment register being manipulated. To force
7195 the 16-bit behaviour of segment-register push and pop instructions,
7196 you can use the operand-size prefix \i\c{o16}:
7198 \c         o16 push    ss
7199 \c         o16 push    ds
7201 This code saves a doubleword of stack space by fitting two segment
7202 registers into the space which would normally be consumed by pushing
7203 one.
7205 (You can also use the \i\c{o32} prefix to force the 32-bit behaviour
7206 when in 16-bit mode, but this seems less useful.)
7209 \C{64bit} Writing 64-bit Code (Unix, Win64)
7211 This chapter attempts to cover some of the common issues involved when
7212 writing 64-bit code, to run under \i{Win64} or Unix.  It covers how to
7213 write assembly code to interface with 64-bit C routines, and how to
7214 write position-independent code for shared libraries.
7216 All 64-bit code uses a flat memory model, since segmentation is not
7217 available in 64-bit mode.  The one exception is the \c{FS} and \c{GS}
7218 registers, which still add their bases.
7220 Position independence in 64-bit mode is significantly simpler, since
7221 the processor supports \c{RIP}-relative addressing directly; see the
7222 \c{REL} keyword (\k{effaddr}).  On most 64-bit platforms, it is
7223 probably desirable to make that the default, using the directive
7224 \c{DEFAULT REL} (\k{default}).
7226 64-bit programming is relatively similar to 32-bit programming, but
7227 of course pointers are 64 bits long; additionally, all existing
7228 platforms pass arguments in registers rather than on the stack.
7229 Furthermore, 64-bit platforms use SSE2 by default for floating point.
7230 Please see the ABI documentation for your platform.
7232 64-bit platforms differ in the sizes of the fundamental datatypes, not
7233 just from 32-bit platforms but from each other.  If a specific size
7234 data type is desired, it is probably best to use the types defined in
7235 the Standard C header \c{<inttypes.h>}.
7237 In 64-bit mode, the default instruction size is still 32 bits.  When
7238 loading a value into a 32-bit register (but not an 8- or 16-bit
7239 register), the upper 32 bits of the corresponding 64-bit register are
7240 set to zero.
7242 \H{reg64} Register Names in 64-bit Mode
7244 NASM uses the following names for general-purpose registers in 64-bit
7245 mode, for 8-, 16-, 32- and 64-bit references, respecitively:
7247 \c      AL/AH, CL/CH, DL/DH, BL/BH, SPL, BPL, SIL, DIL, R8B-R15B
7248 \c      AX, CX, DX, BX, SP, BP, SI, DI, R8W-R15W
7249 \c      EAX, ECX, EDX, EBX, ESP, EBP, ESI, EDI, R8D-R15D
7250 \c      RAX, RCX, RDX, RBX, RSP, RBP, RSI, RDI, R8-R15
7252 This is consistent with the AMD documentation and most other
7253 assemblers.  The Intel documentation, however, uses the names
7254 \c{R8L-R15L} for 8-bit references to the higher registers.  It is
7255 possible to use those names by definiting them as macros; similarly,
7256 if one wants to use numeric names for the low 8 registers, define them
7257 as macros.  The standard macro package \c{altreg} (see \k{pkg_altreg})
7258 can be used for this purpose.
7260 \H{id64} Immediates and Displacements in 64-bit Mode
7262 In 64-bit mode, immediates and displacements are generally only 32
7263 bits wide.  NASM will therefore truncate most displacements and
7264 immediates to 32 bits.
7266 The only instruction which takes a full \i{64-bit immediate} is:
7268 \c      MOV reg64,imm64
7270 NASM will produce this instruction whenever the programmer uses
7271 \c{MOV} with an immediate into a 64-bit register.  If this is not
7272 desirable, simply specify the equivalent 32-bit register, which will
7273 be automatically zero-extended by the processor, or specify the
7274 immediate as \c{DWORD}:
7276 \c      mov rax,foo             ; 64-bit immediate
7277 \c      mov rax,qword foo       ; (identical)
7278 \c      mov eax,foo             ; 32-bit immediate, zero-extended
7279 \c      mov rax,dword foo       ; 32-bit immediate, sign-extended
7281 The length of these instructions are 10, 5 and 7 bytes, respectively.
7283 The only instructions which take a full \I{64-bit displacement}64-bit
7284 \e{displacement} is loading or storing, using \c{MOV}, \c{AL}, \c{AX},
7285 \c{EAX} or \c{RAX} (but no other registers) to an absolute 64-bit address.
7286 Since this is a relatively rarely used instruction (64-bit code generally uses
7287 relative addressing), the programmer has to explicitly declare the
7288 displacement size as \c{QWORD}:
7290 \c      default abs
7292 \c      mov eax,[foo]           ; 32-bit absolute disp, sign-extended
7293 \c      mov eax,[a32 foo]       ; 32-bit absolute disp, zero-extended
7294 \c      mov eax,[qword foo]     ; 64-bit absolute disp
7296 \c      default rel
7298 \c      mov eax,[foo]           ; 32-bit relative disp
7299 \c      mov eax,[a32 foo]       ; d:o, address truncated to 32 bits(!)
7300 \c      mov eax,[qword foo]     ; error
7301 \c      mov eax,[abs qword foo] ; 64-bit absolute disp
7303 A sign-extended absolute displacement can access from -2 GB to +2 GB;
7304 a zero-extended absolute displacement can access from 0 to 4 GB.
7306 \H{unix64} Interfacing to 64-bit C Programs (Unix)
7308 On Unix, the 64-bit ABI is defined by the document:
7310 \W{http://www.x86-64.org/documentation/abi.pdf}\c{http://www.x86-64.org/documentation/abi.pdf}
7312 Although written for AT&T-syntax assembly, the concepts apply equally
7313 well for NASM-style assembly.  What follows is a simplified summary.
7315 The first six integer arguments (from the left) are passed in \c{RDI},
7316 \c{RSI}, \c{RDX}, \c{RCX}, \c{R8}, and \c{R9}, in that order.
7317 Additional integer arguments are passed on the stack.  These
7318 registers, plus \c{RAX}, \c{R10} and \c{R11} are destroyed by function
7319 calls, and thus are available for use by the function without saving.
7321 Integer return values are passed in \c{RAX} and \c{RDX}, in that order.
7323 Floating point is done using SSE registers, except for \c{long
7324 double}.  Floating-point arguments are passed in \c{XMM0} to \c{XMM7};
7325 return is \c{XMM0} and \c{XMM1}.  \c{long double} are passed on the
7326 stack, and returned in \c{ST(0)} and \c{ST(1)}.
7328 All SSE and x87 registers are destroyed by function calls.
7330 On 64-bit Unix, \c{long} is 64 bits.
7332 Integer and SSE register arguments are counted separately, so for the case of
7334 \c      void foo(long a, double b, int c)
7336 \c{a} is passed in \c{RDI}, \c{b} in \c{XMM0}, and \c{c} in \c{ESI}.
7338 \H{win64} Interfacing to 64-bit C Programs (Win64)
7340 The Win64 ABI is described at:
7342 \W{http://msdn2.microsoft.com/en-gb/library/ms794533.aspx}\c{http://msdn2.microsoft.com/en-gb/library/ms794533.aspx}
7344 What follows is a simplified summary.
7346 The first four integer arguments are passed in \c{RCX}, \c{RDX},
7347 \c{R8} and \c{R9}, in that order.  Additional integer arguments are
7348 passed on the stack.  These registers, plus \c{RAX}, \c{R10} and
7349 \c{R11} are destroyed by function calls, and thus are available for
7350 use by the function without saving.
7352 Integer return values are passed in \c{RAX} only.
7354 Floating point is done using SSE registers, except for \c{long
7355 double}.  Floating-point arguments are passed in \c{XMM0} to \c{XMM3};
7356 return is \c{XMM0} only.
7358 On Win64, \c{long} is 32 bits; \c{long long} or \c{_int64} is 64 bits.
7360 Integer and SSE register arguments are counted together, so for the case of
7362 \c      void foo(long long a, double b, int c)
7364 \c{a} is passed in \c{RCX}, \c{b} in \c{XMM1}, and \c{c} in \c{R8D}.
7366 \C{trouble} Troubleshooting
7368 This chapter describes some of the common problems that users have
7369 been known to encounter with NASM, and answers them. It also gives
7370 instructions for reporting bugs in NASM if you find a difficulty
7371 that isn't listed here.
7374 \H{problems} Common Problems
7376 \S{inefficient} NASM Generates \i{Inefficient Code}
7378 We sometimes get `bug' reports about NASM generating inefficient, or
7379 even `wrong', code on instructions such as \c{ADD ESP,8}. This is a
7380 deliberate design feature, connected to predictability of output:
7381 NASM, on seeing \c{ADD ESP,8}, will generate the form of the
7382 instruction which leaves room for a 32-bit offset. You need to code
7383 \I\c{BYTE}\c{ADD ESP,BYTE 8} if you want the space-efficient form of
7384 the instruction. This isn't a bug, it's user error: if you prefer to
7385 have NASM produce the more efficient code automatically enable
7386 optimization with the \c{-O} option (see \k{opt-O}).
7389 \S{jmprange} My Jumps are Out of Range\I{out of range, jumps}
7391 Similarly, people complain that when they issue \i{conditional
7392 jumps} (which are \c{SHORT} by default) that try to jump too far,
7393 NASM reports `short jump out of range' instead of making the jumps
7394 longer.
7396 This, again, is partly a predictability issue, but in fact has a
7397 more practical reason as well. NASM has no means of being told what
7398 type of processor the code it is generating will be run on; so it
7399 cannot decide for itself that it should generate \i\c{Jcc NEAR} type
7400 instructions, because it doesn't know that it's working for a 386 or
7401 above. Alternatively, it could replace the out-of-range short
7402 \c{JNE} instruction with a very short \c{JE} instruction that jumps
7403 over a \c{JMP NEAR}; this is a sensible solution for processors
7404 below a 386, but hardly efficient on processors which have good
7405 branch prediction \e{and} could have used \c{JNE NEAR} instead. So,
7406 once again, it's up to the user, not the assembler, to decide what
7407 instructions should be generated. See \k{opt-O}.
7410 \S{proborg} \i\c{ORG} Doesn't Work
7412 People writing \i{boot sector} programs in the \c{bin} format often
7413 complain that \c{ORG} doesn't work the way they'd like: in order to
7414 place the \c{0xAA55} signature word at the end of a 512-byte boot
7415 sector, people who are used to MASM tend to code
7417 \c         ORG 0
7419 \c         ; some boot sector code
7421 \c         ORG 510
7422 \c         DW 0xAA55
7424 This is not the intended use of the \c{ORG} directive in NASM, and
7425 will not work. The correct way to solve this problem in NASM is to
7426 use the \i\c{TIMES} directive, like this:
7428 \c         ORG 0
7430 \c         ; some boot sector code
7432 \c         TIMES 510-($-$$) DB 0
7433 \c         DW 0xAA55
7435 The \c{TIMES} directive will insert exactly enough zero bytes into
7436 the output to move the assembly point up to 510. This method also
7437 has the advantage that if you accidentally fill your boot sector too
7438 full, NASM will catch the problem at assembly time and report it, so
7439 you won't end up with a boot sector that you have to disassemble to
7440 find out what's wrong with it.
7443 \S{probtimes} \i\c{TIMES} Doesn't Work
7445 The other common problem with the above code is people who write the
7446 \c{TIMES} line as
7448 \c         TIMES 510-$ DB 0
7450 by reasoning that \c{$} should be a pure number, just like 510, so
7451 the difference between them is also a pure number and can happily be
7452 fed to \c{TIMES}.
7454 NASM is a \e{modular} assembler: the various component parts are
7455 designed to be easily separable for re-use, so they don't exchange
7456 information unnecessarily. In consequence, the \c{bin} output
7457 format, even though it has been told by the \c{ORG} directive that
7458 the \c{.text} section should start at 0, does not pass that
7459 information back to the expression evaluator. So from the
7460 evaluator's point of view, \c{$} isn't a pure number: it's an offset
7461 from a section base. Therefore the difference between \c{$} and 510
7462 is also not a pure number, but involves a section base. Values
7463 involving section bases cannot be passed as arguments to \c{TIMES}.
7465 The solution, as in the previous section, is to code the \c{TIMES}
7466 line in the form
7468 \c         TIMES 510-($-$$) DB 0
7470 in which \c{$} and \c{$$} are offsets from the same section base,
7471 and so their difference is a pure number. This will solve the
7472 problem and generate sensible code.
7475 \H{bugs} \i{Bugs}\I{reporting bugs}
7477 We have never yet released a version of NASM with any \e{known}
7478 bugs. That doesn't usually stop there being plenty we didn't know
7479 about, though. Any that you find should be reported firstly via the
7480 \i\c{bugtracker} at
7481 \W{https://sourceforge.net/projects/nasm/}\c{https://sourceforge.net/projects/nasm/}
7482 (click on "Bugs"), or if that fails then through one of the
7483 contacts in \k{contact}.
7485 Please read \k{qstart} first, and don't report the bug if it's
7486 listed in there as a deliberate feature. (If you think the feature
7487 is badly thought out, feel free to send us reasons why you think it
7488 should be changed, but don't just send us mail saying `This is a
7489 bug' if the documentation says we did it on purpose.) Then read
7490 \k{problems}, and don't bother reporting the bug if it's listed
7491 there.
7493 If you do report a bug, \e{please} give us all of the following
7494 information:
7496 \b What operating system you're running NASM under. DOS, Linux,
7497 NetBSD, Win16, Win32, VMS (I'd be impressed), whatever.
7499 \b If you're running NASM under DOS or Win32, tell us whether you've
7500 compiled your own executable from the DOS source archive, or whether
7501 you were using the standard distribution binaries out of the
7502 archive. If you were using a locally built executable, try to
7503 reproduce the problem using one of the standard binaries, as this
7504 will make it easier for us to reproduce your problem prior to fixing
7507 \b Which version of NASM you're using, and exactly how you invoked
7508 it. Give us the precise command line, and the contents of the
7509 \c{NASMENV} environment variable if any.
7511 \b Which versions of any supplementary programs you're using, and
7512 how you invoked them. If the problem only becomes visible at link
7513 time, tell us what linker you're using, what version of it you've
7514 got, and the exact linker command line. If the problem involves
7515 linking against object files generated by a compiler, tell us what
7516 compiler, what version, and what command line or options you used.
7517 (If you're compiling in an IDE, please try to reproduce the problem
7518 with the command-line version of the compiler.)
7520 \b If at all possible, send us a NASM source file which exhibits the
7521 problem. If this causes copyright problems (e.g. you can only
7522 reproduce the bug in restricted-distribution code) then bear in mind
7523 the following two points: firstly, we guarantee that any source code
7524 sent to us for the purposes of debugging NASM will be used \e{only}
7525 for the purposes of debugging NASM, and that we will delete all our
7526 copies of it as soon as we have found and fixed the bug or bugs in
7527 question; and secondly, we would prefer \e{not} to be mailed large
7528 chunks of code anyway. The smaller the file, the better. A
7529 three-line sample file that does nothing useful \e{except}
7530 demonstrate the problem is much easier to work with than a
7531 fully fledged ten-thousand-line program. (Of course, some errors
7532 \e{do} only crop up in large files, so this may not be possible.)
7534 \b A description of what the problem actually \e{is}. `It doesn't
7535 work' is \e{not} a helpful description! Please describe exactly what
7536 is happening that shouldn't be, or what isn't happening that should.
7537 Examples might be: `NASM generates an error message saying Line 3
7538 for an error that's actually on Line 5'; `NASM generates an error
7539 message that I believe it shouldn't be generating at all'; `NASM
7540 fails to generate an error message that I believe it \e{should} be
7541 generating'; `the object file produced from this source code crashes
7542 my linker'; `the ninth byte of the output file is 66 and I think it
7543 should be 77 instead'.
7545 \b If you believe the output file from NASM to be faulty, send it to
7546 us. That allows us to determine whether our own copy of NASM
7547 generates the same file, or whether the problem is related to
7548 portability issues between our development platforms and yours. We
7549 can handle binary files mailed to us as MIME attachments, uuencoded,
7550 and even BinHex. Alternatively, we may be able to provide an FTP
7551 site you can upload the suspect files to; but mailing them is easier
7552 for us.
7554 \b Any other information or data files that might be helpful. If,
7555 for example, the problem involves NASM failing to generate an object
7556 file while TASM can generate an equivalent file without trouble,
7557 then send us \e{both} object files, so we can see what TASM is doing
7558 differently from us.
7561 \A{ndisasm} \i{Ndisasm}
7563                   The Netwide Disassembler, NDISASM
7565 \H{ndisintro} Introduction
7568 The Netwide Disassembler is a small companion program to the Netwide
7569 Assembler, NASM. It seemed a shame to have an x86 assembler,
7570 complete with a full instruction table, and not make as much use of
7571 it as possible, so here's a disassembler which shares the
7572 instruction table (and some other bits of code) with NASM.
7574 The Netwide Disassembler does nothing except to produce
7575 disassemblies of \e{binary} source files. NDISASM does not have any
7576 understanding of object file formats, like \c{objdump}, and it will
7577 not understand \c{DOS .EXE} files like \c{debug} will. It just
7578 disassembles.
7581 \H{ndisstart} Getting Started: Installation
7583 See \k{install} for installation instructions. NDISASM, like NASM,
7584 has a \c{man page} which you may want to put somewhere useful, if you
7585 are on a Unix system.
7588 \H{ndisrun} Running NDISASM
7590 To disassemble a file, you will typically use a command of the form
7592 \c        ndisasm -b {16|32|64} filename
7594 NDISASM can disassemble 16-, 32- or 64-bit code equally easily,
7595 provided of course that you remember to specify which it is to work
7596 with. If no \i\c{-b} switch is present, NDISASM works in 16-bit mode
7597 by default. The \i\c{-u} switch (for USE32) also invokes 32-bit mode.
7599 Two more command line options are \i\c{-r} which reports the version
7600 number of NDISASM you are running, and \i\c{-h} which gives a short
7601 summary of command line options.
7604 \S{ndiscom} COM Files: Specifying an Origin
7606 To disassemble a \c{DOS .COM} file correctly, a disassembler must assume
7607 that the first instruction in the file is loaded at address \c{0x100},
7608 rather than at zero. NDISASM, which assumes by default that any file
7609 you give it is loaded at zero, will therefore need to be informed of
7610 this.
7612 The \i\c{-o} option allows you to declare a different origin for the
7613 file you are disassembling. Its argument may be expressed in any of
7614 the NASM numeric formats: decimal by default, if it begins with `\c{$}'
7615 or `\c{0x}' or ends in `\c{H}' it's \c{hex}, if it ends in `\c{Q}' it's
7616 \c{octal}, and if it ends in `\c{B}' it's \c{binary}.
7618 Hence, to disassemble a \c{.COM} file:
7620 \c        ndisasm -o100h filename.com
7622 will do the trick.
7625 \S{ndissync} Code Following Data: Synchronisation
7627 Suppose you are disassembling a file which contains some data which
7628 isn't machine code, and \e{then} contains some machine code. NDISASM
7629 will faithfully plough through the data section, producing machine
7630 instructions wherever it can (although most of them will look
7631 bizarre, and some may have unusual prefixes, e.g. `\c{FS OR AX,0x240A}'),
7632 and generating `DB' instructions ever so often if it's totally stumped.
7633 Then it will reach the code section.
7635 Supposing NDISASM has just finished generating a strange machine
7636 instruction from part of the data section, and its file position is
7637 now one byte \e{before} the beginning of the code section. It's
7638 entirely possible that another spurious instruction will get
7639 generated, starting with the final byte of the data section, and
7640 then the correct first instruction in the code section will not be
7641 seen because the starting point skipped over it. This isn't really
7642 ideal.
7644 To avoid this, you can specify a `\i\c{synchronisation}' point, or indeed
7645 as many synchronisation points as you like (although NDISASM can
7646 only handle 8192 sync points internally). The definition of a sync
7647 point is this: NDISASM guarantees to hit sync points exactly during
7648 disassembly. If it is thinking about generating an instruction which
7649 would cause it to jump over a sync point, it will discard that
7650 instruction and output a `\c{db}' instead. So it \e{will} start
7651 disassembly exactly from the sync point, and so you \e{will} see all
7652 the instructions in your code section.
7654 Sync points are specified using the \i\c{-s} option: they are measured
7655 in terms of the program origin, not the file position. So if you
7656 want to synchronize after 32 bytes of a \c{.COM} file, you would have to
7659 \c        ndisasm -o100h -s120h file.com
7661 rather than
7663 \c        ndisasm -o100h -s20h file.com
7665 As stated above, you can specify multiple sync markers if you need
7666 to, just by repeating the \c{-s} option.
7669 \S{ndisisync} Mixed Code and Data: Automatic (Intelligent) Synchronisation
7670 \I\c{auto-sync}
7672 Suppose you are disassembling the boot sector of a \c{DOS} floppy (maybe
7673 it has a virus, and you need to understand the virus so that you
7674 know what kinds of damage it might have done you). Typically, this
7675 will contain a \c{JMP} instruction, then some data, then the rest of the
7676 code. So there is a very good chance of NDISASM being \e{misaligned}
7677 when the data ends and the code begins. Hence a sync point is
7678 needed.
7680 On the other hand, why should you have to specify the sync point
7681 manually? What you'd do in order to find where the sync point would
7682 be, surely, would be to read the \c{JMP} instruction, and then to use
7683 its target address as a sync point. So can NDISASM do that for you?
7685 The answer, of course, is yes: using either of the synonymous
7686 switches \i\c{-a} (for automatic sync) or \i\c{-i} (for intelligent
7687 sync) will enable \c{auto-sync} mode. Auto-sync mode automatically
7688 generates a sync point for any forward-referring PC-relative jump or
7689 call instruction that NDISASM encounters. (Since NDISASM is one-pass,
7690 if it encounters a PC-relative jump whose target has already been
7691 processed, there isn't much it can do about it...)
7693 Only PC-relative jumps are processed, since an absolute jump is
7694 either through a register (in which case NDISASM doesn't know what
7695 the register contains) or involves a segment address (in which case
7696 the target code isn't in the same segment that NDISASM is working
7697 in, and so the sync point can't be placed anywhere useful).
7699 For some kinds of file, this mechanism will automatically put sync
7700 points in all the right places, and save you from having to place
7701 any sync points manually. However, it should be stressed that
7702 auto-sync mode is \e{not} guaranteed to catch all the sync points, and
7703 you may still have to place some manually.
7705 Auto-sync mode doesn't prevent you from declaring manual sync
7706 points: it just adds automatically generated ones to the ones you
7707 provide. It's perfectly feasible to specify \c{-i} \e{and} some \c{-s}
7708 options.
7710 Another caveat with auto-sync mode is that if, by some unpleasant
7711 fluke, something in your data section should disassemble to a
7712 PC-relative call or jump instruction, NDISASM may obediently place a
7713 sync point in a totally random place, for example in the middle of
7714 one of the instructions in your code section. So you may end up with
7715 a wrong disassembly even if you use auto-sync. Again, there isn't
7716 much I can do about this. If you have problems, you'll have to use
7717 manual sync points, or use the \c{-k} option (documented below) to
7718 suppress disassembly of the data area.
7721 \S{ndisother} Other Options
7723 The \i\c{-e} option skips a header on the file, by ignoring the first N
7724 bytes. This means that the header is \e{not} counted towards the
7725 disassembly offset: if you give \c{-e10 -o10}, disassembly will start
7726 at byte 10 in the file, and this will be given offset 10, not 20.
7728 The \i\c{-k} option is provided with two comma-separated numeric
7729 arguments, the first of which is an assembly offset and the second
7730 is a number of bytes to skip. This \e{will} count the skipped bytes
7731 towards the assembly offset: its use is to suppress disassembly of a
7732 data section which wouldn't contain anything you wanted to see
7733 anyway.
7736 \H{ndisbugs} Bugs and Improvements
7738 There are no known bugs. However, any you find, with patches if
7739 possible, should be sent to
7740 \W{mailto:nasm-bugs@lists.sourceforge.net}\c{nasm-bugs@lists.sourceforge.net}, or to the
7741 developer's site at
7742 \W{https://sourceforge.net/projects/nasm/}\c{https://sourceforge.net/projects/nasm/}
7743 and we'll try to fix them. Feel free to send contributions and
7744 new features as well.
7746 \A{inslist} \i{Instruction List}
7748 \H{inslistintro} Introduction
7750 The following sections show the instructions which NASM currently supports. For each
7751 instruction, there is a separate entry for each supported addressing mode. The third
7752 column shows the processor type in which the instruction was introduced and,
7753  when appropriate, one or more usage flags.
7755 \& inslist.src
7757 \A{changelog} \i{NASM Version History}
7759 \& changes.src