BR 812417: Deadman counter for macro expansion
[nasm/avx512.git] / doc / nasmdoc.src
blob2cbb83362f4e1b6591d9b1d26fa8eed69b5319f7
1 \#
2 \# Source code to NASM documentation
3 \#
4 \M{category}{Programming}
5 \M{title}{NASM - The Netwide Assembler}
6 \M{year}{2007}
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{-MG} \c{-MG} option
20 \IR{-On} \c{-On} option
21 \IR{-P} \c{-P} option
22 \IR{-U} \c{-U} option
23 \IR{-X} \c{-X} option
24 \IR{-a} \c{-a} option
25 \IR{-d} \c{-d} option
26 \IR{-e} \c{-e} option
27 \IR{-f} \c{-f} option
28 \IR{-g} \c{-g} option
29 \IR{-i} \c{-i} option
30 \IR{-l} \c{-l} option
31 \IR{-o} \c{-o} option
32 \IR{-p} \c{-p} option
33 \IR{-s} \c{-s} option
34 \IR{-u} \c{-u} option
35 \IR{-v} \c{-v} option
36 \IR{-w} \c{-w} option
37 \IR{-y} \c{-y} option
38 \IR{-Z} \c{-Z} option
39 \IR{!=} \c{!=} operator
40 \IR{$, here} \c{$}, Here token
41 \IR{$, prefix} \c{$}, prefix
42 \IR{$$} \c{$$} token
43 \IR{%} \c{%} operator
44 \IR{%%} \c{%%} operator
45 \IR{%+1} \c{%+1} and \c{%-1} syntax
46 \IA{%-1}{%+1}
47 \IR{%0} \c{%0} parameter count
48 \IR{&} \c{&} operator
49 \IR{&&} \c{&&} operator
50 \IR{*} \c{*} operator
51 \IR{..@} \c{..@} symbol prefix
52 \IR{/} \c{/} operator
53 \IR{//} \c{//} operator
54 \IR{<} \c{<} operator
55 \IR{<<} \c{<<} operator
56 \IR{<=} \c{<=} operator
57 \IR{<>} \c{<>} operator
58 \IR{=} \c{=} operator
59 \IR{==} \c{==} operator
60 \IR{>} \c{>} operator
61 \IR{>=} \c{>=} operator
62 \IR{>>} \c{>>} operator
63 \IR{?} \c{?} MASM syntax
64 \IR{^} \c{^} operator
65 \IR{^^} \c{^^} operator
66 \IR{|} \c{|} operator
67 \IR{||} \c{||} operator
68 \IR{~} \c{~} operator
69 \IR{%$} \c{%$} and \c{%$$} prefixes
70 \IA{%$$}{%$}
71 \IR{+ opaddition} \c{+} operator, binary
72 \IR{+ opunary} \c{+} operator, unary
73 \IR{+ modifier} \c{+} modifier
74 \IR{- opsubtraction} \c{-} operator, binary
75 \IR{- opunary} \c{-} operator, unary
76 \IR{! opunary} \c{!} operator, unary
77 \IR{alignment, in bin sections} alignment, in \c{bin} sections
78 \IR{alignment, in elf sections} alignment, in \c{elf} sections
79 \IR{alignment, in win32 sections} alignment, in \c{win32} sections
80 \IR{alignment, of elf common variables} alignment, of \c{elf} common
81 variables
82 \IR{alignment, in obj sections} alignment, in \c{obj} sections
83 \IR{a.out, bsd version} \c{a.out}, BSD version
84 \IR{a.out, linux version} \c{a.out}, Linux version
85 \IR{autoconf} Autoconf
86 \IR{bin} bin
87 \IR{bitwise and} bitwise AND
88 \IR{bitwise or} bitwise OR
89 \IR{bitwise xor} bitwise XOR
90 \IR{block ifs} block IFs
91 \IR{borland pascal} Borland, Pascal
92 \IR{borland's win32 compilers} Borland, Win32 compilers
93 \IR{braces, after % sign} braces, after \c{%} sign
94 \IR{bsd} BSD
95 \IR{c calling convention} C calling convention
96 \IR{c symbol names} C symbol names
97 \IA{critical expressions}{critical expression}
98 \IA{command line}{command-line}
99 \IA{case sensitivity}{case sensitive}
100 \IA{case-sensitive}{case sensitive}
101 \IA{case-insensitive}{case sensitive}
102 \IA{character constants}{character constant}
103 \IR{common object file format} Common Object File Format
104 \IR{common variables, alignment in elf} common variables, alignment
105 in \c{elf}
106 \IR{common, elf extensions to} \c{COMMON}, \c{elf} extensions to
107 \IR{common, obj extensions to} \c{COMMON}, \c{obj} extensions to
108 \IR{declaring structure} declaring structures
109 \IR{default-wrt mechanism} default-\c{WRT} mechanism
110 \IR{devpac} DevPac
111 \IR{djgpp} DJGPP
112 \IR{dll symbols, exporting} DLL symbols, exporting
113 \IR{dll symbols, importing} DLL symbols, importing
114 \IR{dos} DOS
115 \IR{dos archive} DOS archive
116 \IR{dos source archive} DOS source archive
117 \IA{effective address}{effective addresses}
118 \IA{effective-address}{effective addresses}
119 \IR{elf} ELF
120 \IR{elf, 16-bit code and} ELF, 16-bit code and
121 \IR{elf shared libraries} ELF, shared libraries
122 \IR{executable and linkable format} Executable and Linkable Format
123 \IR{extern, obj extensions to} \c{EXTERN}, \c{obj} extensions to
124 \IR{extern, rdf extensions to} \c{EXTERN}, \c{rdf} extensions to
125 \IR{freebsd} FreeBSD
126 \IR{freelink} FreeLink
127 \IR{functions, c calling convention} functions, C calling convention
128 \IR{functions, pascal calling convention} functions, Pascal calling
129 convention
130 \IR{global, aoutb extensions to} \c{GLOBAL}, \c{aoutb} extensions to
131 \IR{global, elf extensions to} \c{GLOBAL}, \c{elf} extensions to
132 \IR{global, rdf extensions to} \c{GLOBAL}, \c{rdf} extensions to
133 \IR{got} GOT
134 \IR{got relocations} \c{GOT} relocations
135 \IR{gotoff relocation} \c{GOTOFF} relocations
136 \IR{gotpc relocation} \c{GOTPC} relocations
137 \IR{intel number formats} Intel number formats
138 \IR{linux, elf} Linux, ELF
139 \IR{linux, a.out} Linux, \c{a.out}
140 \IR{linux, as86} Linux, \c{as86}
141 \IR{logical and} logical AND
142 \IR{logical or} logical OR
143 \IR{logical xor} logical XOR
144 \IR{masm} MASM
145 \IA{memory reference}{memory references}
146 \IR{minix} Minix
147 \IA{misc directory}{misc subdirectory}
148 \IR{misc subdirectory} \c{misc} subdirectory
149 \IR{microsoft omf} Microsoft OMF
150 \IR{mmx registers} MMX registers
151 \IA{modr/m}{modr/m byte}
152 \IR{modr/m byte} ModR/M byte
153 \IR{ms-dos} MS-DOS
154 \IR{ms-dos device drivers} MS-DOS device drivers
155 \IR{multipush} \c{multipush} macro
156 \IR{nan} NaN
157 \IR{nasm version} NASM version
158 \IR{netbsd} NetBSD
159 \IR{omf} OMF
160 \IR{openbsd} OpenBSD
161 \IR{operating system} operating system
162 \IR{os/2} OS/2
163 \IR{pascal calling convention}Pascal calling convention
164 \IR{passes} passes, assembly
165 \IR{perl} Perl
166 \IR{pic} PIC
167 \IR{pharlap} PharLap
168 \IR{plt} PLT
169 \IR{plt} \c{PLT} relocations
170 \IA{pre-defining macros}{pre-define}
171 \IA{preprocessor expressions}{preprocessor, expressions}
172 \IA{preprocessor loops}{preprocessor, loops}
173 \IA{preprocessor variables}{preprocessor, variables}
174 \IA{rdoff subdirectory}{rdoff}
175 \IR{rdoff} \c{rdoff} subdirectory
176 \IR{relocatable dynamic object file format} Relocatable Dynamic
177 Object File Format
178 \IR{relocations, pic-specific} relocations, PIC-specific
179 \IA{repeating}{repeating code}
180 \IR{section alignment, in elf} section alignment, in \c{elf}
181 \IR{section alignment, in bin} section alignment, in \c{bin}
182 \IR{section alignment, in obj} section alignment, in \c{obj}
183 \IR{section alignment, in win32} section alignment, in \c{win32}
184 \IR{section, elf extensions to} \c{SECTION}, \c{elf} extensions to
185 \IR{section, win32 extensions to} \c{SECTION}, \c{win32} extensions to
186 \IR{segment alignment, in bin} segment alignment, in \c{bin}
187 \IR{segment alignment, in obj} segment alignment, in \c{obj}
188 \IR{segment, obj extensions to} \c{SEGMENT}, \c{elf} extensions to
189 \IR{segment names, borland pascal} segment names, Borland Pascal
190 \IR{shift command} \c{shift} command
191 \IA{sib}{sib byte}
192 \IR{sib byte} SIB byte
193 \IR{solaris x86} Solaris x86
194 \IA{standard section names}{standardized section names}
195 \IR{symbols, exporting from dlls} symbols, exporting from DLLs
196 \IR{symbols, importing from dlls} symbols, importing from DLLs
197 \IR{test subdirectory} \c{test} subdirectory
198 \IR{tlink} \c{TLINK}
199 \IR{underscore, in c symbols} underscore, in C symbols
200 \IR{unix} Unix
201 \IA{sco unix}{unix, sco}
202 \IR{unix, sco} Unix, SCO
203 \IA{unix source archive}{unix, source archive}
204 \IR{unix, source archive} Unix, source archive
205 \IA{unix system v}{unix, system v}
206 \IR{unix, system v} Unix, System V
207 \IR{unixware} UnixWare
208 \IR{val} VAL
209 \IR{version number of nasm} version number of NASM
210 \IR{visual c++} Visual C++
211 \IR{www page} WWW page
212 \IR{win32} Win32
213 \IR{win32} Win64
214 \IR{windows} Windows
215 \IR{windows 95} Windows 95
216 \IR{windows nt} Windows NT
217 \# \IC{program entry point}{entry point, program}
218 \# \IC{program entry point}{start point, program}
219 \# \IC{MS-DOS device drivers}{device drivers, MS-DOS}
220 \# \IC{16-bit mode, versus 32-bit mode}{32-bit mode, versus 16-bit mode}
221 \# \IC{c symbol names}{symbol names, in C}
224 \C{intro} Introduction
226 \H{whatsnasm} What Is NASM?
228 The Netwide Assembler, NASM, is an 80x86 and x86-64 assembler designed for
229 portability and modularity. It supports a range of object file
230 formats, including Linux and \c{*BSD} \c{a.out}, \c{ELF}, \c{COFF}, \c{Mach-O},
231 Microsoft 16-bit \c{OBJ}, \c{Win32} and \c{Win64}. It will also output plain
232 binary files. Its syntax is designed to be simple and easy to understand, similar
233 to Intel's but less complex. It supports from the upto and including \c{Pentium},
234 \c{P6}, \c{MMX}, \c{3DNow!}, \c{SSE}, \c{SSE2}, \c{SSE3} and \c{x64} opcodes. NASM has
235 a strong support for macro conventions.
238 \S{yaasm} Why Yet Another Assembler?
240 The Netwide Assembler grew out of an idea on \i\c{comp.lang.asm.x86}
241 (or possibly \i\c{alt.lang.asm} - I forget which), which was
242 essentially that there didn't seem to be a good \e{free} x86-series
243 assembler around, and that maybe someone ought to write one.
245 \b \i\c{a86} is good, but not free, and in particular you don't get any
246 32-bit capability until you pay. It's DOS only, too.
248 \b \i\c{gas} is free, and ports over to DOS and Unix, but it's not
249 very good, since it's designed to be a back end to \i\c{gcc}, which
250 always feeds it correct code. So its error checking is minimal. Also,
251 its syntax is horrible, from the point of view of anyone trying to
252 actually \e{write} anything in it. Plus you can't write 16-bit code in
253 it (properly.)
255 \b \i\c{as86} is specific to Minix and Linux, and (my version at least)
256 doesn't seem to have much (or any) documentation.
258 \b \i\c{MASM} isn't very good, and it's (was) expensive, and it runs only under
259 DOS.
261 \b \i\c{TASM} is better, but still strives for MASM compatibility,
262 which means millions of directives and tons of red tape. And its syntax
263 is essentially MASM's, with the contradictions and quirks that
264 entails (although it sorts out some of those by means of Ideal mode.)
265 It's expensive too. And it's DOS-only.
267 So here, for your coding pleasure, is NASM. At present it's
268 still in prototype stage - we don't promise that it can outperform
269 any of these assemblers. But please, \e{please} send us bug reports,
270 fixes, helpful information, and anything else you can get your hands
271 on (and thanks to the many people who've done this already! You all
272 know who you are), and we'll improve it out of all recognition.
273 Again.
276 \S{legal} License Conditions
278 Please see the file \c{COPYING}, supplied as part of any NASM
279 distribution archive, for the \i{license} conditions under which you
280 may use NASM.  NASM is now under the so-called GNU Lesser General
281 Public License, LGPL.
284 \H{contact} Contact Information
286 The current version of NASM (since about 0.98.08) is maintained by a
287 team of developers, accessible through the \c{nasm-devel} mailing list
288 (see below for the link).
289 If you want to report a bug, please read \k{bugs} first.
291 NASM has a \i{WWW page} at
292 \W{http://nasm.sourceforge.net}\c{http://nasm.sourceforge.net}. If it's
293 not there, google for us!
296 The original authors are \i{e\-mail}able as
297 \W{mailto:jules@dsf.org.uk}\c{jules@dsf.org.uk} and
298 \W{mailto:anakin@pobox.com}\c{anakin@pobox.com}.
299 The latter is no longer involved in the development team.
301 \i{New releases} of NASM are uploaded to the official sites
302 \W{http://nasm.sourceforge.net}\c{http://nasm.sourceforge.net}
303 and to
304 \W{ftp://ftp.kernel.org/pub/software/devel/nasm/}\i\c{ftp.kernel.org}
306 \W{ftp://ibiblio.org/pub/Linux/devel/lang/assemblers/}\i\c{ibiblio.org}.
308 Announcements are posted to
309 \W{news:comp.lang.asm.x86}\i\c{comp.lang.asm.x86},
310 \W{news:alt.lang.asm}\i\c{alt.lang.asm} and
311 \W{news:comp.os.linux.announce}\i\c{comp.os.linux.announce}
313 If you want information about NASM beta releases, and the current
314 development status, please subscribe to the \i\c{nasm-devel} email list
315 by registering at
316 \W{http://sourceforge.net/projects/nasm}\c{http://sourceforge.net/projects/nasm}.
319 \H{install} Installation
321 \S{instdos} \i{Installing} NASM under MS-\i{DOS} or Windows
323 Once you've obtained the \i{DOS archive} for NASM, \i\c{nasmXXX.zip}
324 (where \c{XXX} denotes the version number of NASM contained in the
325 archive), unpack it into its own directory (for example \c{c:\\nasm}).
327 The archive will contain four executable files: the NASM executable
328 files \i\c{nasm.exe} and \i\c{nasmw.exe}, and the NDISASM executable
329 files \i\c{ndisasm.exe} and \i\c{ndisasmw.exe}. In each case, the
330 file whose name ends in \c{w} is a \I{Win32}\c{Win32} executable,
331 designed to run under \I{Windows 95}\c{Windows 95} or \I{Windows NT}
332 \c{Windows NT} Intel, and the other one is a 16-bit \I{DOS}\c{DOS}
333 executable.
335 The only file NASM needs to run is its own executable, so copy
336 (at least) one of \c{nasm.exe} and \c{nasmw.exe} to a directory on
337 your PATH, or alternatively edit \i\c{autoexec.bat} to add the
338 \c{nasm} directory to your \i\c{PATH}. (If you're only installing the
339 \c{Win32} version, you may wish to rename it to \c{nasm.exe}.)
341 That's it - NASM is installed. You don't need the nasm directory
342 to be present to run NASM (unless you've added it to your \c{PATH}),
343 so you can delete it if you need to save space; however, you may
344 want to keep the documentation or test programs.
346 If you've downloaded the \i{DOS source archive}, \i\c{nasmXXXs.zip},
347 the \c{nasm} directory will also contain the full NASM \i{source
348 code}, and a selection of \i{Makefiles} you can (hopefully) use to
349 rebuild your copy of NASM from scratch.
351 Note that the source files \c{insnsa.c}, \c{insnsd.c}, \c{insnsi.h}
352 and \c{insnsn.c} are automatically generated from the master
353 instruction table \c{insns.dat} by a Perl script; the file
354 \c{macros.c} is generated from \c{standard.mac} by another Perl
355 script. Although the NASM source distribution includes these generated
356 files, you will need to rebuild them (and hence, will need a Perl
357 interpreter) if you change insns.dat, standard.mac or the
358 documentation. It is possible future source distributions may not
359 include these files at all. Ports of \i{Perl} for a variety of
360 platforms, including DOS and Windows, are available from
361 \W{http://www.cpan.org/ports/}\i{www.cpan.org}.
364 \S{instdos} Installing NASM under \i{Unix}
366 Once you've obtained the \i{Unix source archive} for NASM,
367 \i\c{nasm-X.XX.tar.gz} (where \c{X.XX} denotes the version number of
368 NASM contained in the archive), unpack it into a directory such
369 as \c{/usr/local/src}. The archive, when unpacked, will create its
370 own subdirectory \c{nasm-X.XX}.
372 NASM is an \I{Autoconf}\I\c{configure}auto-configuring package: once
373 you've unpacked it, \c{cd} to the directory it's been unpacked into
374 and type \c{./configure}. This shell script will find the best C
375 compiler to use for building NASM and set up \i{Makefiles}
376 accordingly.
378 Once NASM has auto-configured, you can type \i\c{make} to build the
379 \c{nasm} and \c{ndisasm} binaries, and then \c{make install} to
380 install them in \c{/usr/local/bin} and install the \i{man pages}
381 \i\c{nasm.1} and \i\c{ndisasm.1} in \c{/usr/local/man/man1}.
382 Alternatively, you can give options such as \c{--prefix} to the
383 configure script (see the file \i\c{INSTALL} for more details), or
384 install the programs yourself.
386 NASM also comes with a set of utilities for handling the \c{RDOFF}
387 custom object-file format, which are in the \i\c{rdoff} subdirectory
388 of the NASM archive. You can build these with \c{make rdf} and
389 install them with \c{make rdf_install}, if you want them.
391 If NASM fails to auto-configure, you may still be able to make it
392 compile by using the fall-back Unix makefile \i\c{Makefile.unx}.
393 Copy or rename that file to \c{Makefile} and try typing \c{make}.
394 There is also a Makefile.unx file in the \c{rdoff} subdirectory.
397 \C{running} Running NASM
399 \H{syntax} NASM \i{Command-Line} Syntax
401 To assemble a file, you issue a command of the form
403 \c nasm -f <format> <filename> [-o <output>]
405 For example,
407 \c nasm -f elf myfile.asm
409 will assemble \c{myfile.asm} into an \c{ELF} object file \c{myfile.o}. And
411 \c nasm -f bin myfile.asm -o myfile.com
413 will assemble \c{myfile.asm} into a raw binary file \c{myfile.com}.
415 To produce a listing file, with the hex codes output from NASM
416 displayed on the left of the original sources, use the \c{-l} option
417 to give a listing file name, for example:
419 \c nasm -f coff myfile.asm -l myfile.lst
421 To get further usage instructions from NASM, try typing
423 \c nasm -h
425 As \c{-hf}, this will also list the available output file formats, and what they
426 are.
428 If you use Linux but aren't sure whether your system is \c{a.out}
429 or \c{ELF}, type
431 \c file nasm
433 (in the directory in which you put the NASM binary when you
434 installed it). If it says something like
436 \c nasm: ELF 32-bit LSB executable i386 (386 and up) Version 1
438 then your system is \c{ELF}, and you should use the option \c{-f elf}
439 when you want NASM to produce Linux object files. If it says
441 \c nasm: Linux/i386 demand-paged executable (QMAGIC)
443 or something similar, your system is \c{a.out}, and you should use
444 \c{-f aout} instead (Linux \c{a.out} systems have long been obsolete,
445 and are rare these days.)
447 Like Unix compilers and assemblers, NASM is silent unless it
448 goes wrong: you won't see any output at all, unless it gives error
449 messages.
452 \S{opt-o} The \i\c{-o} Option: Specifying the Output File Name
454 NASM will normally choose the name of your output file for you;
455 precisely how it does this is dependent on the object file format.
456 For Microsoft object file formats (\i\c{obj} and \i\c{win32}), it
457 will remove the \c{.asm} \i{extension} (or whatever extension you
458 like to use - NASM doesn't care) from your source file name and
459 substitute \c{.obj}. For Unix object file formats (\i\c{aout},
460 \i\c{coff}, \i\c{elf}, \i\c{macho} and \i\c{as86}) it will substitute \c{.o}. For
461 \i\c{rdf}, it will use \c{.rdf}, and for the \i\c{bin} format it
462 will simply remove the extension, so that \c{myfile.asm} produces
463 the output file \c{myfile}.
465 If the output file already exists, NASM will overwrite it, unless it
466 has the same name as the input file, in which case it will give a
467 warning and use \i\c{nasm.out} as the output file name instead.
469 For situations in which this behaviour is unacceptable, NASM
470 provides the \c{-o} command-line option, which allows you to specify
471 your desired output file name. You invoke \c{-o} by following it
472 with the name you wish for the output file, either with or without
473 an intervening space. For example:
475 \c nasm -f bin program.asm -o program.com
476 \c nasm -f bin driver.asm -odriver.sys
478 Note that this is a small o, and is different from a capital O , which
479 is used to specify the number of optimisation passes required. See \k{opt-On}.
482 \S{opt-f} The \i\c{-f} Option: Specifying the \i{Output File Format}
484 If you do not supply the \c{-f} option to NASM, it will choose an
485 output file format for you itself. In the distribution versions of
486 NASM, the default is always \i\c{bin}; if you've compiled your own
487 copy of NASM, you can redefine \i\c{OF_DEFAULT} at compile time and
488 choose what you want the default to be.
490 Like \c{-o}, the intervening space between \c{-f} and the output
491 file format is optional; so \c{-f elf} and \c{-felf} are both valid.
493 A complete list of the available output file formats can be given by
494 issuing the command \i\c{nasm -hf}.
497 \S{opt-l} The \i\c{-l} Option: Generating a \i{Listing File}
499 If you supply the \c{-l} option to NASM, followed (with the usual
500 optional space) by a file name, NASM will generate a
501 \i{source-listing file} for you, in which addresses and generated
502 code are listed on the left, and the actual source code, with
503 expansions of multi-line macros (except those which specifically
504 request no expansion in source listings: see \k{nolist}) on the
505 right. For example:
507 \c nasm -f elf myfile.asm -l myfile.lst
509 If a list file is selected, you may turn off listing for a 
510 section of your source with \c{[list -]}, and turn it back on
511 with \c{[list +]}, (the default, obviously). There is no "user 
512 form" (without the brackets). This can be used to list only 
513 sections of interest, avoiding excessively long listings.
516 \S{opt-M} The \i\c{-M} Option: Generate \i{Makefile Dependencies}
518 This option can be used to generate makefile dependencies on stdout.
519 This can be redirected to a file for further processing. For example:
521 \c NASM -M myfile.asm > myfile.dep
524 \S{opt-MG} The \i\c{-MG} Option: Generate \i{Makefile Dependencies}
526 This option can be used to generate makefile dependencies on stdout.
527 This differs from the \c{-M} option in that if a nonexisting file is
528 encountered, it is assumed to be a generated file and is added to the
529 dependency list without a prefix.
532 \S{opt-F} The \i\c{-F} Option: Selecting a \i{Debug Information Format}
534 This option is used to select the format of the debug information emitted 
535 into the output file, to be used by a debugger (or \e{will} be). Use
536 of this switch does \e{not} enable output of the selected debug info format.
537 Use \c{-g}, see \k{opt-g}, to enable output.
539 A complete list of the available debug file formats for an output format
540 can be seen by issuing the command \i\c{nasm -f <format> -y}. (As of 0.99.05,
541 only "-f elf32", "-f elf64", "-f ieee", and "-f obj" provide debug information.) 
542 See: \k{opt-y}.
544 This should not be confused with the "-f dbg" output format option which 
545 is not built into NASM by default. For information on how
546 to enable it when building from the sources, see \k{dbgfmt}
549 \S{opt-g} The \i\c{-g} Option: Enabling \i{Debug Information}.
551 This option can be used to generate debugging information in the specified
552 format. See: \k{opt-F}. Using \c{-g} without \c{-F} results in emitting 
553 debug info in the default format, if any, for the selected output format.
554 If no debug information is currently implemented in the selected output 
555 format, \c{-g} is \e{silently ignored}.
558 \S{opt-X} The \i\c{-X} Option: Selecting an \i{Error Reporting Format}
560 This option can be used to select an error reporting format for any 
561 error messages that might be produced by NASM.
563 Currently, two error reporting formats may be selected.  They are
564 the \c{-Xvc} option and the \c{-Xgnu} option.  The GNU format is 
565 the default and looks like this:
567 \c filename.asm:65: error: specific error message 
569 where \c{filename.asm} is the name of the source file in which the
570 error was detected, \c{65} is the source file line number on which 
571 the error was detected, \c{error} is the severity of the error (this
572 could be \c{warning}), and \c{specific error message} is a more
573 detailed text message which should help pinpoint the exact problem.
575 The other format, specified by \c{-Xvc} is the style used by Microsoft
576 Visual C++ and some other programs.  It looks like this:
578 \c filename.asm(65) : error: specific error message
580 where the only difference is that the line number is in parentheses
581 instead of being delimited by colons.  
583 See also the \c{Visual C++} output format, \k{win32fmt}.
585 \S{opt-Z} The \i\c{-Z} Option: Send Errors to a File
587 Under \I{DOS}\c{MS-DOS} it can be difficult (though there are ways) to
588 redirect the standard-error output of a program to a file. Since
589 NASM usually produces its warning and \i{error messages} on
590 \i\c{stderr}, this can make it hard to capture the errors if (for
591 example) you want to load them into an editor.
593 NASM therefore provides the \c{-Z} option, taking a filename argument
594 which causes errors to be sent to the specified files rather than
595 standard error. Therefore you can \I{redirecting errors}redirect
596 the errors into a file by typing
598 \c nasm -Z myfile.err -f obj myfile.asm
600 In earlier versions of NASM, this option was called \c{-E}, but it was
601 changed since \c{-E} is an option conventionally used for
602 preprocessing only, with disastrous results.  See \k{opt-E}.
604 \S{opt-s} The \i\c{-s} Option: Send Errors to \i\c{stdout}
606 The \c{-s} option redirects \i{error messages} to \c{stdout} rather
607 than \c{stderr}, so it can be redirected under \I{DOS}\c{MS-DOS}. To
608 assemble the file \c{myfile.asm} and pipe its output to the \c{more}
609 program, you can type:
611 \c nasm -s -f obj myfile.asm | more
613 See also the \c{-Z} option, \k{opt-Z}.
616 \S{opt-i} The \i\c{-i}\I\c{-I} Option: Include File Search Directories
618 When NASM sees the \i\c{%include} or \i\c{incbin} directive in 
619 a source file (see \k{include} or \k{incbin}), 
620 it will search for the given file not only in the
621 current directory, but also in any directories specified on the
622 command line by the use of the \c{-i} option. Therefore you can
623 include files from a \i{macro library}, for example, by typing
625 \c nasm -ic:\macrolib\ -f obj myfile.asm
627 (As usual, a space between \c{-i} and the path name is allowed, and
628 optional).
630 NASM, in the interests of complete source-code portability, does not
631 understand the file naming conventions of the OS it is running on;
632 the string you provide as an argument to the \c{-i} option will be
633 prepended exactly as written to the name of the include file.
634 Therefore the trailing backslash in the above example is necessary.
635 Under Unix, a trailing forward slash is similarly necessary.
637 (You can use this to your advantage, if you're really \i{perverse},
638 by noting that the option \c{-ifoo} will cause \c{%include "bar.i"}
639 to search for the file \c{foobar.i}...)
641 If you want to define a \e{standard} \i{include search path},
642 similar to \c{/usr/include} on Unix systems, you should place one or
643 more \c{-i} directives in the \c{NASMENV} environment variable (see
644 \k{nasmenv}).
646 For Makefile compatibility with many C compilers, this option can also
647 be specified as \c{-I}.
650 \S{opt-p} The \i\c{-p}\I\c{-P} Option: \I{pre-including files}Pre-Include a File
652 \I\c{%include}NASM allows you to specify files to be
653 \e{pre-included} into your source file, by the use of the \c{-p}
654 option. So running
656 \c nasm myfile.asm -p myinc.inc
658 is equivalent to running \c{nasm myfile.asm} and placing the
659 directive \c{%include "myinc.inc"} at the start of the file.
661 For consistency with the \c{-I}, \c{-D} and \c{-U} options, this
662 option can also be specified as \c{-P}.
665 \S{opt-d} The \i\c{-d}\I\c{-D} Option: \I{pre-defining macros}Pre-Define a Macro
667 \I\c{%define}Just as the \c{-p} option gives an alternative to placing
668 \c{%include} directives at the start of a source file, the \c{-d}
669 option gives an alternative to placing a \c{%define} directive. You
670 could code
672 \c nasm myfile.asm -dFOO=100
674 as an alternative to placing the directive
676 \c %define FOO 100
678 at the start of the file. You can miss off the macro value, as well:
679 the option \c{-dFOO} is equivalent to coding \c{%define FOO}. This
680 form of the directive may be useful for selecting \i{assembly-time
681 options} which are then tested using \c{%ifdef}, for example
682 \c{-dDEBUG}.
684 For Makefile compatibility with many C compilers, this option can also
685 be specified as \c{-D}.
688 \S{opt-u} The \i\c{-u}\I\c{-U} Option: \I{Undefining macros}Undefine a Macro
690 \I\c{%undef}The \c{-u} option undefines a macro that would otherwise
691 have been pre-defined, either automatically or by a \c{-p} or \c{-d}
692 option specified earlier on the command lines.
694 For example, the following command line:
696 \c nasm myfile.asm -dFOO=100 -uFOO
698 would result in \c{FOO} \e{not} being a predefined macro in the
699 program. This is useful to override options specified at a different
700 point in a Makefile.
702 For Makefile compatibility with many C compilers, this option can also
703 be specified as \c{-U}.
706 \S{opt-E} The \i\c{-E}\I{-e} Option: Preprocess Only
708 NASM allows the \i{preprocessor} to be run on its own, up to a
709 point. Using the \c{-E} option (which requires no arguments) will
710 cause NASM to preprocess its input file, expand all the macro
711 references, remove all the comments and preprocessor directives, and
712 print the resulting file on standard output (or save it to a file,
713 if the \c{-o} option is also used).
715 This option cannot be applied to programs which require the
716 preprocessor to evaluate \I{preprocessor expressions}\i{expressions}
717 which depend on the values of symbols: so code such as
719 \c %assign tablesize ($-tablestart)
721 will cause an error in \i{preprocess-only mode}.
723 For compatiblity with older version of NASM, this option can also be
724 written \c{-e}.  \c{-E} in older versions of NASM was the equivalent
725 of the current \c{-Z} option, \k{opt-Z}.
727 \S{opt-a} The \i\c{-a} Option: Don't Preprocess At All
729 If NASM is being used as the back end to a compiler, it might be
730 desirable to \I{suppressing preprocessing}suppress preprocessing
731 completely and assume the compiler has already done it, to save time
732 and increase compilation speeds. The \c{-a} option, requiring no
733 argument, instructs NASM to replace its powerful \i{preprocessor}
734 with a \i{stub preprocessor} which does nothing.
737 \S{opt-On} The \i\c{-On} Option: Specifying \i{Multipass Optimization}.
739 NASM defaults to being a two pass assembler. This means that if you
740 have a complex source file which needs more than 2 passes to assemble
741 optimally, you have to enable extra passes.
743 Using the \c{-O} option, you can tell NASM to carry out multiple passes.
744 The syntax is:
746 \b \c{-O0} strict two-pass assembly, JMP and Jcc are handled more
747         like v0.98, except that backward JMPs are short, if possible.
748         Immediate operands take their long forms if a short form is
749         not specified.
751 \b \c{-O1} strict two-pass assembly, but forward branches are assembled
752         with code guaranteed to reach; may produce larger code than
753         -O0, but will produce successful assembly more often if
754         branch offset sizes are not specified.
755         Additionally, immediate operands which will fit in a signed byte
756         are optimized, unless the long form is specified.
758 \b \c{-On} multi-pass optimization, minimize branch offsets; also will
759         minimize signed immediate bytes, overriding size specification
760         unless the \c{strict} keyword has been used (see \k{strict}).
761         The number specifies the maximum number of passes.  The more
762         passes, the better the code, but the slower is the assembly.
764 \b \c{-Ox} where \c{x} is the actual letter \c{x}, indicates to NASM
765         to do unlimited passes.
767 Note that this is a capital O, and is different from a small o, which
768 is used to specify the output format. See \k{opt-o}.
771 \S{opt-t} The \i\c{-t} option: Enable TASM Compatibility Mode
773 NASM includes a limited form of compatibility with Borland's \i\c{TASM}.
774 When NASM's \c{-t} option is used, the following changes are made:
776 \b local labels may be prefixed with \c{@@} instead of \c{.}
778 \b size override is supported within brackets. In TASM compatible mode,
779 a size override inside square brackets changes the size of the operand,
780 and not the address type of the operand as it does in NASM syntax. E.g.
781 \c{mov eax,[DWORD val]} is valid syntax in TASM compatibility mode.
782 Note that you lose the ability to override the default address type for
783 the instruction.
785 \b unprefixed forms of some directives supported (\c{arg}, \c{elif},
786 \c{else}, \c{endif}, \c{if}, \c{ifdef}, \c{ifdifi}, \c{ifndef},
787 \c{include}, \c{local})
789 \S{opt-w} The \i\c{-w} Option: Enable or Disable Assembly \i{Warnings}
791 NASM can observe many conditions during the course of assembly which
792 are worth mentioning to the user, but not a sufficiently severe
793 error to justify NASM refusing to generate an output file. These
794 conditions are reported like errors, but come up with the word
795 `warning' before the message. Warnings do not prevent NASM from
796 generating an output file and returning a success status to the
797 operating system.
799 Some conditions are even less severe than that: they are only
800 sometimes worth mentioning to the user. Therefore NASM supports the
801 \c{-w} command-line option, which enables or disables certain
802 classes of assembly warning. Such warning classes are described by a
803 name, for example \c{orphan-labels}; you can enable warnings of
804 this class by the command-line option \c{-w+orphan-labels} and
805 disable it by \c{-w-orphan-labels}.
807 The \i{suppressible warning} classes are:
809 \b \i\c{macro-params} covers warnings about \i{multi-line macros}
810 being invoked with the wrong number of parameters. This warning
811 class is enabled by default; see \k{mlmacover} for an example of why
812 you might want to disable it.
814 \b \i\c{macro-selfref} warns if a macro references itself. This 
815 warning class is enabled by default.
817 \b \i\c{orphan-labels} covers warnings about source lines which
818 contain no instruction but define a label without a trailing colon.
819 NASM does not warn about this somewhat obscure condition by default;
820 see \k{syntax} for an example of why you might want it to.
822 \b \i\c{number-overflow} covers warnings about numeric constants which
823 don't fit in 32 bits (for example, it's easy to type one too many Fs
824 and produce \c{0x7ffffffff} by mistake). This warning class is
825 enabled by default.
827 \b \i\c{gnu-elf-extensions} warns if 8-bit or 16-bit relocations 
828 are used in \c{-f elf} format. The GNU extensions allow this. 
829 This warning class is enabled by default.
831 \b In addition, warning classes may be enabled or disabled across 
832 sections of source code with \i\c{[warning +warning-name]} or 
833 \i\c{[warning -warning-name]}. No "user form" (without the 
834 brackets) exists. 
837 \S{opt-v} The \i\c{-v} Option: Display \i{Version} Info
839 Typing \c{NASM -v} will display the version of NASM which you are using,
840 and the date on which it was compiled.
842 You will need the version number if you report a bug.
844 \S{opt-y} The \i\c{-y} Option: Display Available Debug Info Formats
846 Typing \c{nasm -f <option> -y} will display a list of the available 
847 debug info formats for the given output format. The default format 
848 is indicated by an asterisk. E.g. \c{nasm -f elf -y} yields \c{* stabs}.
849 (as of 0.99.05, the \e{only} debug info format implemented for this output format).
852 \S{opt-pfix} The \i\c{--prefix} and \i\c{--postfix} Options.
854 The \c{--prefix} and \c{--postfix} options prepend or append 
855 (respectively) the given argument to all \c{global} or
856 \c{extern} variables. E.g. \c{--prefix_} will prepend the 
857 underscore to all global and external variables, as C sometimes 
858 (but not always) likes it.
861 \S{nasmenv} The \c{NASMENV} \i{Environment} Variable
863 If you define an environment variable called \c{NASMENV}, the program
864 will interpret it as a list of extra command-line options, which are
865 processed before the real command line. You can use this to define
866 standard search directories for include files, by putting \c{-i}
867 options in the \c{NASMENV} variable.
869 The value of the variable is split up at white space, so that the
870 value \c{-s -ic:\\nasmlib} will be treated as two separate options.
871 However, that means that the value \c{-dNAME="my name"} won't do
872 what you might want, because it will be split at the space and the
873 NASM command-line processing will get confused by the two
874 nonsensical words \c{-dNAME="my} and \c{name"}.
876 To get round this, NASM provides a feature whereby, if you begin the
877 \c{NASMENV} environment variable with some character that isn't a minus
878 sign, then NASM will treat this character as the \i{separator
879 character} for options. So setting the \c{NASMENV} variable to the
880 value \c{!-s!-ic:\\nasmlib} is equivalent to setting it to \c{-s
881 -ic:\\nasmlib}, but \c{!-dNAME="my name"} will work.
883 This environment variable was previously called \c{NASM}. This was
884 changed with version 0.98.31.
887 \H{qstart} \i{Quick Start} for \i{MASM} Users
889 If you're used to writing programs with MASM, or with \i{TASM} in
890 MASM-compatible (non-Ideal) mode, or with \i\c{a86}, this section
891 attempts to outline the major differences between MASM's syntax and
892 NASM's. If you're not already used to MASM, it's probably worth
893 skipping this section.
896 \S{qscs} NASM Is \I{case sensitivity}Case-Sensitive
898 One simple difference is that NASM is case-sensitive. It makes a
899 difference whether you call your label \c{foo}, \c{Foo} or \c{FOO}.
900 If you're assembling to \c{DOS} or \c{OS/2} \c{.OBJ} files, you can
901 invoke the \i\c{UPPERCASE} directive (documented in \k{objfmt}) to
902 ensure that all symbols exported to other code modules are forced
903 to be upper case; but even then, \e{within} a single module, NASM
904 will distinguish between labels differing only in case.
907 \S{qsbrackets} NASM Requires \i{Square Brackets} For \i{Memory References}
909 NASM was designed with simplicity of syntax in mind. One of the
910 \i{design goals} of NASM is that it should be possible, as far as is
911 practical, for the user to look at a single line of NASM code
912 and tell what opcode is generated by it. You can't do this in MASM:
913 if you declare, for example,
915 \c foo     equ     1
916 \c bar     dw      2
918 then the two lines of code
920 \c         mov     ax,foo
921 \c         mov     ax,bar
923 generate completely different opcodes, despite having
924 identical-looking syntaxes.
926 NASM avoids this undesirable situation by having a much simpler
927 syntax for memory references. The rule is simply that any access to
928 the \e{contents} of a memory location requires square brackets
929 around the address, and any access to the \e{address} of a variable
930 doesn't. So an instruction of the form \c{mov ax,foo} will
931 \e{always} refer to a compile-time constant, whether it's an \c{EQU}
932 or the address of a variable; and to access the \e{contents} of the
933 variable \c{bar}, you must code \c{mov ax,[bar]}.
935 This also means that NASM has no need for MASM's \i\c{OFFSET}
936 keyword, since the MASM code \c{mov ax,offset bar} means exactly the
937 same thing as NASM's \c{mov ax,bar}. If you're trying to get
938 large amounts of MASM code to assemble sensibly under NASM, you
939 can always code \c{%idefine offset} to make the preprocessor treat
940 the \c{OFFSET} keyword as a no-op.
942 This issue is even more confusing in \i\c{a86}, where declaring a
943 label with a trailing colon defines it to be a `label' as opposed to
944 a `variable' and causes \c{a86} to adopt NASM-style semantics; so in
945 \c{a86}, \c{mov ax,var} has different behaviour depending on whether
946 \c{var} was declared as \c{var: dw 0} (a label) or \c{var dw 0} (a
947 word-size variable). NASM is very simple by comparison:
948 \e{everything} is a label.
950 NASM, in the interests of simplicity, also does not support the
951 \i{hybrid syntaxes} supported by MASM and its clones, such as
952 \c{mov ax,table[bx]}, where a memory reference is denoted by one
953 portion outside square brackets and another portion inside. The
954 correct syntax for the above is \c{mov ax,[table+bx]}. Likewise,
955 \c{mov ax,es:[di]} is wrong and \c{mov ax,[es:di]} is right.
958 \S{qstypes} NASM Doesn't Store \i{Variable Types}
960 NASM, by design, chooses not to remember the types of variables you
961 declare. Whereas MASM will remember, on seeing \c{var dw 0}, that
962 you declared \c{var} as a word-size variable, and will then be able
963 to fill in the \i{ambiguity} in the size of the instruction \c{mov
964 var,2}, NASM will deliberately remember nothing about the symbol
965 \c{var} except where it begins, and so you must explicitly code
966 \c{mov word [var],2}.
968 For this reason, NASM doesn't support the \c{LODS}, \c{MOVS},
969 \c{STOS}, \c{SCAS}, \c{CMPS}, \c{INS}, or \c{OUTS} instructions,
970 but only supports the forms such as \c{LODSB}, \c{MOVSW}, and
971 \c{SCASD}, which explicitly specify the size of the components of
972 the strings being manipulated.
975 \S{qsassume} NASM Doesn't \i\c{ASSUME}
977 As part of NASM's drive for simplicity, it also does not support the
978 \c{ASSUME} directive. NASM will not keep track of what values you
979 choose to put in your segment registers, and will never
980 \e{automatically} generate a \i{segment override} prefix.
983 \S{qsmodel} NASM Doesn't Support \i{Memory Models}
985 NASM also does not have any directives to support different 16-bit
986 memory models. The programmer has to keep track of which functions
987 are supposed to be called with a \i{far call} and which with a
988 \i{near call}, and is responsible for putting the correct form of
989 \c{RET} instruction (\c{RETN} or \c{RETF}; NASM accepts \c{RET}
990 itself as an alternate form for \c{RETN}); in addition, the
991 programmer is responsible for coding CALL FAR instructions where
992 necessary when calling \e{external} functions, and must also keep
993 track of which external variable definitions are far and which are
994 near.
997 \S{qsfpu} \i{Floating-Point} Differences
999 NASM uses different names to refer to floating-point registers from
1000 MASM: where MASM would call them \c{ST(0)}, \c{ST(1)} and so on, and
1001 \i\c{a86} would call them simply \c{0}, \c{1} and so on, NASM
1002 chooses to call them \c{st0}, \c{st1} etc.
1004 As of version 0.96, NASM now treats the instructions with
1005 \i{`nowait'} forms in the same way as MASM-compatible assemblers.
1006 The idiosyncratic treatment employed by 0.95 and earlier was based
1007 on a misunderstanding by the authors.
1010 \S{qsother} Other Differences
1012 For historical reasons, NASM uses the keyword \i\c{TWORD} where MASM
1013 and compatible assemblers use \i\c{TBYTE}.
1015 NASM does not declare \i{uninitialized storage} in the same way as
1016 MASM: where a MASM programmer might use \c{stack db 64 dup (?)},
1017 NASM requires \c{stack resb 64}, intended to be read as `reserve 64
1018 bytes'. For a limited amount of compatibility, since NASM treats
1019 \c{?} as a valid character in symbol names, you can code \c{? equ 0}
1020 and then writing \c{dw ?} will at least do something vaguely useful.
1021 \I\c{RESB}\i\c{DUP} is still not a supported syntax, however.
1023 In addition to all of this, macros and directives work completely
1024 differently to MASM. See \k{preproc} and \k{directive} for further
1025 details.
1028 \C{lang} The NASM Language
1030 \H{syntax} Layout of a NASM Source Line
1032 Like most assemblers, each NASM source line contains (unless it
1033 is a macro, a preprocessor directive or an assembler directive: see
1034 \k{preproc} and \k{directive}) some combination of the four fields
1036 \c label:    instruction operands        ; comment
1038 As usual, most of these fields are optional; the presence or absence
1039 of any combination of a label, an instruction and a comment is allowed.
1040 Of course, the operand field is either required or forbidden by the
1041 presence and nature of the instruction field.
1043 NASM uses backslash (\\) as the line continuation character; if a line
1044 ends with backslash, the next line is considered to be a part of the
1045 backslash-ended line.
1047 NASM places no restrictions on white space within a line: labels may
1048 have white space before them, or instructions may have no space
1049 before them, or anything. The \i{colon} after a label is also
1050 optional. (Note that this means that if you intend to code \c{lodsb}
1051 alone on a line, and type \c{lodab} by accident, then that's still a
1052 valid source line which does nothing but define a label. Running
1053 NASM with the command-line option
1054 \I{orphan-labels}\c{-w+orphan-labels} will cause it to warn you if
1055 you define a label alone on a line without a \i{trailing colon}.)
1057 \i{Valid characters} in labels are letters, numbers, \c{_}, \c{$},
1058 \c{#}, \c{@}, \c{~}, \c{.}, and \c{?}. The only characters which may
1059 be used as the \e{first} character of an identifier are letters,
1060 \c{.} (with special meaning: see \k{locallab}), \c{_} and \c{?}.
1061 An identifier may also be prefixed with a \I{$, prefix}\c{$} to
1062 indicate that it is intended to be read as an identifier and not a
1063 reserved word; thus, if some other module you are linking with
1064 defines a symbol called \c{eax}, you can refer to \c{$eax} in NASM
1065 code to distinguish the symbol from the register. Maximum length of 
1066 an identifier is 4095 characters.
1068 The instruction field may contain any machine instruction: Pentium
1069 and P6 instructions, FPU instructions, MMX instructions and even
1070 undocumented instructions are all supported. The instruction may be
1071 prefixed by \c{LOCK}, \c{REP}, \c{REPE}/\c{REPZ} or
1072 \c{REPNE}/\c{REPNZ}, in the usual way. Explicit \I{address-size
1073 prefixes}address-size and \i{operand-size prefixes} \c{A16},
1074 \c{A32}, \c{O16} and \c{O32} are provided - one example of their use
1075 is given in \k{mixsize}. You can also use the name of a \I{segment
1076 override}segment register as an instruction prefix: coding
1077 \c{es mov [bx],ax} is equivalent to coding \c{mov [es:bx],ax}. We
1078 recommend the latter syntax, since it is consistent with other
1079 syntactic features of the language, but for instructions such as
1080 \c{LODSB}, which has no operands and yet can require a segment
1081 override, there is no clean syntactic way to proceed apart from
1082 \c{es lodsb}.
1084 An instruction is not required to use a prefix: prefixes such as
1085 \c{CS}, \c{A32}, \c{LOCK} or \c{REPE} can appear on a line by
1086 themselves, and NASM will just generate the prefix bytes.
1088 In addition to actual machine instructions, NASM also supports a
1089 number of pseudo-instructions, described in \k{pseudop}.
1091 Instruction \i{operands} may take a number of forms: they can be
1092 registers, described simply by the register name (e.g. \c{ax},
1093 \c{bp}, \c{ebx}, \c{cr0}: NASM does not use the \c{gas}-style
1094 syntax in which register names must be prefixed by a \c{%} sign), or
1095 they can be \i{effective addresses} (see \k{effaddr}), constants
1096 (\k{const}) or expressions (\k{expr}).
1098 For x87 \i{floating-point} instructions, NASM accepts a wide range of
1099 syntaxes: you can use two-operand forms like MASM supports, or you
1100 can use NASM's native single-operand forms in most cases.
1101 \# Details of
1102 \# all forms of each supported instruction are given in
1103 \# \k{iref}.
1104 For example, you can code:
1106 \c         fadd    st1             ; this sets st0 := st0 + st1
1107 \c         fadd    st0,st1         ; so does this
1109 \c         fadd    st1,st0         ; this sets st1 := st1 + st0
1110 \c         fadd    to st1          ; so does this
1112 Almost any x87 floating-point instruction that references memory must
1113 use one of the prefixes \i\c{DWORD}, \i\c{QWORD} or \i\c{TWORD} to
1114 indicate what size of \i{memory operand} it refers to.
1117 \H{pseudop} \i{Pseudo-Instructions}
1119 Pseudo-instructions are things which, though not real x86 machine
1120 instructions, are used in the instruction field anyway because that's
1121 the most convenient place to put them. The current pseudo-instructions
1122 are \i\c{DB}, \i\c{DW}, \i\c{DD}, \i\c{DQ}, \i\c{DT} and \i\c{DO};
1123 their \i{uninitialized} counterparts \i\c{RESB}, \i\c{RESW},
1124 \i\c{RESD}, \i\c{RESQ}, \i\c{REST} and \i\c{RESO}; the \i\c{INCBIN}
1125 command, the \i\c{EQU} command, and the \i\c{TIMES} prefix.
1128 \S{db} \c{DB} and friends: Declaring initialized Data
1130 \i\c{DB}, \i\c{DW}, \i\c{DD}, \i\c{DQ}, \i\c{DT} and \i\c{DO} are
1131 used, much as in MASM, to declare initialized data in the output
1132 file. They can be invoked in a wide range of ways:
1133 \I{floating-point}\I{character constant}\I{string constant}
1135 \c       db    0x55                ; just the byte 0x55
1136 \c       db    0x55,0x56,0x57      ; three bytes in succession
1137 \c       db    'a',0x55            ; character constants are OK
1138 \c       db    'hello',13,10,'$'   ; so are string constants
1139 \c       dw    0x1234              ; 0x34 0x12
1140 \c       dw    'a'                 ; 0x61 0x00 (it's just a number)
1141 \c       dw    'ab'                ; 0x61 0x62 (character constant)
1142 \c       dw    'abc'               ; 0x61 0x62 0x63 0x00 (string)
1143 \c       dd    0x12345678          ; 0x78 0x56 0x34 0x12
1144 \c       dd    1.234567e20         ; floating-point constant
1145 \c       dq    0x123456789abcdef0  ; eight byte constant
1146 \c       dq    1.234567e20         ; double-precision float
1147 \c       dt    1.234567e20         ; extended-precision float
1149 \c{DT} and \c{DO} do not accept \i{numeric constants} as operands.
1152 \S{resb} \c{RESB} and friends: Declaring \i{Uninitialized} Data
1154 \i\c{RESB}, \i\c{RESW}, \i\c{RESD}, \i\c{RESQ}, \i\c{REST} and
1155 \i\c{RESO} are designed to be used in the BSS section of a module:
1156 they declare \e{uninitialized} storage space. Each takes a single
1157 operand, which is the number of bytes, words, doublewords or whatever
1158 to reserve.  As stated in \k{qsother}, NASM does not support the
1159 MASM/TASM syntax of reserving uninitialized space by writing
1160 \I\c{?}\c{DW ?} or similar things: this is what it does instead. The
1161 operand to a \c{RESB}-type pseudo-instruction is a \i\e{critical
1162 expression}: see \k{crit}.
1164 For example:
1166 \c buffer:         resb    64              ; reserve 64 bytes
1167 \c wordvar:        resw    1               ; reserve a word
1168 \c realarray       resq    10              ; array of ten reals
1171 \S{incbin} \i\c{INCBIN}: Including External \i{Binary Files}
1173 \c{INCBIN} is borrowed from the old Amiga assembler \i{DevPac}: it
1174 includes a binary file verbatim into the output file. This can be
1175 handy for (for example) including \i{graphics} and \i{sound} data
1176 directly into a game executable file. It can be called in one of
1177 these three ways:
1179 \c     incbin  "file.dat"             ; include the whole file
1180 \c     incbin  "file.dat",1024        ; skip the first 1024 bytes
1181 \c     incbin  "file.dat",1024,512    ; skip the first 1024, and
1182 \c                                    ; actually include at most 512
1185 \S{equ} \i\c{EQU}: Defining Constants
1187 \c{EQU} defines a symbol to a given constant value: when \c{EQU} is
1188 used, the source line must contain a label. The action of \c{EQU} is
1189 to define the given label name to the value of its (only) operand.
1190 This definition is absolute, and cannot change later. So, for
1191 example,
1193 \c message         db      'hello, world'
1194 \c msglen          equ     $-message
1196 defines \c{msglen} to be the constant 12. \c{msglen} may not then be
1197 redefined later. This is not a \i{preprocessor} definition either:
1198 the value of \c{msglen} is evaluated \e{once}, using the value of
1199 \c{$} (see \k{expr} for an explanation of \c{$}) at the point of
1200 definition, rather than being evaluated wherever it is referenced
1201 and using the value of \c{$} at the point of reference. Note that
1202 the operand to an \c{EQU} is also a \i{critical expression}
1203 (\k{crit}).
1206 \S{times} \i\c{TIMES}: \i{Repeating} Instructions or Data
1208 The \c{TIMES} prefix causes the instruction to be assembled multiple
1209 times. This is partly present as NASM's equivalent of the \i\c{DUP}
1210 syntax supported by \i{MASM}-compatible assemblers, in that you can
1211 code
1213 \c zerobuf:        times 64 db 0
1215 or similar things; but \c{TIMES} is more versatile than that. The
1216 argument to \c{TIMES} is not just a numeric constant, but a numeric
1217 \e{expression}, so you can do things like
1219 \c buffer: db      'hello, world'
1220 \c         times 64-$+buffer db ' '
1222 which will store exactly enough spaces to make the total length of
1223 \c{buffer} up to 64. Finally, \c{TIMES} can be applied to ordinary
1224 instructions, so you can code trivial \i{unrolled loops} in it:
1226 \c         times 100 movsb
1228 Note that there is no effective difference between \c{times 100 resb
1229 1} and \c{resb 100}, except that the latter will be assembled about
1230 100 times faster due to the internal structure of the assembler.
1232 The operand to \c{TIMES}, like that of \c{EQU} and those of \c{RESB}
1233 and friends, is a critical expression (\k{crit}).
1235 Note also that \c{TIMES} can't be applied to \i{macros}: the reason
1236 for this is that \c{TIMES} is processed after the macro phase, which
1237 allows the argument to \c{TIMES} to contain expressions such as
1238 \c{64-$+buffer} as above. To repeat more than one line of code, or a
1239 complex macro, use the preprocessor \i\c{%rep} directive.
1242 \H{effaddr} Effective Addresses
1244 An \i{effective address} is any operand to an instruction which
1245 \I{memory reference}references memory. Effective addresses, in NASM,
1246 have a very simple syntax: they consist of an expression evaluating
1247 to the desired address, enclosed in \i{square brackets}. For
1248 example:
1250 \c wordvar dw      123
1251 \c         mov     ax,[wordvar]
1252 \c         mov     ax,[wordvar+1]
1253 \c         mov     ax,[es:wordvar+bx]
1255 Anything not conforming to this simple system is not a valid memory
1256 reference in NASM, for example \c{es:wordvar[bx]}.
1258 More complicated effective addresses, such as those involving more
1259 than one register, work in exactly the same way:
1261 \c         mov     eax,[ebx*2+ecx+offset]
1262 \c         mov     ax,[bp+di+8]
1264 NASM is capable of doing \i{algebra} on these effective addresses,
1265 so that things which don't necessarily \e{look} legal are perfectly
1266 all right:
1268 \c     mov     eax,[ebx*5]             ; assembles as [ebx*4+ebx]
1269 \c     mov     eax,[label1*2-label2]   ; ie [label1+(label1-label2)]
1271 Some forms of effective address have more than one assembled form;
1272 in most such cases NASM will generate the smallest form it can. For
1273 example, there are distinct assembled forms for the 32-bit effective
1274 addresses \c{[eax*2+0]} and \c{[eax+eax]}, and NASM will generally
1275 generate the latter on the grounds that the former requires four
1276 bytes to store a zero offset.
1278 NASM has a hinting mechanism which will cause \c{[eax+ebx]} and
1279 \c{[ebx+eax]} to generate different opcodes; this is occasionally
1280 useful because \c{[esi+ebp]} and \c{[ebp+esi]} have different
1281 default segment registers.
1283 However, you can force NASM to generate an effective address in a
1284 particular form by the use of the keywords \c{BYTE}, \c{WORD},
1285 \c{DWORD} and \c{NOSPLIT}. If you need \c{[eax+3]} to be assembled
1286 using a double-word offset field instead of the one byte NASM will
1287 normally generate, you can code \c{[dword eax+3]}. Similarly, you
1288 can force NASM to use a byte offset for a small value which it
1289 hasn't seen on the first pass (see \k{crit} for an example of such a
1290 code fragment) by using \c{[byte eax+offset]}. As special cases,
1291 \c{[byte eax]} will code \c{[eax+0]} with a byte offset of zero, and
1292 \c{[dword eax]} will code it with a double-word offset of zero. The
1293 normal form, \c{[eax]}, will be coded with no offset field.
1295 The form described in the previous paragraph is also useful if you
1296 are trying to access data in a 32-bit segment from within 16 bit code.
1297 For more information on this see the section on mixed-size addressing
1298 (\k{mixaddr}). In particular, if you need to access data with a known
1299 offset that is larger than will fit in a 16-bit value, if you don't
1300 specify that it is a dword offset, nasm will cause the high word of
1301 the offset to be lost.
1303 Similarly, NASM will split \c{[eax*2]} into \c{[eax+eax]} because
1304 that allows the offset field to be absent and space to be saved; in
1305 fact, it will also split \c{[eax*2+offset]} into
1306 \c{[eax+eax+offset]}. You can combat this behaviour by the use of
1307 the \c{NOSPLIT} keyword: \c{[nosplit eax*2]} will force
1308 \c{[eax*2+0]} to be generated literally.
1310 In 64-bit mode, NASM will by default generate absolute addresses.  The
1311 \i\c{REL} keyword makes it produce \c{RIP}-relative addresses. Since
1312 this is frequently the normally desired behaviour, see the \c{DEFAULT}
1313 directive (\k{default}). The keyword \i\c{ABS} overrides \i\c{REL}.
1316 \H{const} \i{Constants}
1318 NASM understands four different types of constant: numeric,
1319 character, string and floating-point.
1322 \S{numconst} \i{Numeric Constants}
1324 A numeric constant is simply a number. NASM allows you to specify
1325 numbers in a variety of number bases, in a variety of ways: you can
1326 suffix \c{H}, \c{Q} or \c{O}, and \c{B} for \i{hex}, \i{octal} and \i{binary},
1327 or you can prefix \c{0x} for hex in the style of C, or you can
1328 prefix \c{$} for hex in the style of Borland Pascal. Note, though,
1329 that the \I{$, prefix}\c{$} prefix does double duty as a prefix on
1330 identifiers (see \k{syntax}), so a hex number prefixed with a \c{$}
1331 sign must have a digit after the \c{$} rather than a letter.
1333 Some examples:
1335 \c         mov     ax,100          ; decimal
1336 \c         mov     ax,0a2h         ; hex
1337 \c         mov     ax,$0a2         ; hex again: the 0 is required
1338 \c         mov     ax,0xa2         ; hex yet again
1339 \c         mov     ax,777q         ; octal
1340 \c         mov     ax,777o         ; octal again
1341 \c         mov     ax,10010011b    ; binary
1344 \S{chrconst} \i{Character Constants}
1346 A character constant consists of up to four characters enclosed in
1347 either single or double quotes. The type of quote makes no
1348 difference to NASM, except of course that surrounding the constant
1349 with single quotes allows double quotes to appear within it and vice
1350 versa.
1352 A character constant with more than one character will be arranged
1353 with \i{little-endian} order in mind: if you code
1355 \c           mov eax,'abcd'
1357 then the constant generated is not \c{0x61626364}, but
1358 \c{0x64636261}, so that if you were then to store the value into
1359 memory, it would read \c{abcd} rather than \c{dcba}. This is also
1360 the sense of character constants understood by the Pentium's
1361 \i\c{CPUID} instruction.
1362 \# (see \k{insCPUID})
1365 \S{strconst} String Constants
1367 String constants are only acceptable to some pseudo-instructions,
1368 namely the \I\c{DW}\I\c{DD}\I\c{DQ}\I\c{DT}\i\c{DB} family and
1369 \i\c{INCBIN}.
1371 A string constant looks like a character constant, only longer. It
1372 is treated as a concatenation of maximum-size character constants
1373 for the conditions. So the following are equivalent:
1375 \c       db    'hello'               ; string constant
1376 \c       db    'h','e','l','l','o'   ; equivalent character constants
1378 And the following are also equivalent:
1380 \c       dd    'ninechars'           ; doubleword string constant
1381 \c       dd    'nine','char','s'     ; becomes three doublewords
1382 \c       db    'ninechars',0,0,0     ; and really looks like this
1384 Note that when used as an operand to \c{db}, a constant like
1385 \c{'ab'} is treated as a string constant despite being short enough
1386 to be a character constant, because otherwise \c{db 'ab'} would have
1387 the same effect as \c{db 'a'}, which would be silly. Similarly,
1388 three-character or four-character constants are treated as strings
1389 when they are operands to \c{dw}.
1392 \S{fltconst} \I{floating-point, constants}Floating-Point Constants
1394 \i{Floating-point} constants are acceptable only as arguments to
1395 \i\c{DB}, \i\c{DW}, \i\c{DD}, \i\c{DQ}, \i\c{DT}, and \i\c{DO}, or as
1396 arguments to the special operators \i\c{__float8__},
1397 \i\c{__float16__}, \i\c{__float32__}, \i\c{__float64__},
1398 \i\c{__float80m__}, \i\c{__float80e__}, \i\c{__float128l__}, and
1399 \i\c{__float128h__}.
1401 Floating-point constants are expressed in the traditional form:
1402 digits, then a period, then optionally more digits, then optionally an
1403 \c{E} followed by an exponent. The period is mandatory, so that NASM
1404 can distinguish between \c{dd 1}, which declares an integer constant,
1405 and \c{dd 1.0} which declares a floating-point constant.  NASM also
1406 support C99-style hexadecimal floating-point: \c{0x}, hexadecimal
1407 digits, period, optionally more hexadeximal digits, then optionally a
1408 \c{P} followed by a \e{binary} (not hexadecimal) exponent in decimal
1409 notation.
1411 Some examples:
1413 \c       db    -0.2                    ; "Quarter precision"
1414 \c       dw    -0.5                    ; IEEE 754r/SSE5 half precision
1415 \c       dd    1.2                     ; an easy one
1416 \c       dd    0x1p+2                  ; 1.0x2^2 = 4.0
1417 \c       dq    1.e10                   ; 10,000,000,000
1418 \c       dq    1.e+10                  ; synonymous with 1.e10
1419 \c       dq    1.e-10                  ; 0.000 000 000 1
1420 \c       dt    3.141592653589793238462 ; pi
1421 \c       do    1.e+4000                ; IEEE 754r quad precision
1423 The 8-bit "quarter-precision" floating-point format is
1424 sign:exponent:mantissa = 1:4:3 with an exponent bias of 7.  This
1425 appears to be the most frequently used 8-bit floating-point format,
1426 although it is not covered by any formal standard.  This is sometimes
1427 called a "\i{minifloat}."
1429 The special operators are used to produce floating-point numbers in
1430 other contexts.  They produce the binary representation of a specific
1431 floating-point number as an integer, and can use anywhere integer
1432 constants are used in an expression.  \c{__float80m__} and
1433 \c{__float80e__} produce the 64-bit mantissa and 16-bit exponent of an
1434 80-bit floating-point number, and \c{__float128l__} and
1435 \c{__float128h__} produce the lower and upper 64-bit halves of a 128-bit
1436 floating-point number, respectively.
1438 For example:
1440 \c       mov    rax,__float64__(3.141592653589793238462)
1442 ... would assign the binary representation of pi as a 64-bit floating
1443 point number into \c{RAX}.  This is exactly equivalent to:
1445 \c       mov    rax,0x400921fb54442d18
1447 NASM cannot do compile-time arithmetic on floating-point constants.
1448 This is because NASM is designed to be portable - although it always
1449 generates code to run on x86 processors, the assembler itself can
1450 run on any system with an ANSI C compiler. Therefore, the assembler
1451 cannot guarantee the presence of a floating-point unit capable of
1452 handling the \i{Intel number formats}, and so for NASM to be able to
1453 do floating arithmetic it would have to include its own complete set
1454 of floating-point routines, which would significantly increase the
1455 size of the assembler for very little benefit.
1457 The special tokens \i\c{__Infinity__}, \i\c{__QNaN__} (or
1458 \i\c{__NaN__}) and \i\c{__SNaN__} can be used to generate
1459 \I{infinity}infinities, quiet \i{NaN}s, and signalling NaNs,
1460 respectively.  These are normally used as macros:
1462 \c %define Inf __Infinity__
1463 \c %define NaN __QNaN__
1465 \c       dq    +1.5, -Inf, NaN         ; Double-precision constants
1467 \H{expr} \i{Expressions}
1469 Expressions in NASM are similar in syntax to those in C.  Expressions
1470 are evaluated as 64-bit integers which are then adjusted to the
1471 appropriate size.
1473 NASM supports two special tokens in expressions, allowing
1474 calculations to involve the current assembly position: the
1475 \I{$, here}\c{$} and \i\c{$$} tokens. \c{$} evaluates to the assembly
1476 position at the beginning of the line containing the expression; so
1477 you can code an \i{infinite loop} using \c{JMP $}. \c{$$} evaluates
1478 to the beginning of the current section; so you can tell how far
1479 into the section you are by using \c{($-$$)}.
1481 The arithmetic \i{operators} provided by NASM are listed here, in
1482 increasing order of \i{precedence}.
1485 \S{expor} \i\c{|}: \i{Bitwise OR} Operator
1487 The \c{|} operator gives a bitwise OR, exactly as performed by the
1488 \c{OR} machine instruction. Bitwise OR is the lowest-priority
1489 arithmetic operator supported by NASM.
1492 \S{expxor} \i\c{^}: \i{Bitwise XOR} Operator
1494 \c{^} provides the bitwise XOR operation.
1497 \S{expand} \i\c{&}: \i{Bitwise AND} Operator
1499 \c{&} provides the bitwise AND operation.
1502 \S{expshift} \i\c{<<} and \i\c{>>}: \i{Bit Shift} Operators
1504 \c{<<} gives a bit-shift to the left, just as it does in C. So \c{5<<3}
1505 evaluates to 5 times 8, or 40. \c{>>} gives a bit-shift to the
1506 right; in NASM, such a shift is \e{always} unsigned, so that
1507 the bits shifted in from the left-hand end are filled with zero
1508 rather than a sign-extension of the previous highest bit.
1511 \S{expplmi} \I{+ opaddition}\c{+} and \I{- opsubtraction}\c{-}:
1512 \i{Addition} and \i{Subtraction} Operators
1514 The \c{+} and \c{-} operators do perfectly ordinary addition and
1515 subtraction.
1518 \S{expmul} \i\c{*}, \i\c{/}, \i\c{//}, \i\c{%} and \i\c{%%}:
1519 \i{Multiplication} and \i{Division}
1521 \c{*} is the multiplication operator. \c{/} and \c{//} are both
1522 division operators: \c{/} is \i{unsigned division} and \c{//} is
1523 \i{signed division}. Similarly, \c{%} and \c{%%} provide \I{unsigned
1524 modulo}\I{modulo operators}unsigned and
1525 \i{signed modulo} operators respectively.
1527 NASM, like ANSI C, provides no guarantees about the sensible
1528 operation of the signed modulo operator.
1530 Since the \c{%} character is used extensively by the macro
1531 \i{preprocessor}, you should ensure that both the signed and unsigned
1532 modulo operators are followed by white space wherever they appear.
1535 \S{expmul} \i{Unary Operators}: \I{+ opunary}\c{+}, \I{- opunary}\c{-},
1536 \i\c{~}, \I{! opunary}\c{!} and \i\c{SEG}
1538 The highest-priority operators in NASM's expression grammar are
1539 those which only apply to one argument. \c{-} negates its operand,
1540 \c{+} does nothing (it's provided for symmetry with \c{-}), \c{~}
1541 computes the \i{one's complement} of its operand, \c{!} is the
1542 \i{logical negation} operator, and \c{SEG} provides the \i{segment address}
1543 of its operand (explained in more detail in \k{segwrt}).
1546 \H{segwrt} \i\c{SEG} and \i\c{WRT}
1548 When writing large 16-bit programs, which must be split into
1549 multiple \i{segments}, it is often necessary to be able to refer to
1550 the \I{segment address}segment part of the address of a symbol. NASM
1551 supports the \c{SEG} operator to perform this function.
1553 The \c{SEG} operator returns the \i\e{preferred} segment base of a
1554 symbol, defined as the segment base relative to which the offset of
1555 the symbol makes sense. So the code
1557 \c         mov     ax,seg symbol
1558 \c         mov     es,ax
1559 \c         mov     bx,symbol
1561 will load \c{ES:BX} with a valid pointer to the symbol \c{symbol}.
1563 Things can be more complex than this: since 16-bit segments and
1564 \i{groups} may \I{overlapping segments}overlap, you might occasionally
1565 want to refer to some symbol using a different segment base from the
1566 preferred one. NASM lets you do this, by the use of the \c{WRT}
1567 (With Reference To) keyword. So you can do things like
1569 \c         mov     ax,weird_seg        ; weird_seg is a segment base
1570 \c         mov     es,ax
1571 \c         mov     bx,symbol wrt weird_seg
1573 to load \c{ES:BX} with a different, but functionally equivalent,
1574 pointer to the symbol \c{symbol}.
1576 NASM supports far (inter-segment) calls and jumps by means of the
1577 syntax \c{call segment:offset}, where \c{segment} and \c{offset}
1578 both represent immediate values. So to call a far procedure, you
1579 could code either of
1581 \c         call    (seg procedure):procedure
1582 \c         call    weird_seg:(procedure wrt weird_seg)
1584 (The parentheses are included for clarity, to show the intended
1585 parsing of the above instructions. They are not necessary in
1586 practice.)
1588 NASM supports the syntax \I\c{CALL FAR}\c{call far procedure} as a
1589 synonym for the first of the above usages. \c{JMP} works identically
1590 to \c{CALL} in these examples.
1592 To declare a \i{far pointer} to a data item in a data segment, you
1593 must code
1595 \c         dw      symbol, seg symbol
1597 NASM supports no convenient synonym for this, though you can always
1598 invent one using the macro processor.
1601 \H{strict} \i\c{STRICT}: Inhibiting Optimization
1603 When assembling with the optimizer set to level 2 or higher (see
1604 \k{opt-On}), NASM will use size specifiers (\c{BYTE}, \c{WORD},
1605 \c{DWORD}, \c{QWORD}, \c{TWORD} or \c{OWORD}), but will give them the
1606 smallest possible size. The keyword \c{STRICT} can be used to inhibit
1607 optimization and force a particular operand to be emitted in the
1608 specified size. For example, with the optimizer on, and in \c{BITS 16}
1609 mode,
1611 \c         push dword 33
1613 is encoded in three bytes \c{66 6A 21}, whereas
1615 \c         push strict dword 33
1617 is encoded in six bytes, with a full dword immediate operand \c{66 68
1618 21 00 00 00}.
1620 With the optimizer off, the same code (six bytes) is generated whether
1621 the \c{STRICT} keyword was used or not.
1624 \H{crit} \i{Critical Expressions}
1626 Although NASM has an optional multi-pass optimizer, there are some
1627 expressions which must be resolvable on the first pass. These are
1628 called \e{Critical Expressions}.
1630 The first pass is used to determine the size of all the assembled
1631 code and data, so that the second pass, when generating all the
1632 code, knows all the symbol addresses the code refers to. So one
1633 thing NASM can't handle is code whose size depends on the value of a
1634 symbol declared after the code in question. For example,
1636 \c         times (label-$) db 0
1637 \c label:  db      'Where am I?'
1639 The argument to \i\c{TIMES} in this case could equally legally
1640 evaluate to anything at all; NASM will reject this example because
1641 it cannot tell the size of the \c{TIMES} line when it first sees it.
1642 It will just as firmly reject the slightly \I{paradox}paradoxical
1643 code
1645 \c         times (label-$+1) db 0
1646 \c label:  db      'NOW where am I?'
1648 in which \e{any} value for the \c{TIMES} argument is by definition
1649 wrong!
1651 NASM rejects these examples by means of a concept called a
1652 \e{critical expression}, which is defined to be an expression whose
1653 value is required to be computable in the first pass, and which must
1654 therefore depend only on symbols defined before it. The argument to
1655 the \c{TIMES} prefix is a critical expression; for the same reason,
1656 the arguments to the \i\c{RESB} family of pseudo-instructions are
1657 also critical expressions.
1659 Critical expressions can crop up in other contexts as well: consider
1660 the following code.
1662 \c                 mov     ax,symbol1
1663 \c symbol1         equ     symbol2
1664 \c symbol2:
1666 On the first pass, NASM cannot determine the value of \c{symbol1},
1667 because \c{symbol1} is defined to be equal to \c{symbol2} which NASM
1668 hasn't seen yet. On the second pass, therefore, when it encounters
1669 the line \c{mov ax,symbol1}, it is unable to generate the code for
1670 it because it still doesn't know the value of \c{symbol1}. On the
1671 next line, it would see the \i\c{EQU} again and be able to determine
1672 the value of \c{symbol1}, but by then it would be too late.
1674 NASM avoids this problem by defining the right-hand side of an
1675 \c{EQU} statement to be a critical expression, so the definition of
1676 \c{symbol1} would be rejected in the first pass.
1678 There is a related issue involving \i{forward references}: consider
1679 this code fragment.
1681 \c         mov     eax,[ebx+offset]
1682 \c offset  equ     10
1684 NASM, on pass one, must calculate the size of the instruction \c{mov
1685 eax,[ebx+offset]} without knowing the value of \c{offset}. It has no
1686 way of knowing that \c{offset} is small enough to fit into a
1687 one-byte offset field and that it could therefore get away with
1688 generating a shorter form of the \i{effective-address} encoding; for
1689 all it knows, in pass one, \c{offset} could be a symbol in the code
1690 segment, and it might need the full four-byte form. So it is forced
1691 to compute the size of the instruction to accommodate a four-byte
1692 address part. In pass two, having made this decision, it is now
1693 forced to honour it and keep the instruction large, so the code
1694 generated in this case is not as small as it could have been. This
1695 problem can be solved by defining \c{offset} before using it, or by
1696 forcing byte size in the effective address by coding \c{[byte
1697 ebx+offset]}.
1699 Note that use of the \c{-On} switch (with n>=2) makes some of the above
1700 no longer true (see \k{opt-On}).
1702 \H{locallab} \i{Local Labels}
1704 NASM gives special treatment to symbols beginning with a \i{period}.
1705 A label beginning with a single period is treated as a \e{local}
1706 label, which means that it is associated with the previous non-local
1707 label. So, for example:
1709 \c label1  ; some code
1711 \c .loop
1712 \c         ; some more code
1714 \c         jne     .loop
1715 \c         ret
1717 \c label2  ; some code
1719 \c .loop
1720 \c         ; some more code
1722 \c         jne     .loop
1723 \c         ret
1725 In the above code fragment, each \c{JNE} instruction jumps to the
1726 line immediately before it, because the two definitions of \c{.loop}
1727 are kept separate by virtue of each being associated with the
1728 previous non-local label.
1730 This form of local label handling is borrowed from the old Amiga
1731 assembler \i{DevPac}; however, NASM goes one step further, in
1732 allowing access to local labels from other parts of the code. This
1733 is achieved by means of \e{defining} a local label in terms of the
1734 previous non-local label: the first definition of \c{.loop} above is
1735 really defining a symbol called \c{label1.loop}, and the second
1736 defines a symbol called \c{label2.loop}. So, if you really needed
1737 to, you could write
1739 \c label3  ; some more code
1740 \c         ; and some more
1742 \c         jmp label1.loop
1744 Sometimes it is useful - in a macro, for instance - to be able to
1745 define a label which can be referenced from anywhere but which
1746 doesn't interfere with the normal local-label mechanism. Such a
1747 label can't be non-local because it would interfere with subsequent
1748 definitions of, and references to, local labels; and it can't be
1749 local because the macro that defined it wouldn't know the label's
1750 full name. NASM therefore introduces a third type of label, which is
1751 probably only useful in macro definitions: if a label begins with
1752 the \I{label prefix}special prefix \i\c{..@}, then it does nothing
1753 to the local label mechanism. So you could code
1755 \c label1:                         ; a non-local label
1756 \c .local:                         ; this is really label1.local
1757 \c ..@foo:                         ; this is a special symbol
1758 \c label2:                         ; another non-local label
1759 \c .local:                         ; this is really label2.local
1761 \c         jmp     ..@foo          ; this will jump three lines up
1763 NASM has the capacity to define other special symbols beginning with
1764 a double period: for example, \c{..start} is used to specify the
1765 entry point in the \c{obj} output format (see \k{dotdotstart}).
1768 \C{preproc} The NASM \i{Preprocessor}
1770 NASM contains a powerful \i{macro processor}, which supports
1771 conditional assembly, multi-level file inclusion, two forms of macro
1772 (single-line and multi-line), and a `context stack' mechanism for
1773 extra macro power. Preprocessor directives all begin with a \c{%}
1774 sign.
1776 The preprocessor collapses all lines which end with a backslash (\\)
1777 character into a single line.  Thus:
1779 \c %define THIS_VERY_LONG_MACRO_NAME_IS_DEFINED_TO \\
1780 \c         THIS_VALUE
1782 will work like a single-line macro without the backslash-newline
1783 sequence.
1785 \H{slmacro} \i{Single-Line Macros}
1787 \S{define} The Normal Way: \I\c{%idefine}\i\c{%define}
1789 Single-line macros are defined using the \c{%define} preprocessor
1790 directive. The definitions work in a similar way to C; so you can do
1791 things like
1793 \c %define ctrl    0x1F &
1794 \c %define param(a,b) ((a)+(a)*(b))
1796 \c         mov     byte [param(2,ebx)], ctrl 'D'
1798 which will expand to
1800 \c         mov     byte [(2)+(2)*(ebx)], 0x1F & 'D'
1802 When the expansion of a single-line macro contains tokens which
1803 invoke another macro, the expansion is performed at invocation time,
1804 not at definition time. Thus the code
1806 \c %define a(x)    1+b(x)
1807 \c %define b(x)    2*x
1809 \c         mov     ax,a(8)
1811 will evaluate in the expected way to \c{mov ax,1+2*8}, even though
1812 the macro \c{b} wasn't defined at the time of definition of \c{a}.
1814 Macros defined with \c{%define} are \i{case sensitive}: after
1815 \c{%define foo bar}, only \c{foo} will expand to \c{bar}: \c{Foo} or
1816 \c{FOO} will not. By using \c{%idefine} instead of \c{%define} (the
1817 `i' stands for `insensitive') you can define all the case variants
1818 of a macro at once, so that \c{%idefine foo bar} would cause
1819 \c{foo}, \c{Foo}, \c{FOO}, \c{fOO} and so on all to expand to
1820 \c{bar}.
1822 There is a mechanism which detects when a macro call has occurred as
1823 a result of a previous expansion of the same macro, to guard against
1824 \i{circular references} and infinite loops. If this happens, the
1825 preprocessor will only expand the first occurrence of the macro.
1826 Hence, if you code
1828 \c %define a(x)    1+a(x)
1830 \c         mov     ax,a(3)
1832 the macro \c{a(3)} will expand once, becoming \c{1+a(3)}, and will
1833 then expand no further. This behaviour can be useful: see \k{32c}
1834 for an example of its use.
1836 You can \I{overloading, single-line macros}overload single-line
1837 macros: if you write
1839 \c %define foo(x)   1+x
1840 \c %define foo(x,y) 1+x*y
1842 the preprocessor will be able to handle both types of macro call,
1843 by counting the parameters you pass; so \c{foo(3)} will become
1844 \c{1+3} whereas \c{foo(ebx,2)} will become \c{1+ebx*2}. However, if
1845 you define
1847 \c %define foo bar
1849 then no other definition of \c{foo} will be accepted: a macro with
1850 no parameters prohibits the definition of the same name as a macro
1851 \e{with} parameters, and vice versa.
1853 This doesn't prevent single-line macros being \e{redefined}: you can
1854 perfectly well define a macro with
1856 \c %define foo bar
1858 and then re-define it later in the same source file with
1860 \c %define foo baz
1862 Then everywhere the macro \c{foo} is invoked, it will be expanded
1863 according to the most recent definition. This is particularly useful
1864 when defining single-line macros with \c{%assign} (see \k{assign}).
1866 You can \i{pre-define} single-line macros using the `-d' option on
1867 the NASM command line: see \k{opt-d}.
1870 \S{xdefine} Enhancing %define: \I\c{%xidefine}\i\c{%xdefine}
1872 To have a reference to an embedded single-line macro resolved at the
1873 time that it is embedded, as opposed to when the calling macro is
1874 expanded, you need a different mechanism to the one offered by
1875 \c{%define}. The solution is to use \c{%xdefine}, or it's
1876 \I{case sensitive}case-insensitive counterpart \c{%xidefine}.
1878 Suppose you have the following code:
1880 \c %define  isTrue  1
1881 \c %define  isFalse isTrue
1882 \c %define  isTrue  0
1884 \c val1:    db      isFalse
1886 \c %define  isTrue  1
1888 \c val2:    db      isFalse
1890 In this case, \c{val1} is equal to 0, and \c{val2} is equal to 1.
1891 This is because, when a single-line macro is defined using
1892 \c{%define}, it is expanded only when it is called. As \c{isFalse}
1893 expands to \c{isTrue}, the expansion will be the current value of
1894 \c{isTrue}. The first time it is called that is 0, and the second
1895 time it is 1.
1897 If you wanted \c{isFalse} to expand to the value assigned to the
1898 embedded macro \c{isTrue} at the time that \c{isFalse} was defined,
1899 you need to change the above code to use \c{%xdefine}.
1901 \c %xdefine isTrue  1
1902 \c %xdefine isFalse isTrue
1903 \c %xdefine isTrue  0
1905 \c val1:    db      isFalse
1907 \c %xdefine isTrue  1
1909 \c val2:    db      isFalse
1911 Now, each time that \c{isFalse} is called, it expands to 1,
1912 as that is what the embedded macro \c{isTrue} expanded to at
1913 the time that \c{isFalse} was defined.
1916 \S{concat%+} Concatenating Single Line Macro Tokens: \i\c{%+}
1918 Individual tokens in single line macros can be concatenated, to produce
1919 longer tokens for later processing. This can be useful if there are
1920 several similar macros that perform similar functions.
1922 Please note that a space is required after \c{%+}, in order to
1923 disambiguate it from the syntax \c{%+1} used in multiline macros.
1925 As an example, consider the following:
1927 \c %define BDASTART 400h                ; Start of BIOS data area
1929 \c struc   tBIOSDA                      ; its structure
1930 \c         .COM1addr       RESW    1
1931 \c         .COM2addr       RESW    1
1932 \c         ; ..and so on
1933 \c endstruc
1935 Now, if we need to access the elements of tBIOSDA in different places,
1936 we can end up with:
1938 \c         mov     ax,BDASTART + tBIOSDA.COM1addr
1939 \c         mov     bx,BDASTART + tBIOSDA.COM2addr
1941 This will become pretty ugly (and tedious) if used in many places, and
1942 can be reduced in size significantly by using the following macro:
1944 \c ; Macro to access BIOS variables by their names (from tBDA):
1946 \c %define BDA(x)  BDASTART + tBIOSDA. %+ x
1948 Now the above code can be written as:
1950 \c         mov     ax,BDA(COM1addr)
1951 \c         mov     bx,BDA(COM2addr)
1953 Using this feature, we can simplify references to a lot of macros (and,
1954 in turn, reduce typing errors).
1957 \S{undef} Undefining macros: \i\c{%undef}
1959 Single-line macros can be removed with the \c{%undef} command.  For
1960 example, the following sequence:
1962 \c %define foo bar
1963 \c %undef  foo
1965 \c         mov     eax, foo
1967 will expand to the instruction \c{mov eax, foo}, since after
1968 \c{%undef} the macro \c{foo} is no longer defined.
1970 Macros that would otherwise be pre-defined can be undefined on the
1971 command-line using the `-u' option on the NASM command line: see
1972 \k{opt-u}.
1975 \S{assign} \i{Preprocessor Variables}: \i\c{%assign}
1977 An alternative way to define single-line macros is by means of the
1978 \c{%assign} command (and its \I{case sensitive}case-insensitive
1979 counterpart \i\c{%iassign}, which differs from \c{%assign} in
1980 exactly the same way that \c{%idefine} differs from \c{%define}).
1982 \c{%assign} is used to define single-line macros which take no
1983 parameters and have a numeric value. This value can be specified in
1984 the form of an expression, and it will be evaluated once, when the
1985 \c{%assign} directive is processed.
1987 Like \c{%define}, macros defined using \c{%assign} can be re-defined
1988 later, so you can do things like
1990 \c %assign i i+1
1992 to increment the numeric value of a macro.
1994 \c{%assign} is useful for controlling the termination of \c{%rep}
1995 preprocessor loops: see \k{rep} for an example of this. Another
1996 use for \c{%assign} is given in \k{16c} and \k{32c}.
1998 The expression passed to \c{%assign} is a \i{critical expression}
1999 (see \k{crit}), and must also evaluate to a pure number (rather than
2000 a relocatable reference such as a code or data address, or anything
2001 involving a register).
2004 \H{strlen} \i{String Handling in Macros}: \i\c{%strlen} and \i\c{%substr}
2006 It's often useful to be able to handle strings in macros. NASM
2007 supports two simple string handling macro operators from which
2008 more complex operations can be constructed.
2011 \S{strlen} \i{String Length}: \i\c{%strlen}
2013 The \c{%strlen} macro is like \c{%assign} macro in that it creates
2014 (or redefines) a numeric value to a macro. The difference is that
2015 with \c{%strlen}, the numeric value is the length of a string. An
2016 example of the use of this would be:
2018 \c %strlen charcnt 'my string'
2020 In this example, \c{charcnt} would receive the value 8, just as
2021 if an \c{%assign} had been used. In this example, \c{'my string'}
2022 was a literal string but it could also have been a single-line
2023 macro that expands to a string, as in the following example:
2025 \c %define sometext 'my string'
2026 \c %strlen charcnt sometext
2028 As in the first case, this would result in \c{charcnt} being
2029 assigned the value of 8.
2032 \S{substr} \i{Sub-strings}: \i\c{%substr}
2034 Individual letters in strings can be extracted using \c{%substr}.
2035 An example of its use is probably more useful than the description:
2037 \c %substr mychar  'xyz' 1         ; equivalent to %define mychar 'x'
2038 \c %substr mychar  'xyz' 2         ; equivalent to %define mychar 'y'
2039 \c %substr mychar  'xyz' 3         ; equivalent to %define mychar 'z'
2041 In this example, mychar gets the value of 'y'. As with \c{%strlen}
2042 (see \k{strlen}), the first parameter is the single-line macro to
2043 be created and the second is the string. The third parameter
2044 specifies which character is to be selected. Note that the first
2045 index is 1, not 0 and the last index is equal to the value that
2046 \c{%strlen} would assign given the same string. Index values out
2047 of range result in an empty string.
2050 \H{mlmacro} \i{Multi-Line Macros}: \I\c{%imacro}\i\c{%macro}
2052 Multi-line macros are much more like the type of macro seen in MASM
2053 and TASM: a multi-line macro definition in NASM looks something like
2054 this.
2056 \c %macro  prologue 1
2058 \c         push    ebp
2059 \c         mov     ebp,esp
2060 \c         sub     esp,%1
2062 \c %endmacro
2064 This defines a C-like function prologue as a macro: so you would
2065 invoke the macro with a call such as
2067 \c myfunc:   prologue 12
2069 which would expand to the three lines of code
2071 \c myfunc: push    ebp
2072 \c         mov     ebp,esp
2073 \c         sub     esp,12
2075 The number \c{1} after the macro name in the \c{%macro} line defines
2076 the number of parameters the macro \c{prologue} expects to receive.
2077 The use of \c{%1} inside the macro definition refers to the first
2078 parameter to the macro call. With a macro taking more than one
2079 parameter, subsequent parameters would be referred to as \c{%2},
2080 \c{%3} and so on.
2082 Multi-line macros, like single-line macros, are \i{case-sensitive},
2083 unless you define them using the alternative directive \c{%imacro}.
2085 If you need to pass a comma as \e{part} of a parameter to a
2086 multi-line macro, you can do that by enclosing the entire parameter
2087 in \I{braces, around macro parameters}braces. So you could code
2088 things like
2090 \c %macro  silly 2
2092 \c     %2: db      %1
2094 \c %endmacro
2096 \c         silly 'a', letter_a             ; letter_a:  db 'a'
2097 \c         silly 'ab', string_ab           ; string_ab: db 'ab'
2098 \c         silly {13,10}, crlf             ; crlf:      db 13,10
2101 \S{mlmacover} Overloading Multi-Line Macros\I{overloading, multi-line macros}
2103 As with single-line macros, multi-line macros can be overloaded by
2104 defining the same macro name several times with different numbers of
2105 parameters. This time, no exception is made for macros with no
2106 parameters at all. So you could define
2108 \c %macro  prologue 0
2110 \c         push    ebp
2111 \c         mov     ebp,esp
2113 \c %endmacro
2115 to define an alternative form of the function prologue which
2116 allocates no local stack space.
2118 Sometimes, however, you might want to `overload' a machine
2119 instruction; for example, you might want to define
2121 \c %macro  push 2
2123 \c         push    %1
2124 \c         push    %2
2126 \c %endmacro
2128 so that you could code
2130 \c         push    ebx             ; this line is not a macro call
2131 \c         push    eax,ecx         ; but this one is
2133 Ordinarily, NASM will give a warning for the first of the above two
2134 lines, since \c{push} is now defined to be a macro, and is being
2135 invoked with a number of parameters for which no definition has been
2136 given. The correct code will still be generated, but the assembler
2137 will give a warning. This warning can be disabled by the use of the
2138 \c{-w-macro-params} command-line option (see \k{opt-w}).
2141 \S{maclocal} \i{Macro-Local Labels}
2143 NASM allows you to define labels within a multi-line macro
2144 definition in such a way as to make them local to the macro call: so
2145 calling the same macro multiple times will use a different label
2146 each time. You do this by prefixing \i\c{%%} to the label name. So
2147 you can invent an instruction which executes a \c{RET} if the \c{Z}
2148 flag is set by doing this:
2150 \c %macro  retz 0
2152 \c         jnz     %%skip
2153 \c         ret
2154 \c     %%skip:
2156 \c %endmacro
2158 You can call this macro as many times as you want, and every time
2159 you call it NASM will make up a different `real' name to substitute
2160 for the label \c{%%skip}. The names NASM invents are of the form
2161 \c{..@2345.skip}, where the number 2345 changes with every macro
2162 call. The \i\c{..@} prefix prevents macro-local labels from
2163 interfering with the local label mechanism, as described in
2164 \k{locallab}. You should avoid defining your own labels in this form
2165 (the \c{..@} prefix, then a number, then another period) in case
2166 they interfere with macro-local labels.
2169 \S{mlmacgre} \i{Greedy Macro Parameters}
2171 Occasionally it is useful to define a macro which lumps its entire
2172 command line into one parameter definition, possibly after
2173 extracting one or two smaller parameters from the front. An example
2174 might be a macro to write a text string to a file in MS-DOS, where
2175 you might want to be able to write
2177 \c         writefile [filehandle],"hello, world",13,10
2179 NASM allows you to define the last parameter of a macro to be
2180 \e{greedy}, meaning that if you invoke the macro with more
2181 parameters than it expects, all the spare parameters get lumped into
2182 the last defined one along with the separating commas. So if you
2183 code:
2185 \c %macro  writefile 2+
2187 \c         jmp     %%endstr
2188 \c   %%str:        db      %2
2189 \c   %%endstr:
2190 \c         mov     dx,%%str
2191 \c         mov     cx,%%endstr-%%str
2192 \c         mov     bx,%1
2193 \c         mov     ah,0x40
2194 \c         int     0x21
2196 \c %endmacro
2198 then the example call to \c{writefile} above will work as expected:
2199 the text before the first comma, \c{[filehandle]}, is used as the
2200 first macro parameter and expanded when \c{%1} is referred to, and
2201 all the subsequent text is lumped into \c{%2} and placed after the
2202 \c{db}.
2204 The greedy nature of the macro is indicated to NASM by the use of
2205 the \I{+ modifier}\c{+} sign after the parameter count on the
2206 \c{%macro} line.
2208 If you define a greedy macro, you are effectively telling NASM how
2209 it should expand the macro given \e{any} number of parameters from
2210 the actual number specified up to infinity; in this case, for
2211 example, NASM now knows what to do when it sees a call to
2212 \c{writefile} with 2, 3, 4 or more parameters. NASM will take this
2213 into account when overloading macros, and will not allow you to
2214 define another form of \c{writefile} taking 4 parameters (for
2215 example).
2217 Of course, the above macro could have been implemented as a
2218 non-greedy macro, in which case the call to it would have had to
2219 look like
2221 \c           writefile [filehandle], {"hello, world",13,10}
2223 NASM provides both mechanisms for putting \i{commas in macro
2224 parameters}, and you choose which one you prefer for each macro
2225 definition.
2227 See \k{sectmac} for a better way to write the above macro.
2230 \S{mlmacdef} \i{Default Macro Parameters}
2232 NASM also allows you to define a multi-line macro with a \e{range}
2233 of allowable parameter counts. If you do this, you can specify
2234 defaults for \i{omitted parameters}. So, for example:
2236 \c %macro  die 0-1 "Painful program death has occurred."
2238 \c         writefile 2,%1
2239 \c         mov     ax,0x4c01
2240 \c         int     0x21
2242 \c %endmacro
2244 This macro (which makes use of the \c{writefile} macro defined in
2245 \k{mlmacgre}) can be called with an explicit error message, which it
2246 will display on the error output stream before exiting, or it can be
2247 called with no parameters, in which case it will use the default
2248 error message supplied in the macro definition.
2250 In general, you supply a minimum and maximum number of parameters
2251 for a macro of this type; the minimum number of parameters are then
2252 required in the macro call, and then you provide defaults for the
2253 optional ones. So if a macro definition began with the line
2255 \c %macro foobar 1-3 eax,[ebx+2]
2257 then it could be called with between one and three parameters, and
2258 \c{%1} would always be taken from the macro call. \c{%2}, if not
2259 specified by the macro call, would default to \c{eax}, and \c{%3} if
2260 not specified would default to \c{[ebx+2]}.
2262 You may omit parameter defaults from the macro definition, in which
2263 case the parameter default is taken to be blank. This can be useful
2264 for macros which can take a variable number of parameters, since the
2265 \i\c{%0} token (see \k{percent0}) allows you to determine how many
2266 parameters were really passed to the macro call.
2268 This defaulting mechanism can be combined with the greedy-parameter
2269 mechanism; so the \c{die} macro above could be made more powerful,
2270 and more useful, by changing the first line of the definition to
2272 \c %macro die 0-1+ "Painful program death has occurred.",13,10
2274 The maximum parameter count can be infinite, denoted by \c{*}. In
2275 this case, of course, it is impossible to provide a \e{full} set of
2276 default parameters. Examples of this usage are shown in \k{rotate}.
2279 \S{percent0} \i\c{%0}: \I{counting macro parameters}Macro Parameter Counter
2281 For a macro which can take a variable number of parameters, the
2282 parameter reference \c{%0} will return a numeric constant giving the
2283 number of parameters passed to the macro. This can be used as an
2284 argument to \c{%rep} (see \k{rep}) in order to iterate through all
2285 the parameters of a macro. Examples are given in \k{rotate}.
2288 \S{rotate} \i\c{%rotate}: \i{Rotating Macro Parameters}
2290 Unix shell programmers will be familiar with the \I{shift
2291 command}\c{shift} shell command, which allows the arguments passed
2292 to a shell script (referenced as \c{$1}, \c{$2} and so on) to be
2293 moved left by one place, so that the argument previously referenced
2294 as \c{$2} becomes available as \c{$1}, and the argument previously
2295 referenced as \c{$1} is no longer available at all.
2297 NASM provides a similar mechanism, in the form of \c{%rotate}. As
2298 its name suggests, it differs from the Unix \c{shift} in that no
2299 parameters are lost: parameters rotated off the left end of the
2300 argument list reappear on the right, and vice versa.
2302 \c{%rotate} is invoked with a single numeric argument (which may be
2303 an expression). The macro parameters are rotated to the left by that
2304 many places. If the argument to \c{%rotate} is negative, the macro
2305 parameters are rotated to the right.
2307 \I{iterating over macro parameters}So a pair of macros to save and
2308 restore a set of registers might work as follows:
2310 \c %macro  multipush 1-*
2312 \c   %rep  %0
2313 \c         push    %1
2314 \c   %rotate 1
2315 \c   %endrep
2317 \c %endmacro
2319 This macro invokes the \c{PUSH} instruction on each of its arguments
2320 in turn, from left to right. It begins by pushing its first
2321 argument, \c{%1}, then invokes \c{%rotate} to move all the arguments
2322 one place to the left, so that the original second argument is now
2323 available as \c{%1}. Repeating this procedure as many times as there
2324 were arguments (achieved by supplying \c{%0} as the argument to
2325 \c{%rep}) causes each argument in turn to be pushed.
2327 Note also the use of \c{*} as the maximum parameter count,
2328 indicating that there is no upper limit on the number of parameters
2329 you may supply to the \i\c{multipush} macro.
2331 It would be convenient, when using this macro, to have a \c{POP}
2332 equivalent, which \e{didn't} require the arguments to be given in
2333 reverse order. Ideally, you would write the \c{multipush} macro
2334 call, then cut-and-paste the line to where the pop needed to be
2335 done, and change the name of the called macro to \c{multipop}, and
2336 the macro would take care of popping the registers in the opposite
2337 order from the one in which they were pushed.
2339 This can be done by the following definition:
2341 \c %macro  multipop 1-*
2343 \c   %rep %0
2344 \c   %rotate -1
2345 \c         pop     %1
2346 \c   %endrep
2348 \c %endmacro
2350 This macro begins by rotating its arguments one place to the
2351 \e{right}, so that the original \e{last} argument appears as \c{%1}.
2352 This is then popped, and the arguments are rotated right again, so
2353 the second-to-last argument becomes \c{%1}. Thus the arguments are
2354 iterated through in reverse order.
2357 \S{concat} \i{Concatenating Macro Parameters}
2359 NASM can concatenate macro parameters on to other text surrounding
2360 them. This allows you to declare a family of symbols, for example,
2361 in a macro definition. If, for example, you wanted to generate a
2362 table of key codes along with offsets into the table, you could code
2363 something like
2365 \c %macro keytab_entry 2
2367 \c     keypos%1    equ     $-keytab
2368 \c                 db      %2
2370 \c %endmacro
2372 \c keytab:
2373 \c           keytab_entry F1,128+1
2374 \c           keytab_entry F2,128+2
2375 \c           keytab_entry Return,13
2377 which would expand to
2379 \c keytab:
2380 \c keyposF1        equ     $-keytab
2381 \c                 db     128+1
2382 \c keyposF2        equ     $-keytab
2383 \c                 db      128+2
2384 \c keyposReturn    equ     $-keytab
2385 \c                 db      13
2387 You can just as easily concatenate text on to the other end of a
2388 macro parameter, by writing \c{%1foo}.
2390 If you need to append a \e{digit} to a macro parameter, for example
2391 defining labels \c{foo1} and \c{foo2} when passed the parameter
2392 \c{foo}, you can't code \c{%11} because that would be taken as the
2393 eleventh macro parameter. Instead, you must code
2394 \I{braces, after % sign}\c{%\{1\}1}, which will separate the first
2395 \c{1} (giving the number of the macro parameter) from the second
2396 (literal text to be concatenated to the parameter).
2398 This concatenation can also be applied to other preprocessor in-line
2399 objects, such as macro-local labels (\k{maclocal}) and context-local
2400 labels (\k{ctxlocal}). In all cases, ambiguities in syntax can be
2401 resolved by enclosing everything after the \c{%} sign and before the
2402 literal text in braces: so \c{%\{%foo\}bar} concatenates the text
2403 \c{bar} to the end of the real name of the macro-local label
2404 \c{%%foo}. (This is unnecessary, since the form NASM uses for the
2405 real names of macro-local labels means that the two usages
2406 \c{%\{%foo\}bar} and \c{%%foobar} would both expand to the same
2407 thing anyway; nevertheless, the capability is there.)
2410 \S{mlmaccc} \i{Condition Codes as Macro Parameters}
2412 NASM can give special treatment to a macro parameter which contains
2413 a condition code. For a start, you can refer to the macro parameter
2414 \c{%1} by means of the alternative syntax \i\c{%+1}, which informs
2415 NASM that this macro parameter is supposed to contain a condition
2416 code, and will cause the preprocessor to report an error message if
2417 the macro is called with a parameter which is \e{not} a valid
2418 condition code.
2420 Far more usefully, though, you can refer to the macro parameter by
2421 means of \i\c{%-1}, which NASM will expand as the \e{inverse}
2422 condition code. So the \c{retz} macro defined in \k{maclocal} can be
2423 replaced by a general \i{conditional-return macro} like this:
2425 \c %macro  retc 1
2427 \c         j%-1    %%skip
2428 \c         ret
2429 \c   %%skip:
2431 \c %endmacro
2433 This macro can now be invoked using calls like \c{retc ne}, which
2434 will cause the conditional-jump instruction in the macro expansion
2435 to come out as \c{JE}, or \c{retc po} which will make the jump a
2436 \c{JPE}.
2438 The \c{%+1} macro-parameter reference is quite happy to interpret
2439 the arguments \c{CXZ} and \c{ECXZ} as valid condition codes;
2440 however, \c{%-1} will report an error if passed either of these,
2441 because no inverse condition code exists.
2444 \S{nolist} \i{Disabling Listing Expansion}\I\c{.nolist}
2446 When NASM is generating a listing file from your program, it will
2447 generally expand multi-line macros by means of writing the macro
2448 call and then listing each line of the expansion. This allows you to
2449 see which instructions in the macro expansion are generating what
2450 code; however, for some macros this clutters the listing up
2451 unnecessarily.
2453 NASM therefore provides the \c{.nolist} qualifier, which you can
2454 include in a macro definition to inhibit the expansion of the macro
2455 in the listing file. The \c{.nolist} qualifier comes directly after
2456 the number of parameters, like this:
2458 \c %macro foo 1.nolist
2460 Or like this:
2462 \c %macro bar 1-5+.nolist a,b,c,d,e,f,g,h
2464 \H{condasm} \i{Conditional Assembly}\I\c{%if}
2466 Similarly to the C preprocessor, NASM allows sections of a source
2467 file to be assembled only if certain conditions are met. The general
2468 syntax of this feature looks like this:
2470 \c %if<condition>
2471 \c     ; some code which only appears if <condition> is met
2472 \c %elif<condition2>
2473 \c     ; only appears if <condition> is not met but <condition2> is
2474 \c %else
2475 \c     ; this appears if neither <condition> nor <condition2> was met
2476 \c %endif
2478 The \i\c{%else} clause is optional, as is the \i\c{%elif} clause.
2479 You can have more than one \c{%elif} clause as well.
2482 \S{ifdef} \i\c{%ifdef}: Testing Single-Line Macro Existence\I{testing,
2483 single-line macro existence}
2485 Beginning a conditional-assembly block with the line \c{%ifdef
2486 MACRO} will assemble the subsequent code if, and only if, a
2487 single-line macro called \c{MACRO} is defined. If not, then the
2488 \c{%elif} and \c{%else} blocks (if any) will be processed instead.
2490 For example, when debugging a program, you might want to write code
2491 such as
2493 \c           ; perform some function
2494 \c %ifdef DEBUG
2495 \c           writefile 2,"Function performed successfully",13,10
2496 \c %endif
2497 \c           ; go and do something else
2499 Then you could use the command-line option \c{-dDEBUG} to create a
2500 version of the program which produced debugging messages, and remove
2501 the option to generate the final release version of the program.
2503 You can test for a macro \e{not} being defined by using
2504 \i\c{%ifndef} instead of \c{%ifdef}. You can also test for macro
2505 definitions in \c{%elif} blocks by using \i\c{%elifdef} and
2506 \i\c{%elifndef}.
2509 \S{ifmacro} \i\c{ifmacro}: Testing Multi-Line Macro
2510 Existence\I{testing, multi-line macro existence}
2512 The \c{%ifmacro} directive operates in the same way as the \c{%ifdef}
2513 directive, except that it checks for the existence of a multi-line macro.
2515 For example, you may be working with a large project and not have control
2516 over the macros in a library. You may want to create a macro with one
2517 name if it doesn't already exist, and another name if one with that name
2518 does exist.
2520 The \c{%ifmacro} is considered true if defining a macro with the given name
2521 and number of arguments would cause a definitions conflict. For example:
2523 \c %ifmacro MyMacro 1-3
2525 \c      %error "MyMacro 1-3" causes a conflict with an existing macro.
2527 \c %else
2529 \c      %macro MyMacro 1-3
2531 \c              ; insert code to define the macro
2533 \c      %endmacro
2535 \c %endif
2537 This will create the macro "MyMacro 1-3" if no macro already exists which
2538 would conflict with it, and emits a warning if there would be a definition
2539 conflict.
2541 You can test for the macro not existing by using the \i\c{%ifnmacro} instead
2542 of \c{%ifmacro}. Additional tests can be performed in \c{%elif} blocks by using
2543 \i\c{%elifmacro} and \i\c{%elifnmacro}.
2546 \S{ifctx} \i\c{%ifctx}: Testing the Context Stack\I{testing, context
2547 stack}
2549 The conditional-assembly construct \c{%ifctx ctxname} will cause the
2550 subsequent code to be assembled if and only if the top context on
2551 the preprocessor's context stack has the name \c{ctxname}. As with
2552 \c{%ifdef}, the inverse and \c{%elif} forms \i\c{%ifnctx},
2553 \i\c{%elifctx} and \i\c{%elifnctx} are also supported.
2555 For more details of the context stack, see \k{ctxstack}. For a
2556 sample use of \c{%ifctx}, see \k{blockif}.
2559 \S{if} \i\c{%if}: Testing Arbitrary Numeric Expressions\I{testing,
2560 arbitrary numeric expressions}
2562 The conditional-assembly construct \c{%if expr} will cause the
2563 subsequent code to be assembled if and only if the value of the
2564 numeric expression \c{expr} is non-zero. An example of the use of
2565 this feature is in deciding when to break out of a \c{%rep}
2566 preprocessor loop: see \k{rep} for a detailed example.
2568 The expression given to \c{%if}, and its counterpart \i\c{%elif}, is
2569 a critical expression (see \k{crit}).
2571 \c{%if} extends the normal NASM expression syntax, by providing a
2572 set of \i{relational operators} which are not normally available in
2573 expressions. The operators \i\c{=}, \i\c{<}, \i\c{>}, \i\c{<=},
2574 \i\c{>=} and \i\c{<>} test equality, less-than, greater-than,
2575 less-or-equal, greater-or-equal and not-equal respectively. The
2576 C-like forms \i\c{==} and \i\c{!=} are supported as alternative
2577 forms of \c{=} and \c{<>}. In addition, low-priority logical
2578 operators \i\c{&&}, \i\c{^^} and \i\c{||} are provided, supplying
2579 \i{logical AND}, \i{logical XOR} and \i{logical OR}. These work like
2580 the C logical operators (although C has no logical XOR), in that
2581 they always return either 0 or 1, and treat any non-zero input as 1
2582 (so that \c{^^}, for example, returns 1 if exactly one of its inputs
2583 is zero, and 0 otherwise). The relational operators also return 1
2584 for true and 0 for false.
2586 Like most other \c{%if} constructs, \c{%if} has a counterpart
2587 \i\c{%elif}, and negative forms \i\c{%ifn} and \i\c{%elifn}.
2589 \S{ifidn} \i\c{%ifidn} and \i\c{%ifidni}: Testing Exact Text
2590 Identity\I{testing, exact text identity}
2592 The construct \c{%ifidn text1,text2} will cause the subsequent code
2593 to be assembled if and only if \c{text1} and \c{text2}, after
2594 expanding single-line macros, are identical pieces of text.
2595 Differences in white space are not counted.
2597 \c{%ifidni} is similar to \c{%ifidn}, but is \i{case-insensitive}.
2599 For example, the following macro pushes a register or number on the
2600 stack, and allows you to treat \c{IP} as a real register:
2602 \c %macro  pushparam 1
2604 \c   %ifidni %1,ip
2605 \c         call    %%label
2606 \c   %%label:
2607 \c   %else
2608 \c         push    %1
2609 \c   %endif
2611 \c %endmacro
2613 Like most other \c{%if} constructs, \c{%ifidn} has a counterpart
2614 \i\c{%elifidn}, and negative forms \i\c{%ifnidn} and \i\c{%elifnidn}.
2615 Similarly, \c{%ifidni} has counterparts \i\c{%elifidni},
2616 \i\c{%ifnidni} and \i\c{%elifnidni}.
2619 \S{iftyp} \i\c{%ifid}, \i\c{%ifnum}, \i\c{%ifstr}: Testing Token
2620 Types\I{testing, token types}
2622 Some macros will want to perform different tasks depending on
2623 whether they are passed a number, a string, or an identifier. For
2624 example, a string output macro might want to be able to cope with
2625 being passed either a string constant or a pointer to an existing
2626 string.
2628 The conditional assembly construct \c{%ifid}, taking one parameter
2629 (which may be blank), assembles the subsequent code if and only if
2630 the first token in the parameter exists and is an identifier.
2631 \c{%ifnum} works similarly, but tests for the token being a numeric
2632 constant; \c{%ifstr} tests for it being a string.
2634 For example, the \c{writefile} macro defined in \k{mlmacgre} can be
2635 extended to take advantage of \c{%ifstr} in the following fashion:
2637 \c %macro writefile 2-3+
2639 \c   %ifstr %2
2640 \c         jmp     %%endstr
2641 \c     %if %0 = 3
2642 \c       %%str:    db      %2,%3
2643 \c     %else
2644 \c       %%str:    db      %2
2645 \c     %endif
2646 \c       %%endstr: mov     dx,%%str
2647 \c                 mov     cx,%%endstr-%%str
2648 \c   %else
2649 \c                 mov     dx,%2
2650 \c                 mov     cx,%3
2651 \c   %endif
2652 \c                 mov     bx,%1
2653 \c                 mov     ah,0x40
2654 \c                 int     0x21
2656 \c %endmacro
2658 Then the \c{writefile} macro can cope with being called in either of
2659 the following two ways:
2661 \c         writefile [file], strpointer, length
2662 \c         writefile [file], "hello", 13, 10
2664 In the first, \c{strpointer} is used as the address of an
2665 already-declared string, and \c{length} is used as its length; in
2666 the second, a string is given to the macro, which therefore declares
2667 it itself and works out the address and length for itself.
2669 Note the use of \c{%if} inside the \c{%ifstr}: this is to detect
2670 whether the macro was passed two arguments (so the string would be a
2671 single string constant, and \c{db %2} would be adequate) or more (in
2672 which case, all but the first two would be lumped together into
2673 \c{%3}, and \c{db %2,%3} would be required).
2675 \I\c{%ifnid}\I\c{%elifid}\I\c{%elifnid}\I\c{%ifnnum}\I\c{%elifnum}
2676 \I\c{%elifnnum}\I\c{%ifnstr}\I\c{%elifstr}\I\c{%elifnstr}
2677 The usual \c{%elifXXX}, \c{%ifnXXX} and \c{%elifnXXX} versions exist
2678 for each of \c{%ifid}, \c{%ifnum} and \c{%ifstr}.
2681 \S{pperror} \i\c{%error}: Reporting \i{User-Defined Errors}
2683 The preprocessor directive \c{%error} will cause NASM to report an
2684 error if it occurs in assembled code. So if other users are going to
2685 try to assemble your source files, you can ensure that they define
2686 the right macros by means of code like this:
2688 \c %ifdef SOME_MACRO
2689 \c     ; do some setup
2690 \c %elifdef SOME_OTHER_MACRO
2691 \c     ; do some different setup
2692 \c %else
2693 \c     %error Neither SOME_MACRO nor SOME_OTHER_MACRO was defined.
2694 \c %endif
2696 Then any user who fails to understand the way your code is supposed
2697 to be assembled will be quickly warned of their mistake, rather than
2698 having to wait until the program crashes on being run and then not
2699 knowing what went wrong.
2702 \H{rep} \i{Preprocessor Loops}\I{repeating code}: \i\c{%rep}
2704 NASM's \c{TIMES} prefix, though useful, cannot be used to invoke a
2705 multi-line macro multiple times, because it is processed by NASM
2706 after macros have already been expanded. Therefore NASM provides
2707 another form of loop, this time at the preprocessor level: \c{%rep}.
2709 The directives \c{%rep} and \i\c{%endrep} (\c{%rep} takes a numeric
2710 argument, which can be an expression; \c{%endrep} takes no
2711 arguments) can be used to enclose a chunk of code, which is then
2712 replicated as many times as specified by the preprocessor:
2714 \c %assign i 0
2715 \c %rep    64
2716 \c         inc     word [table+2*i]
2717 \c %assign i i+1
2718 \c %endrep
2720 This will generate a sequence of 64 \c{INC} instructions,
2721 incrementing every word of memory from \c{[table]} to
2722 \c{[table+126]}.
2724 For more complex termination conditions, or to break out of a repeat
2725 loop part way along, you can use the \i\c{%exitrep} directive to
2726 terminate the loop, like this:
2728 \c fibonacci:
2729 \c %assign i 0
2730 \c %assign j 1
2731 \c %rep 100
2732 \c %if j > 65535
2733 \c     %exitrep
2734 \c %endif
2735 \c         dw j
2736 \c %assign k j+i
2737 \c %assign i j
2738 \c %assign j k
2739 \c %endrep
2741 \c fib_number equ ($-fibonacci)/2
2743 This produces a list of all the Fibonacci numbers that will fit in
2744 16 bits. Note that a maximum repeat count must still be given to
2745 \c{%rep}. This is to prevent the possibility of NASM getting into an
2746 infinite loop in the preprocessor, which (on multitasking or
2747 multi-user systems) would typically cause all the system memory to
2748 be gradually used up and other applications to start crashing.
2751 \H{include} \i{Including Other Files}
2753 Using, once again, a very similar syntax to the C preprocessor,
2754 NASM's preprocessor lets you include other source files into your
2755 code. This is done by the use of the \i\c{%include} directive:
2757 \c %include "macros.mac"
2759 will include the contents of the file \c{macros.mac} into the source
2760 file containing the \c{%include} directive.
2762 Include files are \I{searching for include files}searched for in the
2763 current directory (the directory you're in when you run NASM, as
2764 opposed to the location of the NASM executable or the location of
2765 the source file), plus any directories specified on the NASM command
2766 line using the \c{-i} option.
2768 The standard C idiom for preventing a file being included more than
2769 once is just as applicable in NASM: if the file \c{macros.mac} has
2770 the form
2772 \c %ifndef MACROS_MAC
2773 \c     %define MACROS_MAC
2774 \c     ; now define some macros
2775 \c %endif
2777 then including the file more than once will not cause errors,
2778 because the second time the file is included nothing will happen
2779 because the macro \c{MACROS_MAC} will already be defined.
2781 You can force a file to be included even if there is no \c{%include}
2782 directive that explicitly includes it, by using the \i\c{-p} option
2783 on the NASM command line (see \k{opt-p}).
2786 \H{ctxstack} The \i{Context Stack}
2788 Having labels that are local to a macro definition is sometimes not
2789 quite powerful enough: sometimes you want to be able to share labels
2790 between several macro calls. An example might be a \c{REPEAT} ...
2791 \c{UNTIL} loop, in which the expansion of the \c{REPEAT} macro
2792 would need to be able to refer to a label which the \c{UNTIL} macro
2793 had defined. However, for such a macro you would also want to be
2794 able to nest these loops.
2796 NASM provides this level of power by means of a \e{context stack}.
2797 The preprocessor maintains a stack of \e{contexts}, each of which is
2798 characterized by a name. You add a new context to the stack using
2799 the \i\c{%push} directive, and remove one using \i\c{%pop}. You can
2800 define labels that are local to a particular context on the stack.
2803 \S{pushpop} \i\c{%push} and \i\c{%pop}: \I{creating
2804 contexts}\I{removing contexts}Creating and Removing Contexts
2806 The \c{%push} directive is used to create a new context and place it
2807 on the top of the context stack. \c{%push} requires one argument,
2808 which is the name of the context. For example:
2810 \c %push    foobar
2812 This pushes a new context called \c{foobar} on the stack. You can
2813 have several contexts on the stack with the same name: they can
2814 still be distinguished.
2816 The directive \c{%pop}, requiring no arguments, removes the top
2817 context from the context stack and destroys it, along with any
2818 labels associated with it.
2821 \S{ctxlocal} \i{Context-Local Labels}
2823 Just as the usage \c{%%foo} defines a label which is local to the
2824 particular macro call in which it is used, the usage \I{%$}\c{%$foo}
2825 is used to define a label which is local to the context on the top
2826 of the context stack. So the \c{REPEAT} and \c{UNTIL} example given
2827 above could be implemented by means of:
2829 \c %macro repeat 0
2831 \c     %push   repeat
2832 \c     %$begin:
2834 \c %endmacro
2836 \c %macro until 1
2838 \c         j%-1    %$begin
2839 \c     %pop
2841 \c %endmacro
2843 and invoked by means of, for example,
2845 \c         mov     cx,string
2846 \c         repeat
2847 \c         add     cx,3
2848 \c         scasb
2849 \c         until   e
2851 which would scan every fourth byte of a string in search of the byte
2852 in \c{AL}.
2854 If you need to define, or access, labels local to the context
2855 \e{below} the top one on the stack, you can use \I{%$$}\c{%$$foo}, or
2856 \c{%$$$foo} for the context below that, and so on.
2859 \S{ctxdefine} \i{Context-Local Single-Line Macros}
2861 NASM also allows you to define single-line macros which are local to
2862 a particular context, in just the same way:
2864 \c %define %$localmac 3
2866 will define the single-line macro \c{%$localmac} to be local to the
2867 top context on the stack. Of course, after a subsequent \c{%push},
2868 it can then still be accessed by the name \c{%$$localmac}.
2871 \S{ctxrepl} \i\c{%repl}: \I{renaming contexts}Renaming a Context
2873 If you need to change the name of the top context on the stack (in
2874 order, for example, to have it respond differently to \c{%ifctx}),
2875 you can execute a \c{%pop} followed by a \c{%push}; but this will
2876 have the side effect of destroying all context-local labels and
2877 macros associated with the context that was just popped.
2879 NASM provides the directive \c{%repl}, which \e{replaces} a context
2880 with a different name, without touching the associated macros and
2881 labels. So you could replace the destructive code
2883 \c %pop
2884 \c %push   newname
2886 with the non-destructive version \c{%repl newname}.
2889 \S{blockif} Example Use of the \i{Context Stack}: \i{Block IFs}
2891 This example makes use of almost all the context-stack features,
2892 including the conditional-assembly construct \i\c{%ifctx}, to
2893 implement a block IF statement as a set of macros.
2895 \c %macro if 1
2897 \c     %push if
2898 \c     j%-1  %$ifnot
2900 \c %endmacro
2902 \c %macro else 0
2904 \c   %ifctx if
2905 \c         %repl   else
2906 \c         jmp     %$ifend
2907 \c         %$ifnot:
2908 \c   %else
2909 \c         %error  "expected `if' before `else'"
2910 \c   %endif
2912 \c %endmacro
2914 \c %macro endif 0
2916 \c   %ifctx if
2917 \c         %$ifnot:
2918 \c         %pop
2919 \c   %elifctx      else
2920 \c         %$ifend:
2921 \c         %pop
2922 \c   %else
2923 \c         %error  "expected `if' or `else' before `endif'"
2924 \c   %endif
2926 \c %endmacro
2928 This code is more robust than the \c{REPEAT} and \c{UNTIL} macros
2929 given in \k{ctxlocal}, because it uses conditional assembly to check
2930 that the macros are issued in the right order (for example, not
2931 calling \c{endif} before \c{if}) and issues a \c{%error} if they're
2932 not.
2934 In addition, the \c{endif} macro has to be able to cope with the two
2935 distinct cases of either directly following an \c{if}, or following
2936 an \c{else}. It achieves this, again, by using conditional assembly
2937 to do different things depending on whether the context on top of
2938 the stack is \c{if} or \c{else}.
2940 The \c{else} macro has to preserve the context on the stack, in
2941 order to have the \c{%$ifnot} referred to by the \c{if} macro be the
2942 same as the one defined by the \c{endif} macro, but has to change
2943 the context's name so that \c{endif} will know there was an
2944 intervening \c{else}. It does this by the use of \c{%repl}.
2946 A sample usage of these macros might look like:
2948 \c         cmp     ax,bx
2950 \c         if ae
2951 \c                cmp     bx,cx
2953 \c                if ae
2954 \c                        mov     ax,cx
2955 \c                else
2956 \c                        mov     ax,bx
2957 \c                endif
2959 \c         else
2960 \c                cmp     ax,cx
2962 \c                if ae
2963 \c                        mov     ax,cx
2964 \c                endif
2966 \c         endif
2968 The block-\c{IF} macros handle nesting quite happily, by means of
2969 pushing another context, describing the inner \c{if}, on top of the
2970 one describing the outer \c{if}; thus \c{else} and \c{endif} always
2971 refer to the last unmatched \c{if} or \c{else}.
2974 \H{stdmac} \i{Standard Macros}
2976 NASM defines a set of standard macros, which are already defined
2977 when it starts to process any source file. If you really need a
2978 program to be assembled with no pre-defined macros, you can use the
2979 \i\c{%clear} directive to empty the preprocessor of everything but
2980 context-local preprocessor variables and single-line macros.
2982 Most \i{user-level assembler directives} (see \k{directive}) are
2983 implemented as macros which invoke primitive directives; these are
2984 described in \k{directive}. The rest of the standard macro set is
2985 described here.
2988 \S{stdmacver} \i\c{__NASM_MAJOR__}, \i\c{__NASM_MINOR__},
2989 \i\c{__NASM_SUBMINOR__} and \i\c{___NASM_PATCHLEVEL__}: \i{NASM Version}
2991 The single-line macros \c{__NASM_MAJOR__}, \c{__NASM_MINOR__},
2992 \c{__NASM_SUBMINOR__} and \c{___NASM_PATCHLEVEL__} expand to the
2993 major, minor, subminor and patch level parts of the \i{version
2994 number of NASM} being used. So, under NASM 0.98.32p1 for
2995 example, \c{__NASM_MAJOR__} would be defined to be 0, \c{__NASM_MINOR__}
2996 would be defined as 98, \c{__NASM_SUBMINOR__} would be defined to 32,
2997 and \c{___NASM_PATCHLEVEL__} would be defined as 1.
3000 \S{stdmacverid} \i\c{__NASM_VERSION_ID__}: \i{NASM Version ID}
3002 The single-line macro \c{__NASM_VERSION_ID__} expands to a dword integer
3003 representing the full version number of the version of nasm being used.
3004 The value is the equivalent to \c{__NASM_MAJOR__}, \c{__NASM_MINOR__},
3005 \c{__NASM_SUBMINOR__} and \c{___NASM_PATCHLEVEL__} concatenated to
3006 produce a single doubleword. Hence, for 0.98.32p1, the returned number
3007 would be equivalent to:
3009 \c         dd      0x00622001
3013 \c         db      1,32,98,0
3015 Note that the above lines are generate exactly the same code, the second
3016 line is used just to give an indication of the order that the separate
3017 values will be present in memory.
3020 \S{stdmacverstr} \i\c{__NASM_VER__}: \i{NASM Version string}
3022 The single-line macro \c{__NASM_VER__} expands to a string which defines
3023 the version number of nasm being used. So, under NASM 0.98.32 for example,
3025 \c         db      __NASM_VER__
3027 would expand to
3029 \c         db      "0.98.32"
3032 \S{fileline} \i\c{__FILE__} and \i\c{__LINE__}: File Name and Line Number
3034 Like the C preprocessor, NASM allows the user to find out the file
3035 name and line number containing the current instruction. The macro
3036 \c{__FILE__} expands to a string constant giving the name of the
3037 current input file (which may change through the course of assembly
3038 if \c{%include} directives are used), and \c{__LINE__} expands to a
3039 numeric constant giving the current line number in the input file.
3041 These macros could be used, for example, to communicate debugging
3042 information to a macro, since invoking \c{__LINE__} inside a macro
3043 definition (either single-line or multi-line) will return the line
3044 number of the macro \e{call}, rather than \e{definition}. So to
3045 determine where in a piece of code a crash is occurring, for
3046 example, one could write a routine \c{stillhere}, which is passed a
3047 line number in \c{EAX} and outputs something like `line 155: still
3048 here'. You could then write a macro
3050 \c %macro  notdeadyet 0
3052 \c         push    eax
3053 \c         mov     eax,__LINE__
3054 \c         call    stillhere
3055 \c         pop     eax
3057 \c %endmacro
3059 and then pepper your code with calls to \c{notdeadyet} until you
3060 find the crash point.
3062 \S{bitsm} \i\c{__BITS__}: Current BITS Mode
3064 The \c{__BITS__} standard macro is updated every time that the BITS mode is
3065 set using the \c{BITS XX} or \c{[BITS XX]} directive, where XX is a valid mode
3066 number of 16, 32 or 64. \c{__BITS__} receives the specified mode number and
3067 makes it globally available. This can be very useful for those who utilize
3068 mode-dependent macros.
3071 \S{struc} \i\c{STRUC} and \i\c{ENDSTRUC}: \i{Declaring Structure} Data Types
3073 The core of NASM contains no intrinsic means of defining data
3074 structures; instead, the preprocessor is sufficiently powerful that
3075 data structures can be implemented as a set of macros. The macros
3076 \c{STRUC} and \c{ENDSTRUC} are used to define a structure data type.
3078 \c{STRUC} takes one parameter, which is the name of the data type.
3079 This name is defined as a symbol with the value zero, and also has
3080 the suffix \c{_size} appended to it and is then defined as an
3081 \c{EQU} giving the size of the structure. Once \c{STRUC} has been
3082 issued, you are defining the structure, and should define fields
3083 using the \c{RESB} family of pseudo-instructions, and then invoke
3084 \c{ENDSTRUC} to finish the definition.
3086 For example, to define a structure called \c{mytype} containing a
3087 longword, a word, a byte and a string of bytes, you might code
3089 \c struc   mytype
3091 \c   mt_long:      resd    1
3092 \c   mt_word:      resw    1
3093 \c   mt_byte:      resb    1
3094 \c   mt_str:       resb    32
3096 \c endstruc
3098 The above code defines six symbols: \c{mt_long} as 0 (the offset
3099 from the beginning of a \c{mytype} structure to the longword field),
3100 \c{mt_word} as 4, \c{mt_byte} as 6, \c{mt_str} as 7, \c{mytype_size}
3101 as 39, and \c{mytype} itself as zero.
3103 The reason why the structure type name is defined at zero is a side
3104 effect of allowing structures to work with the local label
3105 mechanism: if your structure members tend to have the same names in
3106 more than one structure, you can define the above structure like this:
3108 \c struc mytype
3110 \c   .long:        resd    1
3111 \c   .word:        resw    1
3112 \c   .byte:        resb    1
3113 \c   .str:         resb    32
3115 \c endstruc
3117 This defines the offsets to the structure fields as \c{mytype.long},
3118 \c{mytype.word}, \c{mytype.byte} and \c{mytype.str}.
3120 NASM, since it has no \e{intrinsic} structure support, does not
3121 support any form of period notation to refer to the elements of a
3122 structure once you have one (except the above local-label notation),
3123 so code such as \c{mov ax,[mystruc.mt_word]} is not valid.
3124 \c{mt_word} is a constant just like any other constant, so the
3125 correct syntax is \c{mov ax,[mystruc+mt_word]} or \c{mov
3126 ax,[mystruc+mytype.word]}.
3129 \S{istruc} \i\c{ISTRUC}, \i\c{AT} and \i\c{IEND}: Declaring
3130 \i{Instances of Structures}
3132 Having defined a structure type, the next thing you typically want
3133 to do is to declare instances of that structure in your data
3134 segment. NASM provides an easy way to do this in the \c{ISTRUC}
3135 mechanism. To declare a structure of type \c{mytype} in a program,
3136 you code something like this:
3138 \c mystruc:
3139 \c     istruc mytype
3141 \c         at mt_long, dd      123456
3142 \c         at mt_word, dw      1024
3143 \c         at mt_byte, db      'x'
3144 \c         at mt_str,  db      'hello, world', 13, 10, 0
3146 \c     iend
3148 The function of the \c{AT} macro is to make use of the \c{TIMES}
3149 prefix to advance the assembly position to the correct point for the
3150 specified structure field, and then to declare the specified data.
3151 Therefore the structure fields must be declared in the same order as
3152 they were specified in the structure definition.
3154 If the data to go in a structure field requires more than one source
3155 line to specify, the remaining source lines can easily come after
3156 the \c{AT} line. For example:
3158 \c         at mt_str,  db      123,134,145,156,167,178,189
3159 \c                     db      190,100,0
3161 Depending on personal taste, you can also omit the code part of the
3162 \c{AT} line completely, and start the structure field on the next
3163 line:
3165 \c         at mt_str
3166 \c                 db      'hello, world'
3167 \c                 db      13,10,0
3170 \S{align} \i\c{ALIGN} and \i\c{ALIGNB}: Data Alignment
3172 The \c{ALIGN} and \c{ALIGNB} macros provides a convenient way to
3173 align code or data on a word, longword, paragraph or other boundary.
3174 (Some assemblers call this directive \i\c{EVEN}.) The syntax of the
3175 \c{ALIGN} and \c{ALIGNB} macros is
3177 \c         align   4               ; align on 4-byte boundary
3178 \c         align   16              ; align on 16-byte boundary
3179 \c         align   8,db 0          ; pad with 0s rather than NOPs
3180 \c         align   4,resb 1        ; align to 4 in the BSS
3181 \c         alignb  4               ; equivalent to previous line
3183 Both macros require their first argument to be a power of two; they
3184 both compute the number of additional bytes required to bring the
3185 length of the current section up to a multiple of that power of two,
3186 and then apply the \c{TIMES} prefix to their second argument to
3187 perform the alignment.
3189 If the second argument is not specified, the default for \c{ALIGN}
3190 is \c{NOP}, and the default for \c{ALIGNB} is \c{RESB 1}. So if the
3191 second argument is specified, the two macros are equivalent.
3192 Normally, you can just use \c{ALIGN} in code and data sections and
3193 \c{ALIGNB} in BSS sections, and never need the second argument
3194 except for special purposes.
3196 \c{ALIGN} and \c{ALIGNB}, being simple macros, perform no error
3197 checking: they cannot warn you if their first argument fails to be a
3198 power of two, or if their second argument generates more than one
3199 byte of code. In each of these cases they will silently do the wrong
3200 thing.
3202 \c{ALIGNB} (or \c{ALIGN} with a second argument of \c{RESB 1}) can
3203 be used within structure definitions:
3205 \c struc mytype2
3207 \c   mt_byte:
3208 \c         resb 1
3209 \c         alignb 2
3210 \c   mt_word:
3211 \c         resw 1
3212 \c         alignb 4
3213 \c   mt_long:
3214 \c         resd 1
3215 \c   mt_str:
3216 \c         resb 32
3218 \c endstruc
3220 This will ensure that the structure members are sensibly aligned
3221 relative to the base of the structure.
3223 A final caveat: \c{ALIGN} and \c{ALIGNB} work relative to the
3224 beginning of the \e{section}, not the beginning of the address space
3225 in the final executable. Aligning to a 16-byte boundary when the
3226 section you're in is only guaranteed to be aligned to a 4-byte
3227 boundary, for example, is a waste of effort. Again, NASM does not
3228 check that the section's alignment characteristics are sensible for
3229 the use of \c{ALIGN} or \c{ALIGNB}.
3232 \H{stackrel} \i{Stack Relative Preprocessor Directives}
3234 The following preprocessor directives provide a way to use
3235 labels to refer to local variables allocated on the stack.
3237 \b\c{%arg}  (see \k{arg})
3239 \b\c{%stacksize}  (see \k{stacksize})
3241 \b\c{%local}  (see \k{local})
3244 \S{arg} \i\c{%arg} Directive
3246 The \c{%arg} directive is used to simplify the handling of
3247 parameters passed on the stack. Stack based parameter passing
3248 is used by many high level languages, including C, C++ and Pascal.
3250 While NASM has macros which attempt to duplicate this
3251 functionality (see \k{16cmacro}), the syntax is not particularly
3252 convenient to use. and is not TASM compatible. Here is an example
3253 which shows the use of \c{%arg} without any external macros:
3255 \c some_function:
3257 \c     %push     mycontext        ; save the current context
3258 \c     %stacksize large           ; tell NASM to use bp
3259 \c     %arg      i:word, j_ptr:word
3261 \c         mov     ax,[i]
3262 \c         mov     bx,[j_ptr]
3263 \c         add     ax,[bx]
3264 \c         ret
3266 \c     %pop                       ; restore original context
3268 This is similar to the procedure defined in \k{16cmacro} and adds
3269 the value in i to the value pointed to by j_ptr and returns the
3270 sum in the ax register. See \k{pushpop} for an explanation of
3271 \c{push} and \c{pop} and the use of context stacks.
3274 \S{stacksize} \i\c{%stacksize} Directive
3276 The \c{%stacksize} directive is used in conjunction with the
3277 \c{%arg} (see \k{arg}) and the \c{%local} (see \k{local}) directives.
3278 It tells NASM the default size to use for subsequent \c{%arg} and
3279 \c{%local} directives. The \c{%stacksize} directive takes one
3280 required argument which is one of \c{flat}, \c{flat64}, \c{large} or \c{small}.
3282 \c %stacksize flat
3284 This form causes NASM to use stack-based parameter addressing
3285 relative to \c{ebp} and it assumes that a near form of call was used
3286 to get to this label (i.e. that \c{eip} is on the stack).
3288 \c %stacksize flat64
3290 This form causes NASM to use stack-based parameter addressing
3291 relative to \c{rbp} and it assumes that a near form of call was used
3292 to get to this label (i.e. that \c{rip} is on the stack).
3294 \c %stacksize large
3296 This form uses \c{bp} to do stack-based parameter addressing and
3297 assumes that a far form of call was used to get to this address
3298 (i.e. that \c{ip} and \c{cs} are on the stack).
3300 \c %stacksize small
3302 This form also uses \c{bp} to address stack parameters, but it is
3303 different from \c{large} because it also assumes that the old value
3304 of bp is pushed onto the stack (i.e. it expects an \c{ENTER}
3305 instruction). In other words, it expects that \c{bp}, \c{ip} and
3306 \c{cs} are on the top of the stack, underneath any local space which
3307 may have been allocated by \c{ENTER}. This form is probably most
3308 useful when used in combination with the \c{%local} directive
3309 (see \k{local}).
3312 \S{local} \i\c{%local} Directive
3314 The \c{%local} directive is used to simplify the use of local
3315 temporary stack variables allocated in a stack frame. Automatic
3316 local variables in C are an example of this kind of variable. The
3317 \c{%local} directive is most useful when used with the \c{%stacksize}
3318 (see \k{stacksize} and is also compatible with the \c{%arg} directive
3319 (see \k{arg}). It allows simplified reference to variables on the
3320 stack which have been allocated typically by using the \c{ENTER}
3321 instruction.
3322 \# (see \k{insENTER} for a description of that instruction).
3323 An example of its use is the following:
3325 \c silly_swap:
3327 \c     %push mycontext             ; save the current context
3328 \c     %stacksize small            ; tell NASM to use bp
3329 \c     %assign %$localsize 0       ; see text for explanation
3330 \c     %local old_ax:word, old_dx:word
3332 \c         enter   %$localsize,0   ; see text for explanation
3333 \c         mov     [old_ax],ax     ; swap ax & bx
3334 \c         mov     [old_dx],dx     ; and swap dx & cx
3335 \c         mov     ax,bx
3336 \c         mov     dx,cx
3337 \c         mov     bx,[old_ax]
3338 \c         mov     cx,[old_dx]
3339 \c         leave                   ; restore old bp
3340 \c         ret                     ;
3342 \c     %pop                        ; restore original context
3344 The \c{%$localsize} variable is used internally by the
3345 \c{%local} directive and \e{must} be defined within the
3346 current context before the \c{%local} directive may be used.
3347 Failure to do so will result in one expression syntax error for
3348 each \c{%local} variable declared. It then may be used in
3349 the construction of an appropriately sized ENTER instruction
3350 as shown in the example.
3352 \H{otherpreproc} \i{Other Preprocessor Directives}
3354 NASM also has preprocessor directives which allow access to
3355 information from external sources. Currently they include:
3357 The following preprocessor directive is supported to allow NASM to
3358 correctly handle output of the cpp C language preprocessor.
3360 \b\c{%line} enables NAsM to correctly handle the output of the cpp
3361 C language preprocessor (see \k{line}).
3363 \b\c{%!} enables NASM to read in the value of an environment variable,
3364 which can then be used in your program (see \k{getenv}).
3366 \S{line} \i\c{%line} Directive
3368 The \c{%line} directive is used to notify NASM that the input line
3369 corresponds to a specific line number in another file.  Typically
3370 this other file would be an original source file, with the current
3371 NASM input being the output of a pre-processor.  The \c{%line}
3372 directive allows NASM to output messages which indicate the line
3373 number of the original source file, instead of the file that is being
3374 read by NASM.
3376 This preprocessor directive is not generally of use to programmers,
3377 by may be of interest to preprocessor authors.  The usage of the
3378 \c{%line} preprocessor directive is as follows:
3380 \c %line nnn[+mmm] [filename]
3382 In this directive, \c{nnn} indentifies the line of the original source
3383 file which this line corresponds to.  \c{mmm} is an optional parameter
3384 which specifies a line increment value; each line of the input file
3385 read in is considered to correspond to \c{mmm} lines of the original
3386 source file.  Finally, \c{filename} is an optional parameter which
3387 specifies the file name of the original source file.
3389 After reading a \c{%line} preprocessor directive, NASM will report
3390 all file name and line numbers relative to the values specified
3391 therein.
3394 \S{getenv} \i\c{%!}\c{<env>}: Read an environment variable.
3396 The \c{%!<env>} directive makes it possible to read the value of an
3397 environment variable at assembly time. This could, for example, be used
3398 to store the contents of an environment variable into a string, which
3399 could be used at some other point in your code.
3401 For example, suppose that you have an environment variable \c{FOO}, and
3402 you want the contents of \c{FOO} to be embedded in your program. You
3403 could do that as follows:
3405 \c %define FOO    %!FOO
3406 \c %define quote   '
3408 \c tmpstr  db      quote FOO quote
3410 At the time of writing, this will generate an "unterminated string"
3411 warning at the time of defining "quote", and it will add a space
3412 before and after the string that is read in. I was unable to find
3413 a simple workaround (although a workaround can be created using a
3414 multi-line macro), so I believe that you will need to either learn how
3415 to create more complex macros, or allow for the extra spaces if you
3416 make use of this feature in that way.
3419 \C{directive} \i{Assembler Directives}
3421 NASM, though it attempts to avoid the bureaucracy of assemblers like
3422 MASM and TASM, is nevertheless forced to support a \e{few}
3423 directives. These are described in this chapter.
3425 NASM's directives come in two types: \I{user-level
3426 directives}\e{user-level} directives and \I{primitive
3427 directives}\e{primitive} directives. Typically, each directive has a
3428 user-level form and a primitive form. In almost all cases, we
3429 recommend that users use the user-level forms of the directives,
3430 which are implemented as macros which call the primitive forms.
3432 Primitive directives are enclosed in square brackets; user-level
3433 directives are not.
3435 In addition to the universal directives described in this chapter,
3436 each object file format can optionally supply extra directives in
3437 order to control particular features of that file format. These
3438 \I{format-specific directives}\e{format-specific} directives are
3439 documented along with the formats that implement them, in \k{outfmt}.
3442 \H{bits} \i\c{BITS}: Specifying Target \i{Processor Mode}
3444 The \c{BITS} directive specifies whether NASM should generate code
3445 \I{16-bit mode, versus 32-bit mode}designed to run on a processor
3446 operating in 16-bit mode, 32-bit mode or 64-bit mode. The syntax is
3447 \c{BITS XX}, where XX is 16, 32 or 64.
3449 In most cases, you should not need to use \c{BITS} explicitly. The
3450 \c{aout}, \c{coff}, \c{elf}, \c{macho}, \c{win32} and \c{win64}
3451 object formats, which are designed for use in 32-bit or 64-bit
3452 operating systems, all cause NASM to select 32-bit or 64-bit mode,
3453 respectively, by default. The \c{obj} object format allows you
3454 to specify each segment you define as either \c{USE16} or \c{USE32},
3455 and NASM will set its operating mode accordingly, so the use of the
3456 \c{BITS} directive is once again unnecessary.
3458 The most likely reason for using the \c{BITS} directive is to write
3459 32-bit or 64-bit code in a flat binary file; this is because the \c{bin}
3460 output format defaults to 16-bit mode in anticipation of it being
3461 used most frequently to write DOS \c{.COM} programs, DOS \c{.SYS}
3462 device drivers and boot loader software.
3464 You do \e{not} need to specify \c{BITS 32} merely in order to use
3465 32-bit instructions in a 16-bit DOS program; if you do, the
3466 assembler will generate incorrect code because it will be writing
3467 code targeted at a 32-bit platform, to be run on a 16-bit one.
3469 When NASM is in \c{BITS 16} mode, instructions which use 32-bit
3470 data are prefixed with an 0x66 byte, and those referring to 32-bit
3471 addresses have an 0x67 prefix. In \c{BITS 32} mode, the reverse is
3472 true: 32-bit instructions require no prefixes, whereas instructions
3473 using 16-bit data need an 0x66 and those working on 16-bit addresses
3474 need an 0x67.
3476 When NASM is in \c{BITS 64} mode, most instructions operate the same
3477 as they do for \c{BITS 32} mode. However, there are 8 more general and
3478 SSE registers, and 16-bit addressing is no longer supported.
3480 The default address size is 64 bits; 32-bit addressing can be selected
3481 with the 0x67 prefix.  The default operand size is still 32 bits,
3482 however, and the 0x66 prefix selects 16-bit operand size.  The \c{REX}
3483 prefix is used both to select 64-bit operand size, and to access the
3484 new registers. NASM automatically inserts REX prefixes when
3485 necessary.
3487 When the \c{REX} prefix is used, the processor does not know how to
3488 address the AH, BH, CH or DH (high 8-bit legacy) registers. Instead,
3489 it is possible to access the the low 8-bits of the SP, BP SI and DI
3490 registers as SPL, BPL, SIL and DIL, respectively; but only when the
3491 REX prefix is used.
3493 The \c{BITS} directive has an exactly equivalent primitive form,
3494 \c{[BITS 16]}, \c{[BITS 32]} and \c{[BITS 64]}. The user-level form is
3495 a macro which has no function other than to call the primitive form.
3497 Note that the space is neccessary, e.g. \c{BITS32} will \e{not} work!
3499 \S{USE16 & USE32} \i\c{USE16} & \i\c{USE32}: Aliases for BITS
3501 The `\c{USE16}' and `\c{USE32}' directives can be used in place of
3502 `\c{BITS 16}' and `\c{BITS 32}', for compatibility with other assemblers.
3505 \H{default} \i\c{DEFAULT}: Change the assembler defaults
3507 The \c{DEFAULT} directive changes the assembler defaults.  Normally,
3508 NASM defaults to a mode where the programmer is expected to explicitly
3509 specify most features directly.  However, this is occationally
3510 obnoxious, as the explicit form is pretty much the only one one wishes
3511 to use.
3513 Currently, the only \c{DEFAULT} that is settable is whether or not
3514 registerless instructions in 64-bit mode are \c{RIP}-relative or not.
3515 By default, they are absolute unless overridden with the \i\c{REL}
3516 specifier (see \k{effaddr}).  However, if \c{DEFAULT REL} is
3517 specified, \c{REL} is default, unless overridden with the \c{ABS}
3518 specifier, \e{except when used with an FS or GS segment override}.
3520 The special handling of \c{FS} and \c{GS} overrides are due to the
3521 fact that these registers are generally used as thread pointers or
3522 other special functions in 64-bit mode, and generating
3523 \c{RIP}-relative addresses would be extremely confusing.
3525 \c{DEFAULT REL} is disabled with \c{DEFAULT ABS}.
3527 \H{section} \i\c{SECTION} or \i\c{SEGMENT}: Changing and \i{Defining
3528 Sections}
3530 \I{changing sections}\I{switching between sections}The \c{SECTION}
3531 directive (\c{SEGMENT} is an exactly equivalent synonym) changes
3532 which section of the output file the code you write will be
3533 assembled into. In some object file formats, the number and names of
3534 sections are fixed; in others, the user may make up as many as they
3535 wish. Hence \c{SECTION} may sometimes give an error message, or may
3536 define a new section, if you try to switch to a section that does
3537 not (yet) exist.
3539 The Unix object formats, and the \c{bin} object format (but see
3540 \k{multisec}, all support
3541 the \i{standardized section names} \c{.text}, \c{.data} and \c{.bss}
3542 for the code, data and uninitialized-data sections. The \c{obj}
3543 format, by contrast, does not recognize these section names as being
3544 special, and indeed will strip off the leading period of any section
3545 name that has one.
3548 \S{sectmac} The \i\c{__SECT__} Macro
3550 The \c{SECTION} directive is unusual in that its user-level form
3551 functions differently from its primitive form. The primitive form,
3552 \c{[SECTION xyz]}, simply switches the current target section to the
3553 one given. The user-level form, \c{SECTION xyz}, however, first
3554 defines the single-line macro \c{__SECT__} to be the primitive
3555 \c{[SECTION]} directive which it is about to issue, and then issues
3556 it. So the user-level directive
3558 \c         SECTION .text
3560 expands to the two lines
3562 \c %define __SECT__        [SECTION .text]
3563 \c         [SECTION .text]
3565 Users may find it useful to make use of this in their own macros.
3566 For example, the \c{writefile} macro defined in \k{mlmacgre} can be
3567 usefully rewritten in the following more sophisticated form:
3569 \c %macro  writefile 2+
3571 \c         [section .data]
3573 \c   %%str:        db      %2
3574 \c   %%endstr:
3576 \c         __SECT__
3578 \c         mov     dx,%%str
3579 \c         mov     cx,%%endstr-%%str
3580 \c         mov     bx,%1
3581 \c         mov     ah,0x40
3582 \c         int     0x21
3584 \c %endmacro
3586 This form of the macro, once passed a string to output, first
3587 switches temporarily to the data section of the file, using the
3588 primitive form of the \c{SECTION} directive so as not to modify
3589 \c{__SECT__}. It then declares its string in the data section, and
3590 then invokes \c{__SECT__} to switch back to \e{whichever} section
3591 the user was previously working in. It thus avoids the need, in the
3592 previous version of the macro, to include a \c{JMP} instruction to
3593 jump over the data, and also does not fail if, in a complicated
3594 \c{OBJ} format module, the user could potentially be assembling the
3595 code in any of several separate code sections.
3598 \H{absolute} \i\c{ABSOLUTE}: Defining Absolute Labels
3600 The \c{ABSOLUTE} directive can be thought of as an alternative form
3601 of \c{SECTION}: it causes the subsequent code to be directed at no
3602 physical section, but at the hypothetical section starting at the
3603 given absolute address. The only instructions you can use in this
3604 mode are the \c{RESB} family.
3606 \c{ABSOLUTE} is used as follows:
3608 \c absolute 0x1A
3610 \c     kbuf_chr    resw    1
3611 \c     kbuf_free   resw    1
3612 \c     kbuf        resw    16
3614 This example describes a section of the PC BIOS data area, at
3615 segment address 0x40: the above code defines \c{kbuf_chr} to be
3616 0x1A, \c{kbuf_free} to be 0x1C, and \c{kbuf} to be 0x1E.
3618 The user-level form of \c{ABSOLUTE}, like that of \c{SECTION},
3619 redefines the \i\c{__SECT__} macro when it is invoked.
3621 \i\c{STRUC} and \i\c{ENDSTRUC} are defined as macros which use
3622 \c{ABSOLUTE} (and also \c{__SECT__}).
3624 \c{ABSOLUTE} doesn't have to take an absolute constant as an
3625 argument: it can take an expression (actually, a \i{critical
3626 expression}: see \k{crit}) and it can be a value in a segment. For
3627 example, a TSR can re-use its setup code as run-time BSS like this:
3629 \c         org     100h               ; it's a .COM program
3631 \c         jmp     setup              ; setup code comes last
3633 \c         ; the resident part of the TSR goes here
3634 \c setup:
3635 \c         ; now write the code that installs the TSR here
3637 \c absolute setup
3639 \c runtimevar1     resw    1
3640 \c runtimevar2     resd    20
3642 \c tsr_end:
3644 This defines some variables `on top of' the setup code, so that
3645 after the setup has finished running, the space it took up can be
3646 re-used as data storage for the running TSR. The symbol `tsr_end'
3647 can be used to calculate the total size of the part of the TSR that
3648 needs to be made resident.
3651 \H{extern} \i\c{EXTERN}: \i{Importing Symbols} from Other Modules
3653 \c{EXTERN} is similar to the MASM directive \c{EXTRN} and the C
3654 keyword \c{extern}: it is used to declare a symbol which is not
3655 defined anywhere in the module being assembled, but is assumed to be
3656 defined in some other module and needs to be referred to by this
3657 one. Not every object-file format can support external variables:
3658 the \c{bin} format cannot.
3660 The \c{EXTERN} directive takes as many arguments as you like. Each
3661 argument is the name of a symbol:
3663 \c extern  _printf
3664 \c extern  _sscanf,_fscanf
3666 Some object-file formats provide extra features to the \c{EXTERN}
3667 directive. In all cases, the extra features are used by suffixing a
3668 colon to the symbol name followed by object-format specific text.
3669 For example, the \c{obj} format allows you to declare that the
3670 default segment base of an external should be the group \c{dgroup}
3671 by means of the directive
3673 \c extern  _variable:wrt dgroup
3675 The primitive form of \c{EXTERN} differs from the user-level form
3676 only in that it can take only one argument at a time: the support
3677 for multiple arguments is implemented at the preprocessor level.
3679 You can declare the same variable as \c{EXTERN} more than once: NASM
3680 will quietly ignore the second and later redeclarations. You can't
3681 declare a variable as \c{EXTERN} as well as something else, though.
3684 \H{global} \i\c{GLOBAL}: \i{Exporting Symbols} to Other Modules
3686 \c{GLOBAL} is the other end of \c{EXTERN}: if one module declares a
3687 symbol as \c{EXTERN} and refers to it, then in order to prevent
3688 linker errors, some other module must actually \e{define} the
3689 symbol and declare it as \c{GLOBAL}. Some assemblers use the name
3690 \i\c{PUBLIC} for this purpose.
3692 The \c{GLOBAL} directive applying to a symbol must appear \e{before}
3693 the definition of the symbol.
3695 \c{GLOBAL} uses the same syntax as \c{EXTERN}, except that it must
3696 refer to symbols which \e{are} defined in the same module as the
3697 \c{GLOBAL} directive. For example:
3699 \c global _main
3700 \c _main:
3701 \c         ; some code
3703 \c{GLOBAL}, like \c{EXTERN}, allows object formats to define private
3704 extensions by means of a colon. The \c{elf} object format, for
3705 example, lets you specify whether global data items are functions or
3706 data:
3708 \c global  hashlookup:function, hashtable:data
3710 Like \c{EXTERN}, the primitive form of \c{GLOBAL} differs from the
3711 user-level form only in that it can take only one argument at a
3712 time.
3715 \H{common} \i\c{COMMON}: Defining Common Data Areas
3717 The \c{COMMON} directive is used to declare \i\e{common variables}.
3718 A common variable is much like a global variable declared in the
3719 uninitialized data section, so that
3721 \c common  intvar  4
3723 is similar in function to
3725 \c global  intvar
3726 \c section .bss
3728 \c intvar  resd    1
3730 The difference is that if more than one module defines the same
3731 common variable, then at link time those variables will be
3732 \e{merged}, and references to \c{intvar} in all modules will point
3733 at the same piece of memory.
3735 Like \c{GLOBAL} and \c{EXTERN}, \c{COMMON} supports object-format
3736 specific extensions. For example, the \c{obj} format allows common
3737 variables to be NEAR or FAR, and the \c{elf} format allows you to
3738 specify the alignment requirements of a common variable:
3740 \c common  commvar  4:near  ; works in OBJ
3741 \c common  intarray 100:4   ; works in ELF: 4 byte aligned
3743 Once again, like \c{EXTERN} and \c{GLOBAL}, the primitive form of
3744 \c{COMMON} differs from the user-level form only in that it can take
3745 only one argument at a time.
3748 \H{CPU} \i\c{CPU}: Defining CPU Dependencies
3750 The \i\c{CPU} directive restricts assembly to those instructions which
3751 are available on the specified CPU.
3753 Options are:
3755 \b\c{CPU 8086}          Assemble only 8086 instruction set
3757 \b\c{CPU 186}           Assemble instructions up to the 80186 instruction set
3759 \b\c{CPU 286}           Assemble instructions up to the 286 instruction set
3761 \b\c{CPU 386}           Assemble instructions up to the 386 instruction set
3763 \b\c{CPU 486}           486 instruction set
3765 \b\c{CPU 586}           Pentium instruction set
3767 \b\c{CPU PENTIUM}       Same as 586
3769 \b\c{CPU 686}           P6 instruction set
3771 \b\c{CPU PPRO}          Same as 686
3773 \b\c{CPU P2}            Same as 686
3775 \b\c{CPU P3}            Pentium III (Katmai) instruction sets
3777 \b\c{CPU KATMAI}        Same as P3
3779 \b\c{CPU P4}            Pentium 4 (Willamette) instruction set
3781 \b\c{CPU WILLAMETTE}    Same as P4
3783 \b\c{CPU PRESCOTT}      Prescott instruction set
3785 \b\c{CPU X64}           x86-64 (x64/AMD64/Intel 64) instruction set
3787 \b\c{CPU IA64}          IA64 CPU (in x86 mode) instruction set
3789 All options are case insensitive.  All instructions will be selected
3790 only if they apply to the selected CPU or lower.  By default, all
3791 instructions are available.
3794 \H{FLOAT} \i\c{FLOAT}: Handling of \I{floating-point, constants}floating-point constants
3796 By default, floating-point constants are rounded to nearest, and IEEE
3797 denormals are supported.  The following options can be set to alter
3798 this behaviour:
3800 \b\c{FLOAT DAZ}         Flush denormals to zero
3802 \b\c{FLOAT NODAZ}       Do not flush denormals to zero (default)
3804 \b\c{FLOAT NEAR}        Round to nearest (default)
3806 \b\c{FLOAT UP}          Round up (toward +Infinity)
3808 \b\c{FLOAT DOWN}        Round down (toward -Infinity)
3810 \b\c{FLOAT ZERO}        Round toward zero
3812 \b\c{FLOAT DEFAULT}     Restore default settings
3814 The standard macros \i\c{__FLOAT_DAZ__}, \i\c{__FLOAT_ROUND__}, and
3815 \i\c{__FLOAT__} contain the current state, as long as the programmer
3816 has avoided the use of the brackeded primitive form, (\c{[FLOAT]}).
3818 \c{__FLOAT__} contains the full set of floating-point settings; this
3819 value can be saved away and invoked later to restore the setting.
3822 \C{outfmt} \i{Output Formats}
3824 NASM is a portable assembler, designed to be able to compile on any
3825 ANSI C-supporting platform and produce output to run on a variety of
3826 Intel x86 operating systems. For this reason, it has a large number
3827 of available output formats, selected using the \i\c{-f} option on
3828 the NASM \i{command line}. Each of these formats, along with its
3829 extensions to the base NASM syntax, is detailed in this chapter.
3831 As stated in \k{opt-o}, NASM chooses a \i{default name} for your
3832 output file based on the input file name and the chosen output
3833 format. This will be generated by removing the \i{extension}
3834 (\c{.asm}, \c{.s}, or whatever you like to use) from the input file
3835 name, and substituting an extension defined by the output format.
3836 The extensions are given with each format below.
3839 \H{binfmt} \i\c{bin}: \i{Flat-Form Binary}\I{pure binary} Output
3841 The \c{bin} format does not produce object files: it generates
3842 nothing in the output file except the code you wrote. Such `pure
3843 binary' files are used by \i{MS-DOS}: \i\c{.COM} executables and
3844 \i\c{.SYS} device drivers are pure binary files. Pure binary output
3845 is also useful for \i{operating system} and \i{boot loader}
3846 development.
3848 The \c{bin} format supports \i{multiple section names}. For details of
3849 how nasm handles sections in the \c{bin} format, see \k{multisec}.
3851 Using the \c{bin} format puts NASM by default into 16-bit mode (see
3852 \k{bits}). In order to use \c{bin} to write 32-bit or 64-bit code,
3853 such as an OS kernel, you need to explicitly issue the \I\c{BITS}\c{BITS 32}
3854 or \I\c{BITS}\c{BITS 64} directive.
3856 \c{bin} has no default output file name extension: instead, it
3857 leaves your file name as it is once the original extension has been
3858 removed. Thus, the default is for NASM to assemble \c{binprog.asm}
3859 into a binary file called \c{binprog}.
3862 \S{org} \i\c{ORG}: Binary File \i{Program Origin}
3864 The \c{bin} format provides an additional directive to the list
3865 given in \k{directive}: \c{ORG}. The function of the \c{ORG}
3866 directive is to specify the origin address which NASM will assume
3867 the program begins at when it is loaded into memory.
3869 For example, the following code will generate the longword
3870 \c{0x00000104}:
3872 \c         org     0x100
3873 \c         dd      label
3874 \c label:
3876 Unlike the \c{ORG} directive provided by MASM-compatible assemblers,
3877 which allows you to jump around in the object file and overwrite
3878 code you have already generated, NASM's \c{ORG} does exactly what
3879 the directive says: \e{origin}. Its sole function is to specify one
3880 offset which is added to all internal address references within the
3881 section; it does not permit any of the trickery that MASM's version
3882 does. See \k{proborg} for further comments.
3885 \S{binseg} \c{bin} Extensions to the \c{SECTION}
3886 Directive\I{SECTION, bin extensions to}
3888 The \c{bin} output format extends the \c{SECTION} (or \c{SEGMENT})
3889 directive to allow you to specify the alignment requirements of
3890 segments. This is done by appending the \i\c{ALIGN} qualifier to the
3891 end of the section-definition line. For example,
3893 \c section .data   align=16
3895 switches to the section \c{.data} and also specifies that it must be
3896 aligned on a 16-byte boundary.
3898 The parameter to \c{ALIGN} specifies how many low bits of the
3899 section start address must be forced to zero. The alignment value
3900 given may be any power of two.\I{section alignment, in
3901 bin}\I{segment alignment, in bin}\I{alignment, in bin sections}
3904 \S{multisec} \i\c{Multisection}\I{bin, multisection} support for the BIN format.
3906 The \c{bin} format allows the use of multiple sections, of arbitrary names, 
3907 besides the "known" \c{.text}, \c{.data}, and \c{.bss} names.
3909 \b Sections may be designated \i\c{progbits} or \i\c{nobits}. Default 
3910 is \c{progbits} (except \c{.bss}, which defaults to \c{nobits}, 
3911 of course).
3913 \b Sections can be aligned at a specified boundary following the previous 
3914 section with \c{align=}, or at an arbitrary byte-granular position with 
3915 \i\c{start=}.
3917 \b Sections can be given a virtual start address, which will be used 
3918 for the calculation of all memory references within that section 
3919 with \i\c{vstart=}.
3921 \b Sections can be ordered using \i\c{follows=}\c{<section>} or 
3922 \i\c{vfollows=}\c{<section>} as an alternative to specifying an explicit 
3923 start address.
3925 \b Arguments to \c{org}, \c{start}, \c{vstart}, and \c{align=} are 
3926 critical expressions. See \k{crit}. E.g. \c{align=(1 << ALIGN_SHIFT)} 
3927 - \c{ALIGN_SHIFT} must be defined before it is used here.
3929 \b Any code which comes before an explicit \c{SECTION} directive
3930 is directed by default into the \c{.text} section.
3932 \b If an \c{ORG} statement is not given, \c{ORG 0} is used 
3933 by default.
3935 \b The \c{.bss} section will be placed after the last \c{progbits} 
3936 section, unless \c{start=}, \c{vstart=}, \c{follows=}, or \c{vfollows=} 
3937 has been specified.
3939 \b All sections are aligned on dword boundaries, unless a different 
3940 alignment has been specified.
3942 \b Sections may not overlap.
3944 \b Nasm creates the \c{section.<secname>.start} for each section, 
3945 which may be used in your code.
3947 \S{map}\i{Map files}
3949 Map files can be generated in \c{-f bin} format by means of the \c{[map]} 
3950 option. Map types of \c{all} (default), \c{brief}, \c{sections}, \c{segments}, 
3951 or \c{symbols} may be specified. Output may be directed to \c{stdout} 
3952 (default), \c{stderr}, or a specified file. E.g.
3953 \c{[map symbols myfile.map]}. No "user form" exists, the square
3954 brackets must be used.
3957 \H{objfmt} \i\c{obj}: \i{Microsoft OMF}\I{OMF} Object Files
3959 The \c{obj} file format (NASM calls it \c{obj} rather than \c{omf}
3960 for historical reasons) is the one produced by \i{MASM} and
3961 \i{TASM}, which is typically fed to 16-bit DOS linkers to produce
3962 \i\c{.EXE} files. It is also the format used by \i{OS/2}.
3964 \c{obj} provides a default output file-name extension of \c{.obj}.
3966 \c{obj} is not exclusively a 16-bit format, though: NASM has full
3967 support for the 32-bit extensions to the format. In particular,
3968 32-bit \c{obj} format files are used by \i{Borland's Win32
3969 compilers}, instead of using Microsoft's newer \i\c{win32} object
3970 file format.
3972 The \c{obj} format does not define any special segment names: you
3973 can call your segments anything you like. Typical names for segments
3974 in \c{obj} format files are \c{CODE}, \c{DATA} and \c{BSS}.
3976 If your source file contains code before specifying an explicit
3977 \c{SEGMENT} directive, then NASM will invent its own segment called
3978 \i\c{__NASMDEFSEG} for you.
3980 When you define a segment in an \c{obj} file, NASM defines the
3981 segment name as a symbol as well, so that you can access the segment
3982 address of the segment. So, for example:
3984 \c segment data
3986 \c dvar:   dw      1234
3988 \c segment code
3990 \c function:
3991 \c         mov     ax,data         ; get segment address of data
3992 \c         mov     ds,ax           ; and move it into DS
3993 \c         inc     word [dvar]     ; now this reference will work
3994 \c         ret
3996 The \c{obj} format also enables the use of the \i\c{SEG} and
3997 \i\c{WRT} operators, so that you can write code which does things
3998 like
4000 \c extern  foo
4002 \c       mov   ax,seg foo            ; get preferred segment of foo
4003 \c       mov   ds,ax
4004 \c       mov   ax,data               ; a different segment
4005 \c       mov   es,ax
4006 \c       mov   ax,[ds:foo]           ; this accesses `foo'
4007 \c       mov   [es:foo wrt data],bx  ; so does this
4010 \S{objseg} \c{obj} Extensions to the \c{SEGMENT}
4011 Directive\I{SEGMENT, obj extensions to}
4013 The \c{obj} output format extends the \c{SEGMENT} (or \c{SECTION})
4014 directive to allow you to specify various properties of the segment
4015 you are defining. This is done by appending extra qualifiers to the
4016 end of the segment-definition line. For example,
4018 \c segment code private align=16
4020 defines the segment \c{code}, but also declares it to be a private
4021 segment, and requires that the portion of it described in this code
4022 module must be aligned on a 16-byte boundary.
4024 The available qualifiers are:
4026 \b \i\c{PRIVATE}, \i\c{PUBLIC}, \i\c{COMMON} and \i\c{STACK} specify
4027 the combination characteristics of the segment. \c{PRIVATE} segments
4028 do not get combined with any others by the linker; \c{PUBLIC} and
4029 \c{STACK} segments get concatenated together at link time; and
4030 \c{COMMON} segments all get overlaid on top of each other rather
4031 than stuck end-to-end.
4033 \b \i\c{ALIGN} is used, as shown above, to specify how many low bits
4034 of the segment start address must be forced to zero. The alignment
4035 value given may be any power of two from 1 to 4096; in reality, the
4036 only values supported are 1, 2, 4, 16, 256 and 4096, so if 8 is
4037 specified it will be rounded up to 16, and 32, 64 and 128 will all
4038 be rounded up to 256, and so on. Note that alignment to 4096-byte
4039 boundaries is a \i{PharLap} extension to the format and may not be
4040 supported by all linkers.\I{section alignment, in OBJ}\I{segment
4041 alignment, in OBJ}\I{alignment, in OBJ sections}
4043 \b \i\c{CLASS} can be used to specify the segment class; this feature
4044 indicates to the linker that segments of the same class should be
4045 placed near each other in the output file. The class name can be any
4046 word, e.g. \c{CLASS=CODE}.
4048 \b \i\c{OVERLAY}, like \c{CLASS}, is specified with an arbitrary word
4049 as an argument, and provides overlay information to an
4050 overlay-capable linker.
4052 \b Segments can be declared as \i\c{USE16} or \i\c{USE32}, which has
4053 the effect of recording the choice in the object file and also
4054 ensuring that NASM's default assembly mode when assembling in that
4055 segment is 16-bit or 32-bit respectively.
4057 \b When writing \i{OS/2} object files, you should declare 32-bit
4058 segments as \i\c{FLAT}, which causes the default segment base for
4059 anything in the segment to be the special group \c{FLAT}, and also
4060 defines the group if it is not already defined.
4062 \b The \c{obj} file format also allows segments to be declared as
4063 having a pre-defined absolute segment address, although no linkers
4064 are currently known to make sensible use of this feature;
4065 nevertheless, NASM allows you to declare a segment such as
4066 \c{SEGMENT SCREEN ABSOLUTE=0xB800} if you need to. The \i\c{ABSOLUTE}
4067 and \c{ALIGN} keywords are mutually exclusive.
4069 NASM's default segment attributes are \c{PUBLIC}, \c{ALIGN=1}, no
4070 class, no overlay, and \c{USE16}.
4073 \S{group} \i\c{GROUP}: Defining Groups of Segments\I{segments, groups of}
4075 The \c{obj} format also allows segments to be grouped, so that a
4076 single segment register can be used to refer to all the segments in
4077 a group. NASM therefore supplies the \c{GROUP} directive, whereby
4078 you can code
4080 \c segment data
4082 \c         ; some data
4084 \c segment bss
4086 \c         ; some uninitialized data
4088 \c group dgroup data bss
4090 which will define a group called \c{dgroup} to contain the segments
4091 \c{data} and \c{bss}. Like \c{SEGMENT}, \c{GROUP} causes the group
4092 name to be defined as a symbol, so that you can refer to a variable
4093 \c{var} in the \c{data} segment as \c{var wrt data} or as \c{var wrt
4094 dgroup}, depending on which segment value is currently in your
4095 segment register.
4097 If you just refer to \c{var}, however, and \c{var} is declared in a
4098 segment which is part of a group, then NASM will default to giving
4099 you the offset of \c{var} from the beginning of the \e{group}, not
4100 the \e{segment}. Therefore \c{SEG var}, also, will return the group
4101 base rather than the segment base.
4103 NASM will allow a segment to be part of more than one group, but
4104 will generate a warning if you do this. Variables declared in a
4105 segment which is part of more than one group will default to being
4106 relative to the first group that was defined to contain the segment.
4108 A group does not have to contain any segments; you can still make
4109 \c{WRT} references to a group which does not contain the variable
4110 you are referring to. OS/2, for example, defines the special group
4111 \c{FLAT} with no segments in it.
4114 \S{uppercase} \i\c{UPPERCASE}: Disabling Case Sensitivity in Output
4116 Although NASM itself is \i{case sensitive}, some OMF linkers are
4117 not; therefore it can be useful for NASM to output single-case
4118 object files. The \c{UPPERCASE} format-specific directive causes all
4119 segment, group and symbol names that are written to the object file
4120 to be forced to upper case just before being written. Within a
4121 source file, NASM is still case-sensitive; but the object file can
4122 be written entirely in upper case if desired.
4124 \c{UPPERCASE} is used alone on a line; it requires no parameters.
4127 \S{import} \i\c{IMPORT}: Importing DLL Symbols\I{DLL symbols,
4128 importing}\I{symbols, importing from DLLs}
4130 The \c{IMPORT} format-specific directive defines a symbol to be
4131 imported from a DLL, for use if you are writing a DLL's \i{import
4132 library} in NASM. You still need to declare the symbol as \c{EXTERN}
4133 as well as using the \c{IMPORT} directive.
4135 The \c{IMPORT} directive takes two required parameters, separated by
4136 white space, which are (respectively) the name of the symbol you
4137 wish to import and the name of the library you wish to import it
4138 from. For example:
4140 \c     import  WSAStartup wsock32.dll
4142 A third optional parameter gives the name by which the symbol is
4143 known in the library you are importing it from, in case this is not
4144 the same as the name you wish the symbol to be known by to your code
4145 once you have imported it. For example:
4147 \c     import  asyncsel wsock32.dll WSAAsyncSelect
4150 \S{export} \i\c{EXPORT}: Exporting DLL Symbols\I{DLL symbols,
4151 exporting}\I{symbols, exporting from DLLs}
4153 The \c{EXPORT} format-specific directive defines a global symbol to
4154 be exported as a DLL symbol, for use if you are writing a DLL in
4155 NASM. You still need to declare the symbol as \c{GLOBAL} as well as
4156 using the \c{EXPORT} directive.
4158 \c{EXPORT} takes one required parameter, which is the name of the
4159 symbol you wish to export, as it was defined in your source file. An
4160 optional second parameter (separated by white space from the first)
4161 gives the \e{external} name of the symbol: the name by which you
4162 wish the symbol to be known to programs using the DLL. If this name
4163 is the same as the internal name, you may leave the second parameter
4164 off.
4166 Further parameters can be given to define attributes of the exported
4167 symbol. These parameters, like the second, are separated by white
4168 space. If further parameters are given, the external name must also
4169 be specified, even if it is the same as the internal name. The
4170 available attributes are:
4172 \b \c{resident} indicates that the exported name is to be kept
4173 resident by the system loader. This is an optimisation for
4174 frequently used symbols imported by name.
4176 \b \c{nodata} indicates that the exported symbol is a function which
4177 does not make use of any initialized data.
4179 \b \c{parm=NNN}, where \c{NNN} is an integer, sets the number of
4180 parameter words for the case in which the symbol is a call gate
4181 between 32-bit and 16-bit segments.
4183 \b An attribute which is just a number indicates that the symbol
4184 should be exported with an identifying number (ordinal), and gives
4185 the desired number.
4187 For example:
4189 \c     export  myfunc
4190 \c     export  myfunc TheRealMoreFormalLookingFunctionName
4191 \c     export  myfunc myfunc 1234  ; export by ordinal
4192 \c     export  myfunc myfunc resident parm=23 nodata
4195 \S{dotdotstart} \i\c{..start}: Defining the \i{Program Entry
4196 Point}
4198 \c{OMF} linkers require exactly one of the object files being linked to
4199 define the program entry point, where execution will begin when the
4200 program is run. If the object file that defines the entry point is
4201 assembled using NASM, you specify the entry point by declaring the
4202 special symbol \c{..start} at the point where you wish execution to
4203 begin.
4206 \S{objextern} \c{obj} Extensions to the \c{EXTERN}
4207 Directive\I{EXTERN, obj extensions to}
4209 If you declare an external symbol with the directive
4211 \c     extern  foo
4213 then references such as \c{mov ax,foo} will give you the offset of
4214 \c{foo} from its preferred segment base (as specified in whichever
4215 module \c{foo} is actually defined in). So to access the contents of
4216 \c{foo} you will usually need to do something like
4218 \c         mov     ax,seg foo      ; get preferred segment base
4219 \c         mov     es,ax           ; move it into ES
4220 \c         mov     ax,[es:foo]     ; and use offset `foo' from it
4222 This is a little unwieldy, particularly if you know that an external
4223 is going to be accessible from a given segment or group, say
4224 \c{dgroup}. So if \c{DS} already contained \c{dgroup}, you could
4225 simply code
4227 \c         mov     ax,[foo wrt dgroup]
4229 However, having to type this every time you want to access \c{foo}
4230 can be a pain; so NASM allows you to declare \c{foo} in the
4231 alternative form
4233 \c     extern  foo:wrt dgroup
4235 This form causes NASM to pretend that the preferred segment base of
4236 \c{foo} is in fact \c{dgroup}; so the expression \c{seg foo} will
4237 now return \c{dgroup}, and the expression \c{foo} is equivalent to
4238 \c{foo wrt dgroup}.
4240 This \I{default-WRT mechanism}default-\c{WRT} mechanism can be used
4241 to make externals appear to be relative to any group or segment in
4242 your program. It can also be applied to common variables: see
4243 \k{objcommon}.
4246 \S{objcommon} \c{obj} Extensions to the \c{COMMON}
4247 Directive\I{COMMON, obj extensions to}
4249 The \c{obj} format allows common variables to be either near\I{near
4250 common variables} or far\I{far common variables}; NASM allows you to
4251 specify which your variables should be by the use of the syntax
4253 \c common  nearvar 2:near   ; `nearvar' is a near common
4254 \c common  farvar  10:far   ; and `farvar' is far
4256 Far common variables may be greater in size than 64Kb, and so the
4257 OMF specification says that they are declared as a number of
4258 \e{elements} of a given size. So a 10-byte far common variable could
4259 be declared as ten one-byte elements, five two-byte elements, two
4260 five-byte elements or one ten-byte element.
4262 Some \c{OMF} linkers require the \I{element size, in common
4263 variables}\I{common variables, element size}element size, as well as
4264 the variable size, to match when resolving common variables declared
4265 in more than one module. Therefore NASM must allow you to specify
4266 the element size on your far common variables. This is done by the
4267 following syntax:
4269 \c common  c_5by2  10:far 5        ; two five-byte elements
4270 \c common  c_2by5  10:far 2        ; five two-byte elements
4272 If no element size is specified, the default is 1. Also, the \c{FAR}
4273 keyword is not required when an element size is specified, since
4274 only far commons may have element sizes at all. So the above
4275 declarations could equivalently be
4277 \c common  c_5by2  10:5            ; two five-byte elements
4278 \c common  c_2by5  10:2            ; five two-byte elements
4280 In addition to these extensions, the \c{COMMON} directive in \c{obj}
4281 also supports default-\c{WRT} specification like \c{EXTERN} does
4282 (explained in \k{objextern}). So you can also declare things like
4284 \c common  foo     10:wrt dgroup
4285 \c common  bar     16:far 2:wrt data
4286 \c common  baz     24:wrt data:6
4289 \H{win32fmt} \i\c{win32}: Microsoft Win32 Object Files
4291 The \c{win32} output format generates Microsoft Win32 object files,
4292 suitable for passing to Microsoft linkers such as \i{Visual C++}.
4293 Note that Borland Win32 compilers do not use this format, but use
4294 \c{obj} instead (see \k{objfmt}).
4296 \c{win32} provides a default output file-name extension of \c{.obj}.
4298 Note that although Microsoft say that Win32 object files follow the
4299 \c{COFF} (Common Object File Format) standard, the object files produced
4300 by Microsoft Win32 compilers are not compatible with COFF linkers
4301 such as DJGPP's, and vice versa. This is due to a difference of
4302 opinion over the precise semantics of PC-relative relocations. To
4303 produce COFF files suitable for DJGPP, use NASM's \c{coff} output
4304 format; conversely, the \c{coff} format does not produce object
4305 files that Win32 linkers can generate correct output from.
4308 \S{win32sect} \c{win32} Extensions to the \c{SECTION}
4309 Directive\I{SECTION, win32 extensions to}
4311 Like the \c{obj} format, \c{win32} allows you to specify additional
4312 information on the \c{SECTION} directive line, to control the type
4313 and properties of sections you declare. Section types and properties
4314 are generated automatically by NASM for the \i{standard section names}
4315 \c{.text}, \c{.data} and \c{.bss}, but may still be overridden by
4316 these qualifiers.
4318 The available qualifiers are:
4320 \b \c{code}, or equivalently \c{text}, defines the section to be a
4321 code section. This marks the section as readable and executable, but
4322 not writable, and also indicates to the linker that the type of the
4323 section is code.
4325 \b \c{data} and \c{bss} define the section to be a data section,
4326 analogously to \c{code}. Data sections are marked as readable and
4327 writable, but not executable. \c{data} declares an initialized data
4328 section, whereas \c{bss} declares an uninitialized data section.
4330 \b \c{rdata} declares an initialized data section that is readable
4331 but not writable. Microsoft compilers use this section to place
4332 constants in it.
4334 \b \c{info} defines the section to be an \i{informational section},
4335 which is not included in the executable file by the linker, but may
4336 (for example) pass information \e{to} the linker. For example,
4337 declaring an \c{info}-type section called \i\c{.drectve} causes the
4338 linker to interpret the contents of the section as command-line
4339 options.
4341 \b \c{align=}, used with a trailing number as in \c{obj}, gives the
4342 \I{section alignment, in win32}\I{alignment, in win32
4343 sections}alignment requirements of the section. The maximum you may
4344 specify is 64: the Win32 object file format contains no means to
4345 request a greater section alignment than this. If alignment is not
4346 explicitly specified, the defaults are 16-byte alignment for code
4347 sections, 8-byte alignment for rdata sections and 4-byte alignment
4348 for data (and BSS) sections.
4349 Informational sections get a default alignment of 1 byte (no
4350 alignment), though the value does not matter.
4352 The defaults assumed by NASM if you do not specify the above
4353 qualifiers are:
4355 \c section .text    code  align=16
4356 \c section .data    data  align=4
4357 \c section .rdata   rdata align=8
4358 \c section .bss     bss   align=4
4360 Any other section name is treated by default like \c{.text}.
4363 \H{win64fmt} \i\c{win64}: Microsoft Win64 Object Files
4365 The \c{win64} output format generates Microsoft Win64 object files, 
4366 which is nearly 100% indentical to the \c{win32} object format (\k{win32fmt})
4367 with the exception that it is meant to target 64-bit code and the x86-64
4368 platform altogether. This object file is used exactly the same as the \c{win32}
4369 object format (\k{win32fmt}), in NASM, with regard to this exception.
4372 \H{cofffmt} \i\c{coff}: \i{Common Object File Format}
4374 The \c{coff} output type produces \c{COFF} object files suitable for
4375 linking with the \i{DJGPP} linker.
4377 \c{coff} provides a default output file-name extension of \c{.o}.
4379 The \c{coff} format supports the same extensions to the \c{SECTION}
4380 directive as \c{win32} does, except that the \c{align} qualifier and
4381 the \c{info} section type are not supported.
4383 \H{machofmt} \i\c{macho}: \i{Mach Object File Format}
4385 The \c{macho} output type produces \c{Mach-O} object files suitable for
4386 linking with the \i{Mac OSX} linker.
4388 \c{macho} provides a default output file-name extension of \c{.o}.
4390 \H{elffmt} \i\c{elf, elf32, and elf64}: \I{ELF}\I{linux, elf}\i{Executable and Linkable
4391 Format} Object Files
4393 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},
4394 including \i{Solaris x86}, \i{UnixWare} and \i{SCO Unix}. \c{elf}
4395 provides a default output file-name extension of \c{.o}.
4396 \c{elf} is a synonym for \c{elf32}.
4398 \S{abisect} ELF specific directive \i\c{osabi}
4400 The ELF header specifies the application binary interface for the target operating system (OSABI).
4401 This field can be set by using the \c{osabi} directive with the numeric value (0-255) of the target
4402  system. If this directive is not used, the default value will be "UNIX System V ABI" (0) which will work on
4403  most systems which support ELF.
4405 \S{elfsect} \c{elf} Extensions to the \c{SECTION}
4406 Directive\I{SECTION, elf extensions to}
4408 Like the \c{obj} format, \c{elf} allows you to specify additional
4409 information on the \c{SECTION} directive line, to control the type
4410 and properties of sections you declare. Section types and properties
4411 are generated automatically by NASM for the \i{standard section
4412 names} \i\c{.text}, \i\c{.data} and \i\c{.bss}, but may still be
4413 overridden by these qualifiers.
4415 The available qualifiers are:
4417 \b \i\c{alloc} defines the section to be one which is loaded into
4418 memory when the program is run. \i\c{noalloc} defines it to be one
4419 which is not, such as an informational or comment section.
4421 \b \i\c{exec} defines the section to be one which should have execute
4422 permission when the program is run. \i\c{noexec} defines it as one
4423 which should not.
4425 \b \i\c{write} defines the section to be one which should be writable
4426 when the program is run. \i\c{nowrite} defines it as one which should
4427 not.
4429 \b \i\c{progbits} defines the section to be one with explicit contents
4430 stored in the object file: an ordinary code or data section, for
4431 example, \i\c{nobits} defines the section to be one with no explicit
4432 contents given, such as a BSS section.
4434 \b \c{align=}, used with a trailing number as in \c{obj}, gives the
4435 \I{section alignment, in elf}\I{alignment, in elf sections}alignment
4436 requirements of the section.
4438 The defaults assumed by NASM if you do not specify the above
4439 qualifiers are:
4441 \c section .text    progbits  alloc  exec    nowrite  align=16
4442 \c section .rodata  progbits  alloc  noexec  nowrite  align=4
4443 \c section .data    progbits  alloc  noexec  write    align=4
4444 \c section .bss     nobits    alloc  noexec  write    align=4
4445 \c section other    progbits  alloc  noexec  nowrite  align=1
4447 (Any section name other than \c{.text}, \c{.rodata}, \c{.data} and
4448 \c{.bss} is treated by default like \c{other} in the above code.)
4451 \S{elfwrt} \i{Position-Independent Code}\I{PIC}: \c{elf} Special
4452 Symbols and \i\c{WRT}
4454 The \c{ELF} specification contains enough features to allow
4455 position-independent code (PIC) to be written, which makes \i{ELF
4456 shared libraries} very flexible. However, it also means NASM has to
4457 be able to generate a variety of strange relocation types in ELF
4458 object files, if it is to be an assembler which can write PIC.
4460 Since \c{ELF} does not support segment-base references, the \c{WRT}
4461 operator is not used for its normal purpose; therefore NASM's
4462 \c{elf} output format makes use of \c{WRT} for a different purpose,
4463 namely the PIC-specific \I{relocations, PIC-specific}relocation
4464 types.
4466 \c{elf} defines five special symbols which you can use as the
4467 right-hand side of the \c{WRT} operator to obtain PIC relocation
4468 types. They are \i\c{..gotpc}, \i\c{..gotoff}, \i\c{..got},
4469 \i\c{..plt} and \i\c{..sym}. Their functions are summarized here:
4471 \b Referring to the symbol marking the global offset table base
4472 using \c{wrt ..gotpc} will end up giving the distance from the
4473 beginning of the current section to the global offset table.
4474 (\i\c{_GLOBAL_OFFSET_TABLE_} is the standard symbol name used to
4475 refer to the \i{GOT}.) So you would then need to add \i\c{$$} to the
4476 result to get the real address of the GOT.
4478 \b Referring to a location in one of your own sections using \c{wrt
4479 ..gotoff} will give the distance from the beginning of the GOT to
4480 the specified location, so that adding on the address of the GOT
4481 would give the real address of the location you wanted.
4483 \b Referring to an external or global symbol using \c{wrt ..got}
4484 causes the linker to build an entry \e{in} the GOT containing the
4485 address of the symbol, and the reference gives the distance from the
4486 beginning of the GOT to the entry; so you can add on the address of
4487 the GOT, load from the resulting address, and end up with the
4488 address of the symbol.
4490 \b Referring to a procedure name using \c{wrt ..plt} causes the
4491 linker to build a \i{procedure linkage table} entry for the symbol,
4492 and the reference gives the address of the \i{PLT} entry. You can
4493 only use this in contexts which would generate a PC-relative
4494 relocation normally (i.e. as the destination for \c{CALL} or
4495 \c{JMP}), since ELF contains no relocation type to refer to PLT
4496 entries absolutely.
4498 \b Referring to a symbol name using \c{wrt ..sym} causes NASM to
4499 write an ordinary relocation, but instead of making the relocation
4500 relative to the start of the section and then adding on the offset
4501 to the symbol, it will write a relocation record aimed directly at
4502 the symbol in question. The distinction is a necessary one due to a
4503 peculiarity of the dynamic linker.
4505 A fuller explanation of how to use these relocation types to write
4506 shared libraries entirely in NASM is given in \k{picdll}.
4509 \S{elfglob} \c{elf} Extensions to the \c{GLOBAL} Directive\I{GLOBAL,
4510 elf extensions to}\I{GLOBAL, aoutb extensions to}
4512 \c{ELF} object files can contain more information about a global symbol
4513 than just its address: they can contain the \I{symbol sizes,
4514 specifying}\I{size, of symbols}size of the symbol and its \I{symbol
4515 types, specifying}\I{type, of symbols}type as well. These are not
4516 merely debugger conveniences, but are actually necessary when the
4517 program being written is a \i{shared library}. NASM therefore
4518 supports some extensions to the \c{GLOBAL} directive, allowing you
4519 to specify these features.
4521 You can specify whether a global variable is a function or a data
4522 object by suffixing the name with a colon and the word
4523 \i\c{function} or \i\c{data}. (\i\c{object} is a synonym for
4524 \c{data}.) For example:
4526 \c global   hashlookup:function, hashtable:data
4528 exports the global symbol \c{hashlookup} as a function and
4529 \c{hashtable} as a data object.
4531 Optionally, you can control the ELF visibility of the symbol.  Just
4532 add one of the visibility keywords: \i\c{default}, \i\c{internal},
4533 \i\c{hidden}, or \i\c{protected}.  The default is \i\c{default} of
4534 course.  For example, to make \c{hashlookup} hidden:
4536 \c global   hashlookup:function hidden
4538 You can also specify the size of the data associated with the
4539 symbol, as a numeric expression (which may involve labels, and even
4540 forward references) after the type specifier. Like this:
4542 \c global  hashtable:data (hashtable.end - hashtable)
4544 \c hashtable:
4545 \c         db this,that,theother  ; some data here
4546 \c .end:
4548 This makes NASM automatically calculate the length of the table and
4549 place that information into the \c{ELF} symbol table.
4551 Declaring the type and size of global symbols is necessary when
4552 writing shared library code. For more information, see
4553 \k{picglobal}.
4556 \S{elfcomm} \c{elf} Extensions to the \c{COMMON} Directive
4557 \I{COMMON, elf extensions to}
4559 \c{ELF} also allows you to specify alignment requirements \I{common
4560 variables, alignment in elf}\I{alignment, of elf common variables}on
4561 common variables. This is done by putting a number (which must be a
4562 power of two) after the name and size of the common variable,
4563 separated (as usual) by a colon. For example, an array of
4564 doublewords would benefit from 4-byte alignment:
4566 \c common  dwordarray 128:4
4568 This declares the total size of the array to be 128 bytes, and
4569 requires that it be aligned on a 4-byte boundary.
4572 \S{elf16} 16-bit code and ELF
4573 \I{ELF, 16-bit code and}
4575 The \c{ELF32} specification doesn't provide relocations for 8- and
4576 16-bit values, but the GNU \c{ld} linker adds these as an extension.
4577 NASM can generate GNU-compatible relocations, to allow 16-bit code to
4578 be linked as ELF using GNU \c{ld}. If NASM is used with the
4579 \c{-w+gnu-elf-extensions} option, a warning is issued when one of
4580 these relocations is generated.
4582 \S{elfdbg} Debug formats and ELF
4583 \I{ELF, Debug formats and}
4585 \c{ELF32} and \c{ELF64} provide debug information in \c{STABS} format.
4586 As of 0.99.05, this information is generated only for the ".text" section.
4587 However, in more recent versions, all executable sections are included.
4588 (Note that only the ".text" section is executable by default.)
4590 \H{aoutfmt} \i\c{aout}: Linux \I{a.out, Linux version}\I{linux, a.out}\c{a.out} Object Files
4592 The \c{aout} format generates \c{a.out} object files, in the form used
4593 by early Linux systems (current Linux systems use ELF, see
4594 \k{elffmt}.) These differ from other \c{a.out} object files in that
4595 the magic number in the first four bytes of the file is
4596 different; also, some implementations of \c{a.out}, for example
4597 NetBSD's, support position-independent code, which Linux's
4598 implementation does not.
4600 \c{a.out} provides a default output file-name extension of \c{.o}.
4602 \c{a.out} is a very simple object format. It supports no special
4603 directives, no special symbols, no use of \c{SEG} or \c{WRT}, and no
4604 extensions to any standard directives. It supports only the three
4605 \i{standard section names} \i\c{.text}, \i\c{.data} and \i\c{.bss}.
4608 \H{aoutfmt} \i\c{aoutb}: \i{NetBSD}/\i{FreeBSD}/\i{OpenBSD}
4609 \I{a.out, BSD version}\c{a.out} Object Files
4611 The \c{aoutb} format generates \c{a.out} object files, in the form
4612 used by the various free \c{BSD Unix} clones, \c{NetBSD}, \c{FreeBSD}
4613 and \c{OpenBSD}. For simple object files, this object format is exactly
4614 the same as \c{aout} except for the magic number in the first four bytes
4615 of the file. However, the \c{aoutb} format supports
4616 \I{PIC}\i{position-independent code} in the same way as the \c{elf}
4617 format, so you can use it to write \c{BSD} \i{shared libraries}.
4619 \c{aoutb} provides a default output file-name extension of \c{.o}.
4621 \c{aoutb} supports no special directives, no special symbols, and
4622 only the three \i{standard section names} \i\c{.text}, \i\c{.data}
4623 and \i\c{.bss}. However, it also supports the same use of \i\c{WRT} as
4624 \c{elf} does, to provide position-independent code relocation types.
4625 See \k{elfwrt} for full documentation of this feature.
4627 \c{aoutb} also supports the same extensions to the \c{GLOBAL}
4628 directive as \c{elf} does: see \k{elfglob} for documentation of
4629 this.
4632 \H{as86fmt} \c{as86}: \i{Minix}/Linux\I{linux, as86} \i\c{as86} Object Files
4634 The Minix/Linux 16-bit assembler \c{as86} has its own non-standard
4635 object file format. Although its companion linker \i\c{ld86} produces
4636 something close to ordinary \c{a.out} binaries as output, the object
4637 file format used to communicate between \c{as86} and \c{ld86} is not
4638 itself \c{a.out}.
4640 NASM supports this format, just in case it is useful, as \c{as86}.
4641 \c{as86} provides a default output file-name extension of \c{.o}.
4643 \c{as86} is a very simple object format (from the NASM user's point
4644 of view). It supports no special directives, no special symbols, no
4645 use of \c{SEG} or \c{WRT}, and no extensions to any standard
4646 directives. It supports only the three \i{standard section names}
4647 \i\c{.text}, \i\c{.data} and \i\c{.bss}.
4650 \H{rdffmt} \I{RDOFF}\i\c{rdf}: \i{Relocatable Dynamic Object File
4651 Format}
4653 The \c{rdf} output format produces \c{RDOFF} object files. \c{RDOFF}
4654 (Relocatable Dynamic Object File Format) is a home-grown object-file
4655 format, designed alongside NASM itself and reflecting in its file
4656 format the internal structure of the assembler.
4658 \c{RDOFF} is not used by any well-known operating systems. Those
4659 writing their own systems, however, may well wish to use \c{RDOFF}
4660 as their object format, on the grounds that it is designed primarily
4661 for simplicity and contains very little file-header bureaucracy.
4663 The Unix NASM archive, and the DOS archive which includes sources,
4664 both contain an \I{rdoff subdirectory}\c{rdoff} subdirectory holding
4665 a set of RDOFF utilities: an RDF linker, an \c{RDF} static-library
4666 manager, an RDF file dump utility, and a program which will load and
4667 execute an RDF executable under Linux.
4669 \c{rdf} supports only the \i{standard section names} \i\c{.text},
4670 \i\c{.data} and \i\c{.bss}.
4673 \S{rdflib} Requiring a Library: The \i\c{LIBRARY} Directive
4675 \c{RDOFF} contains a mechanism for an object file to demand a given
4676 library to be linked to the module, either at load time or run time.
4677 This is done by the \c{LIBRARY} directive, which takes one argument
4678 which is the name of the module:
4680 \c     library  mylib.rdl
4683 \S{rdfmod} Specifying a Module Name: The \i\c{MODULE} Directive
4685 Special \c{RDOFF} header record is used to store the name of the module.
4686 It can be used, for example, by run-time loader to perform dynamic
4687 linking. \c{MODULE} directive takes one argument which is the name
4688 of current module:
4690 \c     module  mymodname
4692 Note that when you statically link modules and tell linker to strip
4693 the symbols from output file, all module names will be stripped too.
4694 To avoid it, you should start module names with \I{$, prefix}\c{$}, like:
4696 \c     module  $kernel.core
4699 \S{rdfglob} \c{rdf} Extensions to the \c{GLOBAL} directive\I{GLOBAL,
4700 rdf extensions to}
4702 \c{RDOFF} global symbols can contain additional information needed by
4703 the static linker. You can mark a global symbol as exported, thus
4704 telling the linker do not strip it from target executable or library
4705 file. Like in \c{ELF}, you can also specify whether an exported symbol
4706 is a procedure (function) or data object.
4708 Suffixing the name with a colon and the word \i\c{export} you make the
4709 symbol exported:
4711 \c     global  sys_open:export
4713 To specify that exported symbol is a procedure (function), you add the
4714 word \i\c{proc} or \i\c{function} after declaration:
4716 \c     global  sys_open:export proc
4718 Similarly, to specify exported data object, add the word \i\c{data}
4719 or \i\c{object} to the directive:
4721 \c     global  kernel_ticks:export data
4724 \S{rdfimpt} \c{rdf} Extensions to the \c{EXTERN} directive\I{EXTERN,
4725 rdf extensions to}
4727 By default the \c{EXTERN} directive in \c{RDOFF} declares a "pure external" 
4728 symbol (i.e. the static linker will complain if such a symbol is not resolved).
4729 To declare an "imported" symbol, which must be resolved later during a dynamic
4730 linking phase, \c{RDOFF} offers an additional \c{import} modifier. As in
4731 \c{GLOBAL}, you can also specify whether an imported symbol is a procedure
4732 (function) or data object. For example:
4734 \c     library $libc
4735 \c     extern  _open:import
4736 \c     extern  _printf:import proc
4737 \c     extern  _errno:import data
4739 Here the directive \c{LIBRARY} is also included, which gives the dynamic linker
4740 a hint as to where to find requested symbols.
4743 \H{dbgfmt} \i\c{dbg}: Debugging Format
4745 The \c{dbg} output format is not built into NASM in the default
4746 configuration. If you are building your own NASM executable from the
4747 sources, you can define \i\c{OF_DBG} in \c{outform.h} or on the
4748 compiler command line, and obtain the \c{dbg} output format.
4750 The \c{dbg} format does not output an object file as such; instead,
4751 it outputs a text file which contains a complete list of all the
4752 transactions between the main body of NASM and the output-format
4753 back end module. It is primarily intended to aid people who want to
4754 write their own output drivers, so that they can get a clearer idea
4755 of the various requests the main program makes of the output driver,
4756 and in what order they happen.
4758 For simple files, one can easily use the \c{dbg} format like this:
4760 \c nasm -f dbg filename.asm
4762 which will generate a diagnostic file called \c{filename.dbg}.
4763 However, this will not work well on files which were designed for a
4764 different object format, because each object format defines its own
4765 macros (usually user-level forms of directives), and those macros
4766 will not be defined in the \c{dbg} format. Therefore it can be
4767 useful to run NASM twice, in order to do the preprocessing with the
4768 native object format selected:
4770 \c nasm -e -f rdf -o rdfprog.i rdfprog.asm
4771 \c nasm -a -f dbg rdfprog.i
4773 This preprocesses \c{rdfprog.asm} into \c{rdfprog.i}, keeping the
4774 \c{rdf} object format selected in order to make sure RDF special
4775 directives are converted into primitive form correctly. Then the
4776 preprocessed source is fed through the \c{dbg} format to generate
4777 the final diagnostic output.
4779 This workaround will still typically not work for programs intended
4780 for \c{obj} format, because the \c{obj} \c{SEGMENT} and \c{GROUP}
4781 directives have side effects of defining the segment and group names
4782 as symbols; \c{dbg} will not do this, so the program will not
4783 assemble. You will have to work around that by defining the symbols
4784 yourself (using \c{EXTERN}, for example) if you really need to get a
4785 \c{dbg} trace of an \c{obj}-specific source file.
4787 \c{dbg} accepts any section name and any directives at all, and logs
4788 them all to its output file.
4791 \C{16bit} Writing 16-bit Code (DOS, Windows 3/3.1)
4793 This chapter attempts to cover some of the common issues encountered
4794 when writing 16-bit code to run under \c{MS-DOS} or \c{Windows 3.x}. It
4795 covers how to link programs to produce \c{.EXE} or \c{.COM} files,
4796 how to write \c{.SYS} device drivers, and how to interface assembly
4797 language code with 16-bit C compilers and with Borland Pascal.
4800 \H{exefiles} Producing \i\c{.EXE} Files
4802 Any large program written under DOS needs to be built as a \c{.EXE}
4803 file: only \c{.EXE} files have the necessary internal structure
4804 required to span more than one 64K segment. \i{Windows} programs,
4805 also, have to be built as \c{.EXE} files, since Windows does not
4806 support the \c{.COM} format.
4808 In general, you generate \c{.EXE} files by using the \c{obj} output
4809 format to produce one or more \i\c{.OBJ} files, and then linking
4810 them together using a linker. However, NASM also supports the direct
4811 generation of simple DOS \c{.EXE} files using the \c{bin} output
4812 format (by using \c{DB} and \c{DW} to construct the \c{.EXE} file
4813 header), and a macro package is supplied to do this. Thanks to
4814 Yann Guidon for contributing the code for this.
4816 NASM may also support \c{.EXE} natively as another output format in
4817 future releases.
4820 \S{objexe} Using the \c{obj} Format To Generate \c{.EXE} Files
4822 This section describes the usual method of generating \c{.EXE} files
4823 by linking \c{.OBJ} files together.
4825 Most 16-bit programming language packages come with a suitable
4826 linker; if you have none of these, there is a free linker called
4827 \i{VAL}\I{linker, free}, available in \c{LZH} archive format from
4828 \W{ftp://x2ftp.oulu.fi/pub/msdos/programming/lang/}\i\c{x2ftp.oulu.fi}.
4829 An LZH archiver can be found at
4830 \W{ftp://ftp.simtel.net/pub/simtelnet/msdos/arcers}\i\c{ftp.simtel.net}.
4831 There is another `free' linker (though this one doesn't come with
4832 sources) called \i{FREELINK}, available from
4833 \W{http://www.pcorner.com/tpc/old/3-101.html}\i\c{www.pcorner.com}.
4834 A third, \i\c{djlink}, written by DJ Delorie, is available at
4835 \W{http://www.delorie.com/djgpp/16bit/djlink/}\i\c{www.delorie.com}.
4836 A fourth linker, \i\c{ALINK}, written by Anthony A.J. Williams, is
4837 available at \W{http://alink.sourceforge.net}\i\c{alink.sourceforge.net}.
4839 When linking several \c{.OBJ} files into a \c{.EXE} file, you should
4840 ensure that exactly one of them has a start point defined (using the
4841 \I{program entry point}\i\c{..start} special symbol defined by the
4842 \c{obj} format: see \k{dotdotstart}). If no module defines a start
4843 point, the linker will not know what value to give the entry-point
4844 field in the output file header; if more than one defines a start
4845 point, the linker will not know \e{which} value to use.
4847 An example of a NASM source file which can be assembled to a
4848 \c{.OBJ} file and linked on its own to a \c{.EXE} is given here. It
4849 demonstrates the basic principles of defining a stack, initialising
4850 the segment registers, and declaring a start point. This file is
4851 also provided in the \I{test subdirectory}\c{test} subdirectory of
4852 the NASM archives, under the name \c{objexe.asm}.
4854 \c segment code
4856 \c ..start:
4857 \c         mov     ax,data
4858 \c         mov     ds,ax
4859 \c         mov     ax,stack
4860 \c         mov     ss,ax
4861 \c         mov     sp,stacktop
4863 This initial piece of code sets up \c{DS} to point to the data
4864 segment, and initializes \c{SS} and \c{SP} to point to the top of
4865 the provided stack. Notice that interrupts are implicitly disabled
4866 for one instruction after a move into \c{SS}, precisely for this
4867 situation, so that there's no chance of an interrupt occurring
4868 between the loads of \c{SS} and \c{SP} and not having a stack to
4869 execute on.
4871 Note also that the special symbol \c{..start} is defined at the
4872 beginning of this code, which means that will be the entry point
4873 into the resulting executable file.
4875 \c         mov     dx,hello
4876 \c         mov     ah,9
4877 \c         int     0x21
4879 The above is the main program: load \c{DS:DX} with a pointer to the
4880 greeting message (\c{hello} is implicitly relative to the segment
4881 \c{data}, which was loaded into \c{DS} in the setup code, so the
4882 full pointer is valid), and call the DOS print-string function.
4884 \c         mov     ax,0x4c00
4885 \c         int     0x21
4887 This terminates the program using another DOS system call.
4889 \c segment data
4891 \c hello:  db      'hello, world', 13, 10, '$'
4893 The data segment contains the string we want to display.
4895 \c segment stack stack
4896 \c         resb 64
4897 \c stacktop:
4899 The above code declares a stack segment containing 64 bytes of
4900 uninitialized stack space, and points \c{stacktop} at the top of it.
4901 The directive \c{segment stack stack} defines a segment \e{called}
4902 \c{stack}, and also of \e{type} \c{STACK}. The latter is not
4903 necessary to the correct running of the program, but linkers are
4904 likely to issue warnings or errors if your program has no segment of
4905 type \c{STACK}.
4907 The above file, when assembled into a \c{.OBJ} file, will link on
4908 its own to a valid \c{.EXE} file, which when run will print `hello,
4909 world' and then exit.
4912 \S{binexe} Using the \c{bin} Format To Generate \c{.EXE} Files
4914 The \c{.EXE} file format is simple enough that it's possible to
4915 build a \c{.EXE} file by writing a pure-binary program and sticking
4916 a 32-byte header on the front. This header is simple enough that it
4917 can be generated using \c{DB} and \c{DW} commands by NASM itself, so
4918 that you can use the \c{bin} output format to directly generate
4919 \c{.EXE} files.
4921 Included in the NASM archives, in the \I{misc subdirectory}\c{misc}
4922 subdirectory, is a file \i\c{exebin.mac} of macros. It defines three
4923 macros: \i\c{EXE_begin}, \i\c{EXE_stack} and \i\c{EXE_end}.
4925 To produce a \c{.EXE} file using this method, you should start by
4926 using \c{%include} to load the \c{exebin.mac} macro package into
4927 your source file. You should then issue the \c{EXE_begin} macro call
4928 (which takes no arguments) to generate the file header data. Then
4929 write code as normal for the \c{bin} format - you can use all three
4930 standard sections \c{.text}, \c{.data} and \c{.bss}. At the end of
4931 the file you should call the \c{EXE_end} macro (again, no arguments),
4932 which defines some symbols to mark section sizes, and these symbols
4933 are referred to in the header code generated by \c{EXE_begin}.
4935 In this model, the code you end up writing starts at \c{0x100}, just
4936 like a \c{.COM} file - in fact, if you strip off the 32-byte header
4937 from the resulting \c{.EXE} file, you will have a valid \c{.COM}
4938 program. All the segment bases are the same, so you are limited to a
4939 64K program, again just like a \c{.COM} file. Note that an \c{ORG}
4940 directive is issued by the \c{EXE_begin} macro, so you should not
4941 explicitly issue one of your own.
4943 You can't directly refer to your segment base value, unfortunately,
4944 since this would require a relocation in the header, and things
4945 would get a lot more complicated. So you should get your segment
4946 base by copying it out of \c{CS} instead.
4948 On entry to your \c{.EXE} file, \c{SS:SP} are already set up to
4949 point to the top of a 2Kb stack. You can adjust the default stack
4950 size of 2Kb by calling the \c{EXE_stack} macro. For example, to
4951 change the stack size of your program to 64 bytes, you would call
4952 \c{EXE_stack 64}.
4954 A sample program which generates a \c{.EXE} file in this way is
4955 given in the \c{test} subdirectory of the NASM archive, as
4956 \c{binexe.asm}.
4959 \H{comfiles} Producing \i\c{.COM} Files
4961 While large DOS programs must be written as \c{.EXE} files, small
4962 ones are often better written as \c{.COM} files. \c{.COM} files are
4963 pure binary, and therefore most easily produced using the \c{bin}
4964 output format.
4967 \S{combinfmt} Using the \c{bin} Format To Generate \c{.COM} Files
4969 \c{.COM} files expect to be loaded at offset \c{100h} into their
4970 segment (though the segment may change). Execution then begins at
4971 \I\c{ORG}\c{100h}, i.e. right at the start of the program. So to
4972 write a \c{.COM} program, you would create a source file looking
4973 like
4975 \c         org 100h
4977 \c section .text
4979 \c start:
4980 \c         ; put your code here
4982 \c section .data
4984 \c         ; put data items here
4986 \c section .bss
4988 \c         ; put uninitialized data here
4990 The \c{bin} format puts the \c{.text} section first in the file, so
4991 you can declare data or BSS items before beginning to write code if
4992 you want to and the code will still end up at the front of the file
4993 where it belongs.
4995 The BSS (uninitialized data) section does not take up space in the
4996 \c{.COM} file itself: instead, addresses of BSS items are resolved
4997 to point at space beyond the end of the file, on the grounds that
4998 this will be free memory when the program is run. Therefore you
4999 should not rely on your BSS being initialized to all zeros when you
5000 run.
5002 To assemble the above program, you should use a command line like
5004 \c nasm myprog.asm -fbin -o myprog.com
5006 The \c{bin} format would produce a file called \c{myprog} if no
5007 explicit output file name were specified, so you have to override it
5008 and give the desired file name.
5011 \S{comobjfmt} Using the \c{obj} Format To Generate \c{.COM} Files
5013 If you are writing a \c{.COM} program as more than one module, you
5014 may wish to assemble several \c{.OBJ} files and link them together
5015 into a \c{.COM} program. You can do this, provided you have a linker
5016 capable of outputting \c{.COM} files directly (\i{TLINK} does this),
5017 or alternatively a converter program such as \i\c{EXE2BIN} to
5018 transform the \c{.EXE} file output from the linker into a \c{.COM}
5019 file.
5021 If you do this, you need to take care of several things:
5023 \b The first object file containing code should start its code
5024 segment with a line like \c{RESB 100h}. This is to ensure that the
5025 code begins at offset \c{100h} relative to the beginning of the code
5026 segment, so that the linker or converter program does not have to
5027 adjust address references within the file when generating the
5028 \c{.COM} file. Other assemblers use an \i\c{ORG} directive for this
5029 purpose, but \c{ORG} in NASM is a format-specific directive to the
5030 \c{bin} output format, and does not mean the same thing as it does
5031 in MASM-compatible assemblers.
5033 \b You don't need to define a stack segment.
5035 \b All your segments should be in the same group, so that every time
5036 your code or data references a symbol offset, all offsets are
5037 relative to the same segment base. This is because, when a \c{.COM}
5038 file is loaded, all the segment registers contain the same value.
5041 \H{sysfiles} Producing \i\c{.SYS} Files
5043 \i{MS-DOS device drivers} - \c{.SYS} files - are pure binary files,
5044 similar to \c{.COM} files, except that they start at origin zero
5045 rather than \c{100h}. Therefore, if you are writing a device driver
5046 using the \c{bin} format, you do not need the \c{ORG} directive,
5047 since the default origin for \c{bin} is zero. Similarly, if you are
5048 using \c{obj}, you do not need the \c{RESB 100h} at the start of
5049 your code segment.
5051 \c{.SYS} files start with a header structure, containing pointers to
5052 the various routines inside the driver which do the work. This
5053 structure should be defined at the start of the code segment, even
5054 though it is not actually code.
5056 For more information on the format of \c{.SYS} files, and the data
5057 which has to go in the header structure, a list of books is given in
5058 the Frequently Asked Questions list for the newsgroup
5059 \W{news:comp.os.msdos.programmer}\i\c{comp.os.msdos.programmer}.
5062 \H{16c} Interfacing to 16-bit C Programs
5064 This section covers the basics of writing assembly routines that
5065 call, or are called from, C programs. To do this, you would
5066 typically write an assembly module as a \c{.OBJ} file, and link it
5067 with your C modules to produce a \i{mixed-language program}.
5070 \S{16cunder} External Symbol Names
5072 \I{C symbol names}\I{underscore, in C symbols}C compilers have the
5073 convention that the names of all global symbols (functions or data)
5074 they define are formed by prefixing an underscore to the name as it
5075 appears in the C program. So, for example, the function a C
5076 programmer thinks of as \c{printf} appears to an assembly language
5077 programmer as \c{_printf}. This means that in your assembly
5078 programs, you can define symbols without a leading underscore, and
5079 not have to worry about name clashes with C symbols.
5081 If you find the underscores inconvenient, you can define macros to
5082 replace the \c{GLOBAL} and \c{EXTERN} directives as follows:
5084 \c %macro  cglobal 1
5086 \c   global  _%1
5087 \c   %define %1 _%1
5089 \c %endmacro
5091 \c %macro  cextern 1
5093 \c   extern  _%1
5094 \c   %define %1 _%1
5096 \c %endmacro
5098 (These forms of the macros only take one argument at a time; a
5099 \c{%rep} construct could solve this.)
5101 If you then declare an external like this:
5103 \c cextern printf
5105 then the macro will expand it as
5107 \c extern  _printf
5108 \c %define printf _printf
5110 Thereafter, you can reference \c{printf} as if it was a symbol, and
5111 the preprocessor will put the leading underscore on where necessary.
5113 The \c{cglobal} macro works similarly. You must use \c{cglobal}
5114 before defining the symbol in question, but you would have had to do
5115 that anyway if you used \c{GLOBAL}.
5117 Also see \k{opt-pfix}.
5119 \S{16cmodels} \i{Memory Models}
5121 NASM contains no mechanism to support the various C memory models
5122 directly; you have to keep track yourself of which one you are
5123 writing for. This means you have to keep track of the following
5124 things:
5126 \b In models using a single code segment (tiny, small and compact),
5127 functions are near. This means that function pointers, when stored
5128 in data segments or pushed on the stack as function arguments, are
5129 16 bits long and contain only an offset field (the \c{CS} register
5130 never changes its value, and always gives the segment part of the
5131 full function address), and that functions are called using ordinary
5132 near \c{CALL} instructions and return using \c{RETN} (which, in
5133 NASM, is synonymous with \c{RET} anyway). This means both that you
5134 should write your own routines to return with \c{RETN}, and that you
5135 should call external C routines with near \c{CALL} instructions.
5137 \b In models using more than one code segment (medium, large and
5138 huge), functions are far. This means that function pointers are 32
5139 bits long (consisting of a 16-bit offset followed by a 16-bit
5140 segment), and that functions are called using \c{CALL FAR} (or
5141 \c{CALL seg:offset}) and return using \c{RETF}. Again, you should
5142 therefore write your own routines to return with \c{RETF} and use
5143 \c{CALL FAR} to call external routines.
5145 \b In models using a single data segment (tiny, small and medium),
5146 data pointers are 16 bits long, containing only an offset field (the
5147 \c{DS} register doesn't change its value, and always gives the
5148 segment part of the full data item address).
5150 \b In models using more than one data segment (compact, large and
5151 huge), data pointers are 32 bits long, consisting of a 16-bit offset
5152 followed by a 16-bit segment. You should still be careful not to
5153 modify \c{DS} in your routines without restoring it afterwards, but
5154 \c{ES} is free for you to use to access the contents of 32-bit data
5155 pointers you are passed.
5157 \b The huge memory model allows single data items to exceed 64K in
5158 size. In all other memory models, you can access the whole of a data
5159 item just by doing arithmetic on the offset field of the pointer you
5160 are given, whether a segment field is present or not; in huge model,
5161 you have to be more careful of your pointer arithmetic.
5163 \b In most memory models, there is a \e{default} data segment, whose
5164 segment address is kept in \c{DS} throughout the program. This data
5165 segment is typically the same segment as the stack, kept in \c{SS},
5166 so that functions' local variables (which are stored on the stack)
5167 and global data items can both be accessed easily without changing
5168 \c{DS}. Particularly large data items are typically stored in other
5169 segments. However, some memory models (though not the standard
5170 ones, usually) allow the assumption that \c{SS} and \c{DS} hold the
5171 same value to be removed. Be careful about functions' local
5172 variables in this latter case.
5174 In models with a single code segment, the segment is called
5175 \i\c{_TEXT}, so your code segment must also go by this name in order
5176 to be linked into the same place as the main code segment. In models
5177 with a single data segment, or with a default data segment, it is
5178 called \i\c{_DATA}.
5181 \S{16cfunc} Function Definitions and Function Calls
5183 \I{functions, C calling convention}The \i{C calling convention} in
5184 16-bit programs is as follows. In the following description, the
5185 words \e{caller} and \e{callee} are used to denote the function
5186 doing the calling and the function which gets called.
5188 \b The caller pushes the function's parameters on the stack, one
5189 after another, in reverse order (right to left, so that the first
5190 argument specified to the function is pushed last).
5192 \b The caller then executes a \c{CALL} instruction to pass control
5193 to the callee. This \c{CALL} is either near or far depending on the
5194 memory model.
5196 \b The callee receives control, and typically (although this is not
5197 actually necessary, in functions which do not need to access their
5198 parameters) starts by saving the value of \c{SP} in \c{BP} so as to
5199 be able to use \c{BP} as a base pointer to find its parameters on
5200 the stack. However, the caller was probably doing this too, so part
5201 of the calling convention states that \c{BP} must be preserved by
5202 any C function. Hence the callee, if it is going to set up \c{BP} as
5203 a \i\e{frame pointer}, must push the previous value first.
5205 \b The callee may then access its parameters relative to \c{BP}.
5206 The word at \c{[BP]} holds the previous value of \c{BP} as it was
5207 pushed; the next word, at \c{[BP+2]}, holds the offset part of the
5208 return address, pushed implicitly by \c{CALL}. In a small-model
5209 (near) function, the parameters start after that, at \c{[BP+4]}; in
5210 a large-model (far) function, the segment part of the return address
5211 lives at \c{[BP+4]}, and the parameters begin at \c{[BP+6]}. The
5212 leftmost parameter of the function, since it was pushed last, is
5213 accessible at this offset from \c{BP}; the others follow, at
5214 successively greater offsets. Thus, in a function such as \c{printf}
5215 which takes a variable number of parameters, the pushing of the
5216 parameters in reverse order means that the function knows where to
5217 find its first parameter, which tells it the number and type of the
5218 remaining ones.
5220 \b The callee may also wish to decrease \c{SP} further, so as to
5221 allocate space on the stack for local variables, which will then be
5222 accessible at negative offsets from \c{BP}.
5224 \b The callee, if it wishes to return a value to the caller, should
5225 leave the value in \c{AL}, \c{AX} or \c{DX:AX} depending on the size
5226 of the value. Floating-point results are sometimes (depending on the
5227 compiler) returned in \c{ST0}.
5229 \b Once the callee has finished processing, it restores \c{SP} from
5230 \c{BP} if it had allocated local stack space, then pops the previous
5231 value of \c{BP}, and returns via \c{RETN} or \c{RETF} depending on
5232 memory model.
5234 \b When the caller regains control from the callee, the function
5235 parameters are still on the stack, so it typically adds an immediate
5236 constant to \c{SP} to remove them (instead of executing a number of
5237 slow \c{POP} instructions). Thus, if a function is accidentally
5238 called with the wrong number of parameters due to a prototype
5239 mismatch, the stack will still be returned to a sensible state since
5240 the caller, which \e{knows} how many parameters it pushed, does the
5241 removing.
5243 It is instructive to compare this calling convention with that for
5244 Pascal programs (described in \k{16bpfunc}). Pascal has a simpler
5245 convention, since no functions have variable numbers of parameters.
5246 Therefore the callee knows how many parameters it should have been
5247 passed, and is able to deallocate them from the stack itself by
5248 passing an immediate argument to the \c{RET} or \c{RETF}
5249 instruction, so the caller does not have to do it. Also, the
5250 parameters are pushed in left-to-right order, not right-to-left,
5251 which means that a compiler can give better guarantees about
5252 sequence points without performance suffering.
5254 Thus, you would define a function in C style in the following way.
5255 The following example is for small model:
5257 \c global  _myfunc
5259 \c _myfunc:
5260 \c         push    bp
5261 \c         mov     bp,sp
5262 \c         sub     sp,0x40         ; 64 bytes of local stack space
5263 \c         mov     bx,[bp+4]       ; first parameter to function
5265 \c         ; some more code
5267 \c         mov     sp,bp           ; undo "sub sp,0x40" above
5268 \c         pop     bp
5269 \c         ret
5271 For a large-model function, you would replace \c{RET} by \c{RETF},
5272 and look for the first parameter at \c{[BP+6]} instead of
5273 \c{[BP+4]}. Of course, if one of the parameters is a pointer, then
5274 the offsets of \e{subsequent} parameters will change depending on
5275 the memory model as well: far pointers take up four bytes on the
5276 stack when passed as a parameter, whereas near pointers take up two.
5278 At the other end of the process, to call a C function from your
5279 assembly code, you would do something like this:
5281 \c extern  _printf
5283 \c       ; and then, further down...
5285 \c       push    word [myint]        ; one of my integer variables
5286 \c       push    word mystring       ; pointer into my data segment
5287 \c       call    _printf
5288 \c       add     sp,byte 4           ; `byte' saves space
5290 \c       ; then those data items...
5292 \c segment _DATA
5294 \c myint         dw    1234
5295 \c mystring      db    'This number -> %d <- should be 1234',10,0
5297 This piece of code is the small-model assembly equivalent of the C
5298 code
5300 \c     int myint = 1234;
5301 \c     printf("This number -> %d <- should be 1234\n", myint);
5303 In large model, the function-call code might look more like this. In
5304 this example, it is assumed that \c{DS} already holds the segment
5305 base of the segment \c{_DATA}. If not, you would have to initialize
5306 it first.
5308 \c       push    word [myint]
5309 \c       push    word seg mystring   ; Now push the segment, and...
5310 \c       push    word mystring       ; ... offset of "mystring"
5311 \c       call    far _printf
5312 \c       add    sp,byte 6
5314 The integer value still takes up one word on the stack, since large
5315 model does not affect the size of the \c{int} data type. The first
5316 argument (pushed last) to \c{printf}, however, is a data pointer,
5317 and therefore has to contain a segment and offset part. The segment
5318 should be stored second in memory, and therefore must be pushed
5319 first. (Of course, \c{PUSH DS} would have been a shorter instruction
5320 than \c{PUSH WORD SEG mystring}, if \c{DS} was set up as the above
5321 example assumed.) Then the actual call becomes a far call, since
5322 functions expect far calls in large model; and \c{SP} has to be
5323 increased by 6 rather than 4 afterwards to make up for the extra
5324 word of parameters.
5327 \S{16cdata} Accessing Data Items
5329 To get at the contents of C variables, or to declare variables which
5330 C can access, you need only declare the names as \c{GLOBAL} or
5331 \c{EXTERN}. (Again, the names require leading underscores, as stated
5332 in \k{16cunder}.) Thus, a C variable declared as \c{int i} can be
5333 accessed from assembler as
5335 \c extern _i
5337 \c         mov ax,[_i]
5339 And to declare your own integer variable which C programs can access
5340 as \c{extern int j}, you do this (making sure you are assembling in
5341 the \c{_DATA} segment, if necessary):
5343 \c global  _j
5345 \c _j      dw      0
5347 To access a C array, you need to know the size of the components of
5348 the array. For example, \c{int} variables are two bytes long, so if
5349 a C program declares an array as \c{int a[10]}, you can access
5350 \c{a[3]} by coding \c{mov ax,[_a+6]}. (The byte offset 6 is obtained
5351 by multiplying the desired array index, 3, by the size of the array
5352 element, 2.) The sizes of the C base types in 16-bit compilers are:
5353 1 for \c{char}, 2 for \c{short} and \c{int}, 4 for \c{long} and
5354 \c{float}, and 8 for \c{double}.
5356 To access a C \i{data structure}, you need to know the offset from
5357 the base of the structure to the field you are interested in. You
5358 can either do this by converting the C structure definition into a
5359 NASM structure definition (using \i\c{STRUC}), or by calculating the
5360 one offset and using just that.
5362 To do either of these, you should read your C compiler's manual to
5363 find out how it organizes data structures. NASM gives no special
5364 alignment to structure members in its own \c{STRUC} macro, so you
5365 have to specify alignment yourself if the C compiler generates it.
5366 Typically, you might find that a structure like
5368 \c struct {
5369 \c     char c;
5370 \c     int i;
5371 \c } foo;
5373 might be four bytes long rather than three, since the \c{int} field
5374 would be aligned to a two-byte boundary. However, this sort of
5375 feature tends to be a configurable option in the C compiler, either
5376 using command-line options or \c{#pragma} lines, so you have to find
5377 out how your own compiler does it.
5380 \S{16cmacro} \i\c{c16.mac}: Helper Macros for the 16-bit C Interface
5382 Included in the NASM archives, in the \I{misc subdirectory}\c{misc}
5383 directory, is a file \c{c16.mac} of macros. It defines three macros:
5384 \i\c{proc}, \i\c{arg} and \i\c{endproc}. These are intended to be
5385 used for C-style procedure definitions, and they automate a lot of
5386 the work involved in keeping track of the calling convention.
5388 (An alternative, TASM compatible form of \c{arg} is also now built
5389 into NASM's preprocessor. See \k{stackrel} for details.)
5391 An example of an assembly function using the macro set is given
5392 here:
5394 \c proc    _nearproc
5396 \c %$i     arg
5397 \c %$j     arg
5398 \c         mov     ax,[bp + %$i]
5399 \c         mov     bx,[bp + %$j]
5400 \c         add     ax,[bx]
5402 \c endproc
5404 This defines \c{_nearproc} to be a procedure taking two arguments,
5405 the first (\c{i}) an integer and the second (\c{j}) a pointer to an
5406 integer. It returns \c{i + *j}.
5408 Note that the \c{arg} macro has an \c{EQU} as the first line of its
5409 expansion, and since the label before the macro call gets prepended
5410 to the first line of the expanded macro, the \c{EQU} works, defining
5411 \c{%$i} to be an offset from \c{BP}. A context-local variable is
5412 used, local to the context pushed by the \c{proc} macro and popped
5413 by the \c{endproc} macro, so that the same argument name can be used
5414 in later procedures. Of course, you don't \e{have} to do that.
5416 The macro set produces code for near functions (tiny, small and
5417 compact-model code) by default. You can have it generate far
5418 functions (medium, large and huge-model code) by means of coding
5419 \I\c{FARCODE}\c{%define FARCODE}. This changes the kind of return
5420 instruction generated by \c{endproc}, and also changes the starting
5421 point for the argument offsets. The macro set contains no intrinsic
5422 dependency on whether data pointers are far or not.
5424 \c{arg} can take an optional parameter, giving the size of the
5425 argument. If no size is given, 2 is assumed, since it is likely that
5426 many function parameters will be of type \c{int}.
5428 The large-model equivalent of the above function would look like this:
5430 \c %define FARCODE
5432 \c proc    _farproc
5434 \c %$i     arg
5435 \c %$j     arg     4
5436 \c         mov     ax,[bp + %$i]
5437 \c         mov     bx,[bp + %$j]
5438 \c         mov     es,[bp + %$j + 2]
5439 \c         add     ax,[bx]
5441 \c endproc
5443 This makes use of the argument to the \c{arg} macro to define a
5444 parameter of size 4, because \c{j} is now a far pointer. When we
5445 load from \c{j}, we must load a segment and an offset.
5448 \H{16bp} Interfacing to \i{Borland Pascal} Programs
5450 Interfacing to Borland Pascal programs is similar in concept to
5451 interfacing to 16-bit C programs. The differences are:
5453 \b The leading underscore required for interfacing to C programs is
5454 not required for Pascal.
5456 \b The memory model is always large: functions are far, data
5457 pointers are far, and no data item can be more than 64K long.
5458 (Actually, some functions are near, but only those functions that
5459 are local to a Pascal unit and never called from outside it. All
5460 assembly functions that Pascal calls, and all Pascal functions that
5461 assembly routines are able to call, are far.) However, all static
5462 data declared in a Pascal program goes into the default data
5463 segment, which is the one whose segment address will be in \c{DS}
5464 when control is passed to your assembly code. The only things that
5465 do not live in the default data segment are local variables (they
5466 live in the stack segment) and dynamically allocated variables. All
5467 data \e{pointers}, however, are far.
5469 \b The function calling convention is different - described below.
5471 \b Some data types, such as strings, are stored differently.
5473 \b There are restrictions on the segment names you are allowed to
5474 use - Borland Pascal will ignore code or data declared in a segment
5475 it doesn't like the name of. The restrictions are described below.
5478 \S{16bpfunc} The Pascal Calling Convention
5480 \I{functions, Pascal calling convention}\I{Pascal calling
5481 convention}The 16-bit Pascal calling convention is as follows. In
5482 the following description, the words \e{caller} and \e{callee} are
5483 used to denote the function doing the calling and the function which
5484 gets called.
5486 \b The caller pushes the function's parameters on the stack, one
5487 after another, in normal order (left to right, so that the first
5488 argument specified to the function is pushed first).
5490 \b The caller then executes a far \c{CALL} instruction to pass
5491 control to the callee.
5493 \b The callee receives control, and typically (although this is not
5494 actually necessary, in functions which do not need to access their
5495 parameters) starts by saving the value of \c{SP} in \c{BP} so as to
5496 be able to use \c{BP} as a base pointer to find its parameters on
5497 the stack. However, the caller was probably doing this too, so part
5498 of the calling convention states that \c{BP} must be preserved by
5499 any function. Hence the callee, if it is going to set up \c{BP} as a
5500 \i{frame pointer}, must push the previous value first.
5502 \b The callee may then access its parameters relative to \c{BP}.
5503 The word at \c{[BP]} holds the previous value of \c{BP} as it was
5504 pushed. The next word, at \c{[BP+2]}, holds the offset part of the
5505 return address, and the next one at \c{[BP+4]} the segment part. The
5506 parameters begin at \c{[BP+6]}. The rightmost parameter of the
5507 function, since it was pushed last, is accessible at this offset
5508 from \c{BP}; the others follow, at successively greater offsets.
5510 \b The callee may also wish to decrease \c{SP} further, so as to
5511 allocate space on the stack for local variables, which will then be
5512 accessible at negative offsets from \c{BP}.
5514 \b The callee, if it wishes to return a value to the caller, should
5515 leave the value in \c{AL}, \c{AX} or \c{DX:AX} depending on the size
5516 of the value. Floating-point results are returned in \c{ST0}.
5517 Results of type \c{Real} (Borland's own custom floating-point data
5518 type, not handled directly by the FPU) are returned in \c{DX:BX:AX}.
5519 To return a result of type \c{String}, the caller pushes a pointer
5520 to a temporary string before pushing the parameters, and the callee
5521 places the returned string value at that location. The pointer is
5522 not a parameter, and should not be removed from the stack by the
5523 \c{RETF} instruction.
5525 \b Once the callee has finished processing, it restores \c{SP} from
5526 \c{BP} if it had allocated local stack space, then pops the previous
5527 value of \c{BP}, and returns via \c{RETF}. It uses the form of
5528 \c{RETF} with an immediate parameter, giving the number of bytes
5529 taken up by the parameters on the stack. This causes the parameters
5530 to be removed from the stack as a side effect of the return
5531 instruction.
5533 \b When the caller regains control from the callee, the function
5534 parameters have already been removed from the stack, so it needs to
5535 do nothing further.
5537 Thus, you would define a function in Pascal style, taking two
5538 \c{Integer}-type parameters, in the following way:
5540 \c global  myfunc
5542 \c myfunc: push    bp
5543 \c         mov     bp,sp
5544 \c         sub     sp,0x40         ; 64 bytes of local stack space
5545 \c         mov     bx,[bp+8]       ; first parameter to function
5546 \c         mov     bx,[bp+6]       ; second parameter to function
5548 \c         ; some more code
5550 \c         mov     sp,bp           ; undo "sub sp,0x40" above
5551 \c         pop     bp
5552 \c         retf    4               ; total size of params is 4
5554 At the other end of the process, to call a Pascal function from your
5555 assembly code, you would do something like this:
5557 \c extern  SomeFunc
5559 \c        ; and then, further down...
5561 \c        push   word seg mystring   ; Now push the segment, and...
5562 \c        push   word mystring       ; ... offset of "mystring"
5563 \c        push   word [myint]        ; one of my variables
5564 \c        call   far SomeFunc
5566 This is equivalent to the Pascal code
5568 \c procedure SomeFunc(String: PChar; Int: Integer);
5569 \c     SomeFunc(@mystring, myint);
5572 \S{16bpseg} Borland Pascal \I{segment names, Borland Pascal}Segment
5573 Name Restrictions
5575 Since Borland Pascal's internal unit file format is completely
5576 different from \c{OBJ}, it only makes a very sketchy job of actually
5577 reading and understanding the various information contained in a
5578 real \c{OBJ} file when it links that in. Therefore an object file
5579 intended to be linked to a Pascal program must obey a number of
5580 restrictions:
5582 \b Procedures and functions must be in a segment whose name is
5583 either \c{CODE}, \c{CSEG}, or something ending in \c{_TEXT}.
5585 \b initialized data must be in a segment whose name is either
5586 \c{CONST} or something ending in \c{_DATA}.
5588 \b Uninitialized data must be in a segment whose name is either
5589 \c{DATA}, \c{DSEG}, or something ending in \c{_BSS}.
5591 \b Any other segments in the object file are completely ignored.
5592 \c{GROUP} directives and segment attributes are also ignored.
5595 \S{16bpmacro} Using \i\c{c16.mac} With Pascal Programs
5597 The \c{c16.mac} macro package, described in \k{16cmacro}, can also
5598 be used to simplify writing functions to be called from Pascal
5599 programs, if you code \I\c{PASCAL}\c{%define PASCAL}. This
5600 definition ensures that functions are far (it implies
5601 \i\c{FARCODE}), and also causes procedure return instructions to be
5602 generated with an operand.
5604 Defining \c{PASCAL} does not change the code which calculates the
5605 argument offsets; you must declare your function's arguments in
5606 reverse order. For example:
5608 \c %define PASCAL
5610 \c proc    _pascalproc
5612 \c %$j     arg 4
5613 \c %$i     arg
5614 \c         mov     ax,[bp + %$i]
5615 \c         mov     bx,[bp + %$j]
5616 \c         mov     es,[bp + %$j + 2]
5617 \c         add     ax,[bx]
5619 \c endproc
5621 This defines the same routine, conceptually, as the example in
5622 \k{16cmacro}: it defines a function taking two arguments, an integer
5623 and a pointer to an integer, which returns the sum of the integer
5624 and the contents of the pointer. The only difference between this
5625 code and the large-model C version is that \c{PASCAL} is defined
5626 instead of \c{FARCODE}, and that the arguments are declared in
5627 reverse order.
5630 \C{32bit} Writing 32-bit Code (Unix, Win32, DJGPP)
5632 This chapter attempts to cover some of the common issues involved
5633 when writing 32-bit code, to run under \i{Win32} or Unix, or to be
5634 linked with C code generated by a Unix-style C compiler such as
5635 \i{DJGPP}. It covers how to write assembly code to interface with
5636 32-bit C routines, and how to write position-independent code for
5637 shared libraries.
5639 Almost all 32-bit code, and in particular all code running under
5640 \c{Win32}, \c{DJGPP} or any of the PC Unix variants, runs in \I{flat
5641 memory model}\e{flat} memory model. This means that the segment registers
5642 and paging have already been set up to give you the same 32-bit 4Gb
5643 address space no matter what segment you work relative to, and that
5644 you should ignore all segment registers completely. When writing
5645 flat-model application code, you never need to use a segment
5646 override or modify any segment register, and the code-section
5647 addresses you pass to \c{CALL} and \c{JMP} live in the same address
5648 space as the data-section addresses you access your variables by and
5649 the stack-section addresses you access local variables and procedure
5650 parameters by. Every address is 32 bits long and contains only an
5651 offset part.
5654 \H{32c} Interfacing to 32-bit C Programs
5656 A lot of the discussion in \k{16c}, about interfacing to 16-bit C
5657 programs, still applies when working in 32 bits. The absence of
5658 memory models or segmentation worries simplifies things a lot.
5661 \S{32cunder} External Symbol Names
5663 Most 32-bit C compilers share the convention used by 16-bit
5664 compilers, that the names of all global symbols (functions or data)
5665 they define are formed by prefixing an underscore to the name as it
5666 appears in the C program. However, not all of them do: the \c{ELF}
5667 specification states that C symbols do \e{not} have a leading
5668 underscore on their assembly-language names.
5670 The older Linux \c{a.out} C compiler, all \c{Win32} compilers,
5671 \c{DJGPP}, and \c{NetBSD} and \c{FreeBSD}, all use the leading
5672 underscore; for these compilers, the macros \c{cextern} and
5673 \c{cglobal}, as given in \k{16cunder}, will still work. For \c{ELF},
5674 though, the leading underscore should not be used.
5676 See also \k{opt-pfix}.
5678 \S{32cfunc} Function Definitions and Function Calls
5680 \I{functions, C calling convention}The \i{C calling convention}The C
5681 calling convention in 32-bit programs is as follows. In the
5682 following description, the words \e{caller} and \e{callee} are used
5683 to denote the function doing the calling and the function which gets
5684 called.
5686 \b The caller pushes the function's parameters on the stack, one
5687 after another, in reverse order (right to left, so that the first
5688 argument specified to the function is pushed last).
5690 \b The caller then executes a near \c{CALL} instruction to pass
5691 control to the callee.
5693 \b The callee receives control, and typically (although this is not
5694 actually necessary, in functions which do not need to access their
5695 parameters) starts by saving the value of \c{ESP} in \c{EBP} so as
5696 to be able to use \c{EBP} as a base pointer to find its parameters
5697 on the stack. However, the caller was probably doing this too, so
5698 part of the calling convention states that \c{EBP} must be preserved
5699 by any C function. Hence the callee, if it is going to set up
5700 \c{EBP} as a \i{frame pointer}, must push the previous value first.
5702 \b The callee may then access its parameters relative to \c{EBP}.
5703 The doubleword at \c{[EBP]} holds the previous value of \c{EBP} as
5704 it was pushed; the next doubleword, at \c{[EBP+4]}, holds the return
5705 address, pushed implicitly by \c{CALL}. The parameters start after
5706 that, at \c{[EBP+8]}. The leftmost parameter of the function, since
5707 it was pushed last, is accessible at this offset from \c{EBP}; the
5708 others follow, at successively greater offsets. Thus, in a function
5709 such as \c{printf} which takes a variable number of parameters, the
5710 pushing of the parameters in reverse order means that the function
5711 knows where to find its first parameter, which tells it the number
5712 and type of the remaining ones.
5714 \b The callee may also wish to decrease \c{ESP} further, so as to
5715 allocate space on the stack for local variables, which will then be
5716 accessible at negative offsets from \c{EBP}.
5718 \b The callee, if it wishes to return a value to the caller, should
5719 leave the value in \c{AL}, \c{AX} or \c{EAX} depending on the size
5720 of the value. Floating-point results are typically returned in
5721 \c{ST0}.
5723 \b Once the callee has finished processing, it restores \c{ESP} from
5724 \c{EBP} if it had allocated local stack space, then pops the previous
5725 value of \c{EBP}, and returns via \c{RET} (equivalently, \c{RETN}).
5727 \b When the caller regains control from the callee, the function
5728 parameters are still on the stack, so it typically adds an immediate
5729 constant to \c{ESP} to remove them (instead of executing a number of
5730 slow \c{POP} instructions). Thus, if a function is accidentally
5731 called with the wrong number of parameters due to a prototype
5732 mismatch, the stack will still be returned to a sensible state since
5733 the caller, which \e{knows} how many parameters it pushed, does the
5734 removing.
5736 There is an alternative calling convention used by Win32 programs
5737 for Windows API calls, and also for functions called \e{by} the
5738 Windows API such as window procedures: they follow what Microsoft
5739 calls the \c{__stdcall} convention. This is slightly closer to the
5740 Pascal convention, in that the callee clears the stack by passing a
5741 parameter to the \c{RET} instruction. However, the parameters are
5742 still pushed in right-to-left order.
5744 Thus, you would define a function in C style in the following way:
5746 \c global  _myfunc
5748 \c _myfunc:
5749 \c         push    ebp
5750 \c         mov     ebp,esp
5751 \c         sub     esp,0x40        ; 64 bytes of local stack space
5752 \c         mov     ebx,[ebp+8]     ; first parameter to function
5754 \c         ; some more code
5756 \c         leave                   ; mov esp,ebp / pop ebp
5757 \c         ret
5759 At the other end of the process, to call a C function from your
5760 assembly code, you would do something like this:
5762 \c extern  _printf
5764 \c         ; and then, further down...
5766 \c         push    dword [myint]   ; one of my integer variables
5767 \c         push    dword mystring  ; pointer into my data segment
5768 \c         call    _printf
5769 \c         add     esp,byte 8      ; `byte' saves space
5771 \c         ; then those data items...
5773 \c segment _DATA
5775 \c myint       dd   1234
5776 \c mystring    db   'This number -> %d <- should be 1234',10,0
5778 This piece of code is the assembly equivalent of the C code
5780 \c     int myint = 1234;
5781 \c     printf("This number -> %d <- should be 1234\n", myint);
5784 \S{32cdata} Accessing Data Items
5786 To get at the contents of C variables, or to declare variables which
5787 C can access, you need only declare the names as \c{GLOBAL} or
5788 \c{EXTERN}. (Again, the names require leading underscores, as stated
5789 in \k{32cunder}.) Thus, a C variable declared as \c{int i} can be
5790 accessed from assembler as
5792 \c           extern _i
5793 \c           mov eax,[_i]
5795 And to declare your own integer variable which C programs can access
5796 as \c{extern int j}, you do this (making sure you are assembling in
5797 the \c{_DATA} segment, if necessary):
5799 \c           global _j
5800 \c _j        dd 0
5802 To access a C array, you need to know the size of the components of
5803 the array. For example, \c{int} variables are four bytes long, so if
5804 a C program declares an array as \c{int a[10]}, you can access
5805 \c{a[3]} by coding \c{mov ax,[_a+12]}. (The byte offset 12 is obtained
5806 by multiplying the desired array index, 3, by the size of the array
5807 element, 4.) The sizes of the C base types in 32-bit compilers are:
5808 1 for \c{char}, 2 for \c{short}, 4 for \c{int}, \c{long} and
5809 \c{float}, and 8 for \c{double}. Pointers, being 32-bit addresses,
5810 are also 4 bytes long.
5812 To access a C \i{data structure}, you need to know the offset from
5813 the base of the structure to the field you are interested in. You
5814 can either do this by converting the C structure definition into a
5815 NASM structure definition (using \c{STRUC}), or by calculating the
5816 one offset and using just that.
5818 To do either of these, you should read your C compiler's manual to
5819 find out how it organizes data structures. NASM gives no special
5820 alignment to structure members in its own \i\c{STRUC} macro, so you
5821 have to specify alignment yourself if the C compiler generates it.
5822 Typically, you might find that a structure like
5824 \c struct {
5825 \c     char c;
5826 \c     int i;
5827 \c } foo;
5829 might be eight bytes long rather than five, since the \c{int} field
5830 would be aligned to a four-byte boundary. However, this sort of
5831 feature is sometimes a configurable option in the C compiler, either
5832 using command-line options or \c{#pragma} lines, so you have to find
5833 out how your own compiler does it.
5836 \S{32cmacro} \i\c{c32.mac}: Helper Macros for the 32-bit C Interface
5838 Included in the NASM archives, in the \I{misc directory}\c{misc}
5839 directory, is a file \c{c32.mac} of macros. It defines three macros:
5840 \i\c{proc}, \i\c{arg} and \i\c{endproc}. These are intended to be
5841 used for C-style procedure definitions, and they automate a lot of
5842 the work involved in keeping track of the calling convention.
5844 An example of an assembly function using the macro set is given
5845 here:
5847 \c proc    _proc32
5849 \c %$i     arg
5850 \c %$j     arg
5851 \c         mov     eax,[ebp + %$i]
5852 \c         mov     ebx,[ebp + %$j]
5853 \c         add     eax,[ebx]
5855 \c endproc
5857 This defines \c{_proc32} to be a procedure taking two arguments, the
5858 first (\c{i}) an integer and the second (\c{j}) a pointer to an
5859 integer. It returns \c{i + *j}.
5861 Note that the \c{arg} macro has an \c{EQU} as the first line of its
5862 expansion, and since the label before the macro call gets prepended
5863 to the first line of the expanded macro, the \c{EQU} works, defining
5864 \c{%$i} to be an offset from \c{BP}. A context-local variable is
5865 used, local to the context pushed by the \c{proc} macro and popped
5866 by the \c{endproc} macro, so that the same argument name can be used
5867 in later procedures. Of course, you don't \e{have} to do that.
5869 \c{arg} can take an optional parameter, giving the size of the
5870 argument. If no size is given, 4 is assumed, since it is likely that
5871 many function parameters will be of type \c{int} or pointers.
5874 \H{picdll} Writing NetBSD/FreeBSD/OpenBSD and Linux/ELF \i{Shared
5875 Libraries}
5877 \c{ELF} replaced the older \c{a.out} object file format under Linux
5878 because it contains support for \i{position-independent code}
5879 (\i{PIC}), which makes writing shared libraries much easier. NASM
5880 supports the \c{ELF} position-independent code features, so you can
5881 write Linux \c{ELF} shared libraries in NASM.
5883 \i{NetBSD}, and its close cousins \i{FreeBSD} and \i{OpenBSD}, take
5884 a different approach by hacking PIC support into the \c{a.out}
5885 format. NASM supports this as the \i\c{aoutb} output format, so you
5886 can write \i{BSD} shared libraries in NASM too.
5888 The operating system loads a PIC shared library by memory-mapping
5889 the library file at an arbitrarily chosen point in the address space
5890 of the running process. The contents of the library's code section
5891 must therefore not depend on where it is loaded in memory.
5893 Therefore, you cannot get at your variables by writing code like
5894 this:
5896 \c         mov     eax,[myvar]             ; WRONG
5898 Instead, the linker provides an area of memory called the
5899 \i\e{global offset table}, or \i{GOT}; the GOT is situated at a
5900 constant distance from your library's code, so if you can find out
5901 where your library is loaded (which is typically done using a
5902 \c{CALL} and \c{POP} combination), you can obtain the address of the
5903 GOT, and you can then load the addresses of your variables out of
5904 linker-generated entries in the GOT.
5906 The \e{data} section of a PIC shared library does not have these
5907 restrictions: since the data section is writable, it has to be
5908 copied into memory anyway rather than just paged in from the library
5909 file, so as long as it's being copied it can be relocated too. So
5910 you can put ordinary types of relocation in the data section without
5911 too much worry (but see \k{picglobal} for a caveat).
5914 \S{picgot} Obtaining the Address of the GOT
5916 Each code module in your shared library should define the GOT as an
5917 external symbol:
5919 \c extern  _GLOBAL_OFFSET_TABLE_   ; in ELF
5920 \c extern  __GLOBAL_OFFSET_TABLE_  ; in BSD a.out
5922 At the beginning of any function in your shared library which plans
5923 to access your data or BSS sections, you must first calculate the
5924 address of the GOT. This is typically done by writing the function
5925 in this form:
5927 \c func:   push    ebp
5928 \c         mov     ebp,esp
5929 \c         push    ebx
5930 \c         call    .get_GOT
5931 \c .get_GOT:
5932 \c         pop     ebx
5933 \c         add     ebx,_GLOBAL_OFFSET_TABLE_+$$-.get_GOT wrt ..gotpc
5935 \c         ; the function body comes here
5937 \c         mov     ebx,[ebp-4]
5938 \c         mov     esp,ebp
5939 \c         pop     ebp
5940 \c         ret
5942 (For BSD, again, the symbol \c{_GLOBAL_OFFSET_TABLE} requires a
5943 second leading underscore.)
5945 The first two lines of this function are simply the standard C
5946 prologue to set up a stack frame, and the last three lines are
5947 standard C function epilogue. The third line, and the fourth to last
5948 line, save and restore the \c{EBX} register, because PIC shared
5949 libraries use this register to store the address of the GOT.
5951 The interesting bit is the \c{CALL} instruction and the following
5952 two lines. The \c{CALL} and \c{POP} combination obtains the address
5953 of the label \c{.get_GOT}, without having to know in advance where
5954 the program was loaded (since the \c{CALL} instruction is encoded
5955 relative to the current position). The \c{ADD} instruction makes use
5956 of one of the special PIC relocation types: \i{GOTPC relocation}.
5957 With the \i\c{WRT ..gotpc} qualifier specified, the symbol
5958 referenced (here \c{_GLOBAL_OFFSET_TABLE_}, the special symbol
5959 assigned to the GOT) is given as an offset from the beginning of the
5960 section. (Actually, \c{ELF} encodes it as the offset from the operand
5961 field of the \c{ADD} instruction, but NASM simplifies this
5962 deliberately, so you do things the same way for both \c{ELF} and
5963 \c{BSD}.) So the instruction then \e{adds} the beginning of the section,
5964 to get the real address of the GOT, and subtracts the value of
5965 \c{.get_GOT} which it knows is in \c{EBX}. Therefore, by the time
5966 that instruction has finished, \c{EBX} contains the address of the GOT.
5968 If you didn't follow that, don't worry: it's never necessary to
5969 obtain the address of the GOT by any other means, so you can put
5970 those three instructions into a macro and safely ignore them:
5972 \c %macro  get_GOT 0
5974 \c         call    %%getgot
5975 \c   %%getgot:
5976 \c         pop     ebx
5977 \c         add     ebx,_GLOBAL_OFFSET_TABLE_+$$-%%getgot wrt ..gotpc
5979 \c %endmacro
5981 \S{piclocal} Finding Your Local Data Items
5983 Having got the GOT, you can then use it to obtain the addresses of
5984 your data items. Most variables will reside in the sections you have
5985 declared; they can be accessed using the \I{GOTOFF
5986 relocation}\c{..gotoff} special \I\c{WRT ..gotoff}\c{WRT} type. The
5987 way this works is like this:
5989 \c         lea     eax,[ebx+myvar wrt ..gotoff]
5991 The expression \c{myvar wrt ..gotoff} is calculated, when the shared
5992 library is linked, to be the offset to the local variable \c{myvar}
5993 from the beginning of the GOT. Therefore, adding it to \c{EBX} as
5994 above will place the real address of \c{myvar} in \c{EAX}.
5996 If you declare variables as \c{GLOBAL} without specifying a size for
5997 them, they are shared between code modules in the library, but do
5998 not get exported from the library to the program that loaded it.
5999 They will still be in your ordinary data and BSS sections, so you
6000 can access them in the same way as local variables, using the above
6001 \c{..gotoff} mechanism.
6003 Note that due to a peculiarity of the way BSD \c{a.out} format
6004 handles this relocation type, there must be at least one non-local
6005 symbol in the same section as the address you're trying to access.
6008 \S{picextern} Finding External and Common Data Items
6010 If your library needs to get at an external variable (external to
6011 the \e{library}, not just to one of the modules within it), you must
6012 use the \I{GOT relocations}\I\c{WRT ..got}\c{..got} type to get at
6013 it. The \c{..got} type, instead of giving you the offset from the
6014 GOT base to the variable, gives you the offset from the GOT base to
6015 a GOT \e{entry} containing the address of the variable. The linker
6016 will set up this GOT entry when it builds the library, and the
6017 dynamic linker will place the correct address in it at load time. So
6018 to obtain the address of an external variable \c{extvar} in \c{EAX},
6019 you would code
6021 \c         mov     eax,[ebx+extvar wrt ..got]
6023 This loads the address of \c{extvar} out of an entry in the GOT. The
6024 linker, when it builds the shared library, collects together every
6025 relocation of type \c{..got}, and builds the GOT so as to ensure it
6026 has every necessary entry present.
6028 Common variables must also be accessed in this way.
6031 \S{picglobal} Exporting Symbols to the Library User
6033 If you want to export symbols to the user of the library, you have
6034 to declare whether they are functions or data, and if they are data,
6035 you have to give the size of the data item. This is because the
6036 dynamic linker has to build \I{PLT}\i{procedure linkage table}
6037 entries for any exported functions, and also moves exported data
6038 items away from the library's data section in which they were
6039 declared.
6041 So to export a function to users of the library, you must use
6043 \c global  func:function           ; declare it as a function
6045 \c func:   push    ebp
6047 \c         ; etc.
6049 And to export a data item such as an array, you would have to code
6051 \c global  array:data array.end-array      ; give the size too
6053 \c array:  resd    128
6054 \c .end:
6056 Be careful: If you export a variable to the library user, by
6057 declaring it as \c{GLOBAL} and supplying a size, the variable will
6058 end up living in the data section of the main program, rather than
6059 in your library's data section, where you declared it. So you will
6060 have to access your own global variable with the \c{..got} mechanism
6061 rather than \c{..gotoff}, as if it were external (which,
6062 effectively, it has become).
6064 Equally, if you need to store the address of an exported global in
6065 one of your data sections, you can't do it by means of the standard
6066 sort of code:
6068 \c dataptr:        dd      global_data_item        ; WRONG
6070 NASM will interpret this code as an ordinary relocation, in which
6071 \c{global_data_item} is merely an offset from the beginning of the
6072 \c{.data} section (or whatever); so this reference will end up
6073 pointing at your data section instead of at the exported global
6074 which resides elsewhere.
6076 Instead of the above code, then, you must write
6078 \c dataptr:        dd      global_data_item wrt ..sym
6080 which makes use of the special \c{WRT} type \I\c{WRT ..sym}\c{..sym}
6081 to instruct NASM to search the symbol table for a particular symbol
6082 at that address, rather than just relocating by section base.
6084 Either method will work for functions: referring to one of your
6085 functions by means of
6087 \c funcptr:        dd      my_function
6089 will give the user the address of the code you wrote, whereas
6091 \c funcptr:        dd      my_function wrt .sym
6093 will give the address of the procedure linkage table for the
6094 function, which is where the calling program will \e{believe} the
6095 function lives. Either address is a valid way to call the function.
6098 \S{picproc} Calling Procedures Outside the Library
6100 Calling procedures outside your shared library has to be done by
6101 means of a \i\e{procedure linkage table}, or \i{PLT}. The PLT is
6102 placed at a known offset from where the library is loaded, so the
6103 library code can make calls to the PLT in a position-independent
6104 way. Within the PLT there is code to jump to offsets contained in
6105 the GOT, so function calls to other shared libraries or to routines
6106 in the main program can be transparently passed off to their real
6107 destinations.
6109 To call an external routine, you must use another special PIC
6110 relocation type, \I{PLT relocations}\i\c{WRT ..plt}. This is much
6111 easier than the GOT-based ones: you simply replace calls such as
6112 \c{CALL printf} with the PLT-relative version \c{CALL printf WRT
6113 ..plt}.
6116 \S{link} Generating the Library File
6118 Having written some code modules and assembled them to \c{.o} files,
6119 you then generate your shared library with a command such as
6121 \c ld -shared -o library.so module1.o module2.o       # for ELF
6122 \c ld -Bshareable -o library.so module1.o module2.o   # for BSD
6124 For ELF, if your shared library is going to reside in system
6125 directories such as \c{/usr/lib} or \c{/lib}, it is usually worth
6126 using the \i\c{-soname} flag to the linker, to store the final
6127 library file name, with a version number, into the library:
6129 \c ld -shared -soname library.so.1 -o library.so.1.2 *.o
6131 You would then copy \c{library.so.1.2} into the library directory,
6132 and create \c{library.so.1} as a symbolic link to it.
6135 \C{mixsize} Mixing 16 and 32 Bit Code
6137 This chapter tries to cover some of the issues, largely related to
6138 unusual forms of addressing and jump instructions, encountered when
6139 writing operating system code such as protected-mode initialisation
6140 routines, which require code that operates in mixed segment sizes,
6141 such as code in a 16-bit segment trying to modify data in a 32-bit
6142 one, or jumps between different-size segments.
6145 \H{mixjump} Mixed-Size Jumps\I{jumps, mixed-size}
6147 \I{operating system, writing}\I{writing operating systems}The most
6148 common form of \i{mixed-size instruction} is the one used when
6149 writing a 32-bit OS: having done your setup in 16-bit mode, such as
6150 loading the kernel, you then have to boot it by switching into
6151 protected mode and jumping to the 32-bit kernel start address. In a
6152 fully 32-bit OS, this tends to be the \e{only} mixed-size
6153 instruction you need, since everything before it can be done in pure
6154 16-bit code, and everything after it can be pure 32-bit.
6156 This jump must specify a 48-bit far address, since the target
6157 segment is a 32-bit one. However, it must be assembled in a 16-bit
6158 segment, so just coding, for example,
6160 \c         jmp     0x1234:0x56789ABC       ; wrong!
6162 will not work, since the offset part of the address will be
6163 truncated to \c{0x9ABC} and the jump will be an ordinary 16-bit far
6164 one.
6166 The Linux kernel setup code gets round the inability of \c{as86} to
6167 generate the required instruction by coding it manually, using
6168 \c{DB} instructions. NASM can go one better than that, by actually
6169 generating the right instruction itself. Here's how to do it right:
6171 \c         jmp     dword 0x1234:0x56789ABC         ; right
6173 \I\c{JMP DWORD}The \c{DWORD} prefix (strictly speaking, it should
6174 come \e{after} the colon, since it is declaring the \e{offset} field
6175 to be a doubleword; but NASM will accept either form, since both are
6176 unambiguous) forces the offset part to be treated as far, in the
6177 assumption that you are deliberately writing a jump from a 16-bit
6178 segment to a 32-bit one.
6180 You can do the reverse operation, jumping from a 32-bit segment to a
6181 16-bit one, by means of the \c{WORD} prefix:
6183 \c         jmp     word 0x8765:0x4321      ; 32 to 16 bit
6185 If the \c{WORD} prefix is specified in 16-bit mode, or the \c{DWORD}
6186 prefix in 32-bit mode, they will be ignored, since each is
6187 explicitly forcing NASM into a mode it was in anyway.
6190 \H{mixaddr} Addressing Between Different-Size Segments\I{addressing,
6191 mixed-size}\I{mixed-size addressing}
6193 If your OS is mixed 16 and 32-bit, or if you are writing a DOS
6194 extender, you are likely to have to deal with some 16-bit segments
6195 and some 32-bit ones. At some point, you will probably end up
6196 writing code in a 16-bit segment which has to access data in a
6197 32-bit segment, or vice versa.
6199 If the data you are trying to access in a 32-bit segment lies within
6200 the first 64K of the segment, you may be able to get away with using
6201 an ordinary 16-bit addressing operation for the purpose; but sooner
6202 or later, you will want to do 32-bit addressing from 16-bit mode.
6204 The easiest way to do this is to make sure you use a register for
6205 the address, since any effective address containing a 32-bit
6206 register is forced to be a 32-bit address. So you can do
6208 \c         mov     eax,offset_into_32_bit_segment_specified_by_fs
6209 \c         mov     dword [fs:eax],0x11223344
6211 This is fine, but slightly cumbersome (since it wastes an
6212 instruction and a register) if you already know the precise offset
6213 you are aiming at. The x86 architecture does allow 32-bit effective
6214 addresses to specify nothing but a 4-byte offset, so why shouldn't
6215 NASM be able to generate the best instruction for the purpose?
6217 It can. As in \k{mixjump}, you need only prefix the address with the
6218 \c{DWORD} keyword, and it will be forced to be a 32-bit address:
6220 \c         mov     dword [fs:dword my_offset],0x11223344
6222 Also as in \k{mixjump}, NASM is not fussy about whether the
6223 \c{DWORD} prefix comes before or after the segment override, so
6224 arguably a nicer-looking way to code the above instruction is
6226 \c         mov     dword [dword fs:my_offset],0x11223344
6228 Don't confuse the \c{DWORD} prefix \e{outside} the square brackets,
6229 which controls the size of the data stored at the address, with the
6230 one \c{inside} the square brackets which controls the length of the
6231 address itself. The two can quite easily be different:
6233 \c         mov     word [dword 0x12345678],0x9ABC
6235 This moves 16 bits of data to an address specified by a 32-bit
6236 offset.
6238 You can also specify \c{WORD} or \c{DWORD} prefixes along with the
6239 \c{FAR} prefix to indirect far jumps or calls. For example:
6241 \c         call    dword far [fs:word 0x4321]
6243 This instruction contains an address specified by a 16-bit offset;
6244 it loads a 48-bit far pointer from that (16-bit segment and 32-bit
6245 offset), and calls that address.
6248 \H{mixother} Other Mixed-Size Instructions
6250 The other way you might want to access data might be using the
6251 string instructions (\c{LODSx}, \c{STOSx} and so on) or the
6252 \c{XLATB} instruction. These instructions, since they take no
6253 parameters, might seem to have no easy way to make them perform
6254 32-bit addressing when assembled in a 16-bit segment.
6256 This is the purpose of NASM's \i\c{a16} and \i\c{a32} prefixes. If
6257 you are coding \c{LODSB} in a 16-bit segment but it is supposed to
6258 be accessing a string in a 32-bit segment, you should load the
6259 desired address into \c{ESI} and then code
6261 \c         a32     lodsb
6263 The prefix forces the addressing size to 32 bits, meaning that
6264 \c{LODSB} loads from \c{[DS:ESI]} instead of \c{[DS:SI]}. To access
6265 a string in a 16-bit segment when coding in a 32-bit one, the
6266 corresponding \c{a16} prefix can be used.
6268 The \c{a16} and \c{a32} prefixes can be applied to any instruction
6269 in NASM's instruction table, but most of them can generate all the
6270 useful forms without them. The prefixes are necessary only for
6271 instructions with implicit addressing:
6272 \# \c{CMPSx} (\k{insCMPSB}),
6273 \# \c{SCASx} (\k{insSCASB}), \c{LODSx} (\k{insLODSB}), \c{STOSx}
6274 \# (\k{insSTOSB}), \c{MOVSx} (\k{insMOVSB}), \c{INSx} (\k{insINSB}),
6275 \# \c{OUTSx} (\k{insOUTSB}), and \c{XLATB} (\k{insXLATB}).
6276 \c{CMPSx}, \c{SCASx}, \c{LODSx}, \c{STOSx}, \c{MOVSx}, \c{INSx},
6277 \c{OUTSx}, and \c{XLATB}.
6278 Also, the
6279 various push and pop instructions (\c{PUSHA} and \c{POPF} as well as
6280 the more usual \c{PUSH} and \c{POP}) can accept \c{a16} or \c{a32}
6281 prefixes to force a particular one of \c{SP} or \c{ESP} to be used
6282 as a stack pointer, in case the stack segment in use is a different
6283 size from the code segment.
6285 \c{PUSH} and \c{POP}, when applied to segment registers in 32-bit
6286 mode, also have the slightly odd behaviour that they push and pop 4
6287 bytes at a time, of which the top two are ignored and the bottom two
6288 give the value of the segment register being manipulated. To force
6289 the 16-bit behaviour of segment-register push and pop instructions,
6290 you can use the operand-size prefix \i\c{o16}:
6292 \c         o16 push    ss
6293 \c         o16 push    ds
6295 This code saves a doubleword of stack space by fitting two segment
6296 registers into the space which would normally be consumed by pushing
6297 one.
6299 (You can also use the \i\c{o32} prefix to force the 32-bit behaviour
6300 when in 16-bit mode, but this seems less useful.)
6303 \C{64bit} Writing 64-bit Code (Unix, Win64)
6305 This chapter attempts to cover some of the common issues involved when
6306 writing 64-bit code, to run under \i{Win64} or Unix.  It covers how to
6307 write assembly code to interface with 64-bit C routines, and how to
6308 write position-independent code for shared libraries.
6310 All 64-bit code uses a flat memory model, since segmentation is not
6311 available in 64-bit mode.  The one exception is the \c{FS} and \c{GS}
6312 registers, which still add their bases.
6314 Position independence in 64-bit mode is significantly simpler, since
6315 the processor supports \c{RIP}-relative addressing directly; see the
6316 \c{REL} keyword (\k{effaddr}).  On most 64-bit platforms, it is
6317 probably desirable to make that the default, using the directive
6318 \c{DEFAULT REL} (\k{default}).
6320 64-bit programming is relatively similar to 32-bit programming, but
6321 of course pointers are 64 bits long; additionally, all existing
6322 platforms pass arguments in registers rather than on the stack.
6323 Furthermore, 64-bit platforms use SSE2 by default for floating point.
6324 Please see the ABI documentation for your platform.
6326 64-bit platforms differ in the sizes of the fundamental datatypes, not
6327 just from 32-bit platforms but from each other.  If a specific size
6328 data type is desired, it is probably best to use the types defined in
6329 the Standard C header \c{<inttypes.h>}.
6331 In 64-bit mode, the default instruction size is still 32 bits.  When
6332 loading a value into a 32-bit register (but not an 8- or 16-bit
6333 register), the upper 32 bits of the corresponding 64-bit register are
6334 set to zero.
6336 \H{id64} Immediates and displacements in 64-bit mode
6338 In 64-bit mode, immediates and displacements are generally only 32
6339 bits wide.  NASM will therefore truncate most displacements and
6340 immediates to 32 bits.
6342 The only instruction which takes a full \i{64-bit immediate} is:
6344 \c      MOV reg64,imm64
6346 NASM will produce this instruction whenever the programmer uses
6347 \c{MOV} with an immediate into a 64-bit register.  If this is not
6348 desirable, simply specify the equivalent 32-bit register, which will
6349 be automatically zero-extended by the processor, or specify the
6350 immediate as \c{DWORD}:
6352 \c      mov rax,foo             ; 64-bit immediate
6353 \c      mov rax,qword foo       ; (identical)
6354 \c      mov eax,foo             ; 32-bit immediate, zero-extended
6355 \c      mov rax,dword foo       ; 32-bit immediate, sign-extended
6357 The length of these instructions are 10, 5 and 7 bytes, respectively.
6359 The only instructions which take a full \i{64-bit \e{displacement}} is
6360 loading or storing, using \c{MOV}, \c{AL}, \c{AX}, \c{EAX} or \c{RAX}
6361 (but no other registers) to an absolute 64-bit address.  Since this is
6362 a relatively rarely used instruction (64-bit code generally uses
6363 relative addressing), the programmer has to explicitly declare the
6364 displacement size as \c{QWORD}:
6366 \c      default abs
6368 \c      mov eax,[foo]           ; 32-bit absolute disp, sign-extended
6369 \c      mov eax,[a32 foo]       ; 32-bit absolute disp, zero-extended
6370 \c      mov eax,[qword foo]     ; 64-bit absolute disp
6372 \c      default rel
6374 \c      mov eax,[foo]           ; 32-bit relative disp
6375 \c      mov eax,[a32 foo]       ; d:o, address truncated to 32 bits(!)
6376 \c      mov eax,[qword foo]     ; error
6377 \c      mov eax,[abs qword foo] ; 64-bit absolute disp
6379 A sign-extended absolute displacement can access from -2 GB to +2 GB;
6380 a zero-extended absolute displacement can access from 0 to 4 GB.
6382 \H{unix64} Interfacing to 64-bit C Programs (Unix)
6384 On Unix, the 64-bit ABI is defined by the document:
6386 \W{http://www.x86-64.org/documentation/abi.pdf}\c{http://www.x86-64.org/documentation/abi.pdf}
6388 Although written for AT&T-syntax assembly, the concepts apply equally
6389 well for NASM-style assembly.  What follows is a simplified summary.
6391 The first six integer arguments (from the left) are passed in \c{RDI},
6392 \c{RSI}, \c{RDX}, \c{RCX}, \c{R8}, and \c{R9}, in that order.
6393 Additional integer arguments are passed on the stack.  These
6394 registers, plus \c{RAX}, \c{R10} and \c{R11} are destroyed by function
6395 calls, and thus are available for use by the function without saving.
6397 Integer return values are passed in \c{RAX} and \c{RDX}, in that order.
6399 Floating point is done using SSE registers, except for \c{long
6400 double}.  Floating-point arguments are passed in \c{XMM0} to \c{XMM7};
6401 return is \c{XMM0} and \c{XMM1}.  \c{long double} are passed on the
6402 stack, and returned in \c{ST(0)} and \c{ST(1)}.
6404 All SSE and x87 registers are destroyed by function calls.
6406 On 64-bit Unix, \c{long} is 64 bits.
6408 \H{win64} Interfacing to 64-bit C Programs (Win64)
6410 The Win64 ABI is described at:
6412 \W{http://msdn2.microsoft.com/en-gb/library/ms794533.aspx}\c{http://msdn2.microsoft.com/en-gb/library/ms794533.aspx}
6414 What follows is a simplified summary.
6416 The first four integer arguments are passwd in \c{RCX}, \c{RDX},
6417 \c{R8} and \c{R9}, in that order.  Additional integer arguments are
6418 passed on the stack.  These registers, plus \c{RAX}, \c{R10} and
6419 \c{R11} are destroyed by function calls, and thus are available for
6420 use by the function without saving.
6422 Integer return values are passed in \c{RAX} only.
6424 Floating point is done using SSE registers, except for \c{long
6425 double}.  Floating-point arguments are passed in \c{XMM0} to \c{XMM3};
6426 return is \c{XMM0} only.
6428 On Win64, \c{long} is 32 bits; \c{long long} or \c{_int64} is 64 bits.
6430 \C{trouble} Troubleshooting
6432 This chapter describes some of the common problems that users have
6433 been known to encounter with NASM, and answers them. It also gives
6434 instructions for reporting bugs in NASM if you find a difficulty
6435 that isn't listed here.
6438 \H{problems} Common Problems
6440 \S{inefficient} NASM Generates \i{Inefficient Code}
6442 We sometimes get `bug' reports about NASM generating inefficient, or
6443 even `wrong', code on instructions such as \c{ADD ESP,8}. This is a
6444 deliberate design feature, connected to predictability of output:
6445 NASM, on seeing \c{ADD ESP,8}, will generate the form of the
6446 instruction which leaves room for a 32-bit offset. You need to code
6447 \I\c{BYTE}\c{ADD ESP,BYTE 8} if you want the space-efficient form of
6448 the instruction. This isn't a bug, it's user error: if you prefer to
6449 have NASM produce the more efficient code automatically enable
6450 optimization with the \c{-On} option (see \k{opt-On}).
6453 \S{jmprange} My Jumps are Out of Range\I{out of range, jumps}
6455 Similarly, people complain that when they issue \i{conditional
6456 jumps} (which are \c{SHORT} by default) that try to jump too far,
6457 NASM reports `short jump out of range' instead of making the jumps
6458 longer.
6460 This, again, is partly a predictability issue, but in fact has a
6461 more practical reason as well. NASM has no means of being told what
6462 type of processor the code it is generating will be run on; so it
6463 cannot decide for itself that it should generate \i\c{Jcc NEAR} type
6464 instructions, because it doesn't know that it's working for a 386 or
6465 above. Alternatively, it could replace the out-of-range short
6466 \c{JNE} instruction with a very short \c{JE} instruction that jumps
6467 over a \c{JMP NEAR}; this is a sensible solution for processors
6468 below a 386, but hardly efficient on processors which have good
6469 branch prediction \e{and} could have used \c{JNE NEAR} instead. So,
6470 once again, it's up to the user, not the assembler, to decide what
6471 instructions should be generated. See \k{opt-On}.
6474 \S{proborg} \i\c{ORG} Doesn't Work
6476 People writing \i{boot sector} programs in the \c{bin} format often
6477 complain that \c{ORG} doesn't work the way they'd like: in order to
6478 place the \c{0xAA55} signature word at the end of a 512-byte boot
6479 sector, people who are used to MASM tend to code
6481 \c         ORG 0
6483 \c         ; some boot sector code
6485 \c         ORG 510
6486 \c         DW 0xAA55
6488 This is not the intended use of the \c{ORG} directive in NASM, and
6489 will not work. The correct way to solve this problem in NASM is to
6490 use the \i\c{TIMES} directive, like this:
6492 \c         ORG 0
6494 \c         ; some boot sector code
6496 \c         TIMES 510-($-$$) DB 0
6497 \c         DW 0xAA55
6499 The \c{TIMES} directive will insert exactly enough zero bytes into
6500 the output to move the assembly point up to 510. This method also
6501 has the advantage that if you accidentally fill your boot sector too
6502 full, NASM will catch the problem at assembly time and report it, so
6503 you won't end up with a boot sector that you have to disassemble to
6504 find out what's wrong with it.
6507 \S{probtimes} \i\c{TIMES} Doesn't Work
6509 The other common problem with the above code is people who write the
6510 \c{TIMES} line as
6512 \c         TIMES 510-$ DB 0
6514 by reasoning that \c{$} should be a pure number, just like 510, so
6515 the difference between them is also a pure number and can happily be
6516 fed to \c{TIMES}.
6518 NASM is a \e{modular} assembler: the various component parts are
6519 designed to be easily separable for re-use, so they don't exchange
6520 information unnecessarily. In consequence, the \c{bin} output
6521 format, even though it has been told by the \c{ORG} directive that
6522 the \c{.text} section should start at 0, does not pass that
6523 information back to the expression evaluator. So from the
6524 evaluator's point of view, \c{$} isn't a pure number: it's an offset
6525 from a section base. Therefore the difference between \c{$} and 510
6526 is also not a pure number, but involves a section base. Values
6527 involving section bases cannot be passed as arguments to \c{TIMES}.
6529 The solution, as in the previous section, is to code the \c{TIMES}
6530 line in the form
6532 \c         TIMES 510-($-$$) DB 0
6534 in which \c{$} and \c{$$} are offsets from the same section base,
6535 and so their difference is a pure number. This will solve the
6536 problem and generate sensible code.
6539 \H{bugs} \i{Bugs}\I{reporting bugs}
6541 We have never yet released a version of NASM with any \e{known}
6542 bugs. That doesn't usually stop there being plenty we didn't know
6543 about, though. Any that you find should be reported firstly via the
6544 \i\c{bugtracker} at
6545 \W{https://sourceforge.net/projects/nasm/}\c{https://sourceforge.net/projects/nasm/}
6546 (click on "Bugs"), or if that fails then through one of the
6547 contacts in \k{contact}.
6549 Please read \k{qstart} first, and don't report the bug if it's
6550 listed in there as a deliberate feature. (If you think the feature
6551 is badly thought out, feel free to send us reasons why you think it
6552 should be changed, but don't just send us mail saying `This is a
6553 bug' if the documentation says we did it on purpose.) Then read
6554 \k{problems}, and don't bother reporting the bug if it's listed
6555 there.
6557 If you do report a bug, \e{please} give us all of the following
6558 information:
6560 \b What operating system you're running NASM under. DOS, Linux,
6561 NetBSD, Win16, Win32, VMS (I'd be impressed), whatever.
6563 \b If you're running NASM under DOS or Win32, tell us whether you've
6564 compiled your own executable from the DOS source archive, or whether
6565 you were using the standard distribution binaries out of the
6566 archive. If you were using a locally built executable, try to
6567 reproduce the problem using one of the standard binaries, as this
6568 will make it easier for us to reproduce your problem prior to fixing
6571 \b Which version of NASM you're using, and exactly how you invoked
6572 it. Give us the precise command line, and the contents of the
6573 \c{NASMENV} environment variable if any.
6575 \b Which versions of any supplementary programs you're using, and
6576 how you invoked them. If the problem only becomes visible at link
6577 time, tell us what linker you're using, what version of it you've
6578 got, and the exact linker command line. If the problem involves
6579 linking against object files generated by a compiler, tell us what
6580 compiler, what version, and what command line or options you used.
6581 (If you're compiling in an IDE, please try to reproduce the problem
6582 with the command-line version of the compiler.)
6584 \b If at all possible, send us a NASM source file which exhibits the
6585 problem. If this causes copyright problems (e.g. you can only
6586 reproduce the bug in restricted-distribution code) then bear in mind
6587 the following two points: firstly, we guarantee that any source code
6588 sent to us for the purposes of debugging NASM will be used \e{only}
6589 for the purposes of debugging NASM, and that we will delete all our
6590 copies of it as soon as we have found and fixed the bug or bugs in
6591 question; and secondly, we would prefer \e{not} to be mailed large
6592 chunks of code anyway. The smaller the file, the better. A
6593 three-line sample file that does nothing useful \e{except}
6594 demonstrate the problem is much easier to work with than a
6595 fully fledged ten-thousand-line program. (Of course, some errors
6596 \e{do} only crop up in large files, so this may not be possible.)
6598 \b A description of what the problem actually \e{is}. `It doesn't
6599 work' is \e{not} a helpful description! Please describe exactly what
6600 is happening that shouldn't be, or what isn't happening that should.
6601 Examples might be: `NASM generates an error message saying Line 3
6602 for an error that's actually on Line 5'; `NASM generates an error
6603 message that I believe it shouldn't be generating at all'; `NASM
6604 fails to generate an error message that I believe it \e{should} be
6605 generating'; `the object file produced from this source code crashes
6606 my linker'; `the ninth byte of the output file is 66 and I think it
6607 should be 77 instead'.
6609 \b If you believe the output file from NASM to be faulty, send it to
6610 us. That allows us to determine whether our own copy of NASM
6611 generates the same file, or whether the problem is related to
6612 portability issues between our development platforms and yours. We
6613 can handle binary files mailed to us as MIME attachments, uuencoded,
6614 and even BinHex. Alternatively, we may be able to provide an FTP
6615 site you can upload the suspect files to; but mailing them is easier
6616 for us.
6618 \b Any other information or data files that might be helpful. If,
6619 for example, the problem involves NASM failing to generate an object
6620 file while TASM can generate an equivalent file without trouble,
6621 then send us \e{both} object files, so we can see what TASM is doing
6622 differently from us.
6625 \A{ndisasm} \i{Ndisasm}
6627                   The Netwide Disassembler, NDISASM
6629 \H{ndisintro} Introduction
6632 The Netwide Disassembler is a small companion program to the Netwide
6633 Assembler, NASM. It seemed a shame to have an x86 assembler,
6634 complete with a full instruction table, and not make as much use of
6635 it as possible, so here's a disassembler which shares the
6636 instruction table (and some other bits of code) with NASM.
6638 The Netwide Disassembler does nothing except to produce
6639 disassemblies of \e{binary} source files. NDISASM does not have any
6640 understanding of object file formats, like \c{objdump}, and it will
6641 not understand \c{DOS .EXE} files like \c{debug} will. It just
6642 disassembles.
6645 \H{ndisstart} Getting Started: Installation
6647 See \k{install} for installation instructions. NDISASM, like NASM,
6648 has a \c{man page} which you may want to put somewhere useful, if you
6649 are on a Unix system.
6652 \H{ndisrun} Running NDISASM
6654 To disassemble a file, you will typically use a command of the form
6656 \c        ndisasm -b {16|32|64} filename
6658 NDISASM can disassemble 16-, 32- or 64-bit code equally easily,
6659 provided of course that you remember to specify which it is to work
6660 with. If no \i\c{-b} switch is present, NDISASM works in 16-bit mode
6661 by default. The \i\c{-u} switch (for USE32) also invokes 32-bit mode.
6663 Two more command line options are \i\c{-r} which reports the version
6664 number of NDISASM you are running, and \i\c{-h} which gives a short
6665 summary of command line options.
6668 \S{ndiscom} COM Files: Specifying an Origin
6670 To disassemble a \c{DOS .COM} file correctly, a disassembler must assume
6671 that the first instruction in the file is loaded at address \c{0x100},
6672 rather than at zero. NDISASM, which assumes by default that any file
6673 you give it is loaded at zero, will therefore need to be informed of
6674 this.
6676 The \i\c{-o} option allows you to declare a different origin for the
6677 file you are disassembling. Its argument may be expressed in any of
6678 the NASM numeric formats: decimal by default, if it begins with `\c{$}'
6679 or `\c{0x}' or ends in `\c{H}' it's \c{hex}, if it ends in `\c{Q}' it's
6680 \c{octal}, and if it ends in `\c{B}' it's \c{binary}.
6682 Hence, to disassemble a \c{.COM} file:
6684 \c        ndisasm -o100h filename.com
6686 will do the trick.
6689 \S{ndissync} Code Following Data: Synchronisation
6691 Suppose you are disassembling a file which contains some data which
6692 isn't machine code, and \e{then} contains some machine code. NDISASM
6693 will faithfully plough through the data section, producing machine
6694 instructions wherever it can (although most of them will look
6695 bizarre, and some may have unusual prefixes, e.g. `\c{FS OR AX,0x240A}'),
6696 and generating `DB' instructions ever so often if it's totally stumped.
6697 Then it will reach the code section.
6699 Supposing NDISASM has just finished generating a strange machine
6700 instruction from part of the data section, and its file position is
6701 now one byte \e{before} the beginning of the code section. It's
6702 entirely possible that another spurious instruction will get
6703 generated, starting with the final byte of the data section, and
6704 then the correct first instruction in the code section will not be
6705 seen because the starting point skipped over it. This isn't really
6706 ideal.
6708 To avoid this, you can specify a `\i\c{synchronisation}' point, or indeed
6709 as many synchronisation points as you like (although NDISASM can
6710 only handle 8192 sync points internally). The definition of a sync
6711 point is this: NDISASM guarantees to hit sync points exactly during
6712 disassembly. If it is thinking about generating an instruction which
6713 would cause it to jump over a sync point, it will discard that
6714 instruction and output a `\c{db}' instead. So it \e{will} start
6715 disassembly exactly from the sync point, and so you \e{will} see all
6716 the instructions in your code section.
6718 Sync points are specified using the \i\c{-s} option: they are measured
6719 in terms of the program origin, not the file position. So if you
6720 want to synchronize after 32 bytes of a \c{.COM} file, you would have to
6723 \c        ndisasm -o100h -s120h file.com
6725 rather than
6727 \c        ndisasm -o100h -s20h file.com
6729 As stated above, you can specify multiple sync markers if you need
6730 to, just by repeating the \c{-s} option.
6733 \S{ndisisync} Mixed Code and Data: Automatic (Intelligent) Synchronisation
6734 \I\c{auto-sync}
6736 Suppose you are disassembling the boot sector of a \c{DOS} floppy (maybe
6737 it has a virus, and you need to understand the virus so that you
6738 know what kinds of damage it might have done you). Typically, this
6739 will contain a \c{JMP} instruction, then some data, then the rest of the
6740 code. So there is a very good chance of NDISASM being \e{misaligned}
6741 when the data ends and the code begins. Hence a sync point is
6742 needed.
6744 On the other hand, why should you have to specify the sync point
6745 manually? What you'd do in order to find where the sync point would
6746 be, surely, would be to read the \c{JMP} instruction, and then to use
6747 its target address as a sync point. So can NDISASM do that for you?
6749 The answer, of course, is yes: using either of the synonymous
6750 switches \i\c{-a} (for automatic sync) or \i\c{-i} (for intelligent
6751 sync) will enable \c{auto-sync} mode. Auto-sync mode automatically
6752 generates a sync point for any forward-referring PC-relative jump or
6753 call instruction that NDISASM encounters. (Since NDISASM is one-pass,
6754 if it encounters a PC-relative jump whose target has already been
6755 processed, there isn't much it can do about it...)
6757 Only PC-relative jumps are processed, since an absolute jump is
6758 either through a register (in which case NDISASM doesn't know what
6759 the register contains) or involves a segment address (in which case
6760 the target code isn't in the same segment that NDISASM is working
6761 in, and so the sync point can't be placed anywhere useful).
6763 For some kinds of file, this mechanism will automatically put sync
6764 points in all the right places, and save you from having to place
6765 any sync points manually. However, it should be stressed that
6766 auto-sync mode is \e{not} guaranteed to catch all the sync points, and
6767 you may still have to place some manually.
6769 Auto-sync mode doesn't prevent you from declaring manual sync
6770 points: it just adds automatically generated ones to the ones you
6771 provide. It's perfectly feasible to specify \c{-i} \e{and} some \c{-s}
6772 options.
6774 Another caveat with auto-sync mode is that if, by some unpleasant
6775 fluke, something in your data section should disassemble to a
6776 PC-relative call or jump instruction, NDISASM may obediently place a
6777 sync point in a totally random place, for example in the middle of
6778 one of the instructions in your code section. So you may end up with
6779 a wrong disassembly even if you use auto-sync. Again, there isn't
6780 much I can do about this. If you have problems, you'll have to use
6781 manual sync points, or use the \c{-k} option (documented below) to
6782 suppress disassembly of the data area.
6785 \S{ndisother} Other Options
6787 The \i\c{-e} option skips a header on the file, by ignoring the first N
6788 bytes. This means that the header is \e{not} counted towards the
6789 disassembly offset: if you give \c{-e10 -o10}, disassembly will start
6790 at byte 10 in the file, and this will be given offset 10, not 20.
6792 The \i\c{-k} option is provided with two comma-separated numeric
6793 arguments, the first of which is an assembly offset and the second
6794 is a number of bytes to skip. This \e{will} count the skipped bytes
6795 towards the assembly offset: its use is to suppress disassembly of a
6796 data section which wouldn't contain anything you wanted to see
6797 anyway.
6800 \H{ndisbugs} Bugs and Improvements
6802 There are no known bugs. However, any you find, with patches if
6803 possible, should be sent to
6804 \W{mailto:nasm-bugs@lists.sourceforge.net}\c{nasm-bugs@lists.sourceforge.net}, or to the
6805 developer's site at
6806 \W{https://sourceforge.net/projects/nasm/}\c{https://sourceforge.net/projects/nasm/}
6807 and we'll try to fix them. Feel free to send contributions and
6808 new features as well.