preproc: Fix out of range access in expand mmacro
[nasm.git] / doc / changes.src
blob80415f8adb1b82101f149dd6e1b6336fdd23bf0f
1 \#
2 \# NASM revision history in nasmdoc format
3 \#
5 \H{cl-2.xx} NASM 2 Series
7 The NASM 2 series supports x86-64, and is the production version of NASM
8 since 2007.
10 \S{cl-2.14} Version 2.14
12 \b Fixed out of bound access in certain \c{EQU} parsing.
14 \b Fixed buffer underflow in float parsing.
16 \b Added \c{SGX} (Intel Software Guard Extensions) instructions.
18 \b Added \c{+n} syntax for multiple contiguous registers.
20 \b Fixed \c{subsections_via_symbols} for \c{macho} object format.
22 \b Added the \c{--gprefix}, \c{--gpostfix}, \c{--lprefix}, and
23 \c{--lpostfix} command line options, to allow command line base symbol
24 renaming. See \k{opt-pfix}.
26 \b Allow label renaming to be specified by \c{%pragma} in addition to
27 from the command line.  See \k{mangling}.
29 \b Supported generic \c{%pragma} namespaces, \c{output} and \c{debug}. See
30 \k{gen-namespace}.
32 \b Added the \c{--pragma} command line option to inject a \c{%pragma}
33 directive.  See \k{opt-pragma}.
35 \b Added the \c{--before} command line option to accept preprocess
36 statement before input. See \k{opt-before}.
38 \b Added \c{AVX512} \c{VBMI2} (Additional Bit Manipulation), \c{VNNI} (Vector
39 Neural Network), \c{BITALG} (Bit Algorithm), and \c{GFNI} (Galois Field New
40 Instruction) instructions.
42 \b Added the \c{STATIC} directive for local symbols that should be
43 renamed using global-symbol rules. See \k{static}.
45 \b Allow a symbol to be defined as \c{EXTERN} and then later
46 overridden as \c{GLOBAL} or \c{COMMON}. Furthermore, a symbol declared
47 \c{EXTERN} and then defined will be treated as \c{GLOBAL}. See \k{extern}.
49 \b The \c{GLOBAL} directive no longer is required to precede the
50 definition of the symbol.
52 \b Support \c{private_extern} as \c{macho} specific extension to the
53 \c{GLOBAL} directive. See \k{macho-pext}.
55 \b Updated \c{UD0} encoding to match with the specification
57 \b Added the \c{--limit-X} command line option to set execution
58 limits. See \k{opt-limit}.
60 \b Updated the \c{Codeview} version number to be aligned with \c{MASM}.
62 \b Added the \c{--keep-all} command line option to preserve output
63 files. See \k{opt-keep-all}.
65 \b Added the \c{--include} command line option, an alias to \c{-P} (\k{opt-p}).
67 \b Added the \c{--help} command line option as an alias to \c{-h} (\k{syntax}).
69 \b Added \c{-W}, \c{-D}, and \c{-Q} suffix aliases for \c{RET}
70    instructions so the operand sizes of these instructions can be
71    encoded without using \c{o16}, \c{o32} or \c{o64}.
73 \S{cl-2.13.03} Version 2.13.03
75 \b Added AVX and AVX512 \c{VAES*} and \c{VPCLMULQDQ} instructions.
77 \b Fixed missing dwarf record in x32 ELF output format.
79 \S{cl-2.13.02} Version 2.13.02
81 \b Fix false positive in testing of numeric overflows.
83 \b Fix generation of \c{PEXTRW} instruction.
85 \b Fix \c{smartalign} package which could trigger an error during
86    optimization if the alignment code expanded too much due to
87    optimization of the previous code.
89 \b Fix a case where negative value in \c{TIMES} directive causes
90    panic instead of an error.
92 \b Always finalize \c{.debug_abbrev} section with a null in
93    \c{dwarf} output format.
95 \b Support \c{debug} flag in section attributes for \c{macho}
96    output format.  See \k{machosect}.
98 \b Support up to 16 characters in section names for \c{macho}
99    output format.
101 \b Fix missing update of global \c{BITS} setting if \c{SECTION}
102    directive specified a bit size using output format-specific
103    extensions (e.g. \c{USE32} for the \c{obj} output format.)
105 \b Fix the incorrect generation of VEX-encoded instruction when static
106    mode decorators are specified on scalar instructions, losing the
107    decorators as they require EVEX encoding.
109 \b Option \c{-MW} to quote dependency outputs according to Watcom
110    Make conventions instead of POSIX Make conventions.  See \k{opt-MW}.
112 \b The \c{obj} output format now contains embedded dependency file
113    information, unless disabled with \c{%pragma obj nodepend}.  See
114    \k{objdepend}.
116 \b Fix generation of dependency lists.
118 \b Fix a number of null pointer reference and memory allocation errors.
120 \b Always generate symbol-relative relocations for the \c{macho64}
121    output format; at least some versions of the XCode/LLVM linker fails
122    for section-relative relocations.
124 \S{cl-2.13.01} Version 2.13.01
126 \b Fix incorrect output for some types of \c{FAR} or \c{SEG}
127    references in the \c{obj} output format, and possibly other 16-bit
128    output formats.
130 \b Fix the address in the list file for an instruction containing a
131    \c{TIMES} directive.
133 \b Fix error with \c{TIMES} used together with an instruction which
134    can vary in size, e.g. \c{JMP}.
136 \b Fix breakage on some uses of the \c{DZ} pseudo-op.
138 \S{cl-2.13} Version 2.13
140 \b Support the official forms of the \c{UD0} and \c{UD1} instructions.
142 \b Allow self-segment-relative expressions in immediates and
143    displacements, even when combined with an external or otherwise
144    out-of-segment special symbol, e.g.:
146 \c      extern foo
147 \c      mov eax,[foo - $ + ebx]               ; Now legal
149 \b Handle a 64-bit origin in NDISASM.
151 \b NASM can now generate sparse output files for relevant output
152    formats, if the underlying operating system supports them.
154 \b The \c{macho} object format now supports the \c{subsections_via_symbols}
155    and \c{no_dead_strip} directives, see \k{macho-ssvs}.
157 \b The \c{macho} object format now supports the \c{no_dead_strip},
158   \c{live_support} and \c{strip_static_syms} section flags, see
159   \k{machosect}.
161 \b The \c{macho} object format now supports the \c{dwarf} debugging
162   format, as required by newer toolchains.
164 \b All warnings can now be suppressed if desired; warnings not
165    otherwise part of any warning class are now considered its own
166    warning class called \c{other} (e.g. \c{-w-other}).  Furthermore,
167    warning-as-error can now be controlled on a per warning class
168    basis, using the syntax \c{-w+error=}\e{warning-class} and its
169    equivalent for all other warning control options.  See \k{opt-w}
170    for the command-line options and warning classes and
171    \k{asmdir-warning} for the \c{[WARNING]} directive.
173 \b Fix a number of bugs related to AVX-512 decorators.
175 \b Significant improvements to building NASM with Microsoft Visual
176    Studio via \c{Mkfiles/msvc.mak}.  It is now possible to build the
177    full Windows installer binary as long as the necessary
178    prerequisites are installed; see \c{Mkfiles/README}
180 \b To build NASM with custom modifications (table changes) or from the
181    git tree now requires Perl 5.8 at the very minimum, quite possibly
182    a higher version (Perl 5.24.1 tested.)  There is no requirement to
183    have Perl on your system at all if all you want to do is build
184    unmodified NASM from source archives.
186 \b Fix the \c{\{z\}} decorator on AVX-512 \c{VMOVDQ*} instructions.
188 \b Add new warnings for certain dangerous constructs which never ought
189    to have been allowed.  In particular, the \c{RESB} family of
190    instructions should have been taking a critical expression all
191    along.
193 \b Fix the EVEX (AVX-512) versions of the \c{VPBROADCAST}, \c{VPEXTR},
194    and \c{VPINSR} instructions.
196 \b Support contracted forms of additional instructions.  As a general
197    rule, if an instruction has a non-destructive source immediately
198    after a destination register that isn't used as an input, NASM
199    supports omitting that source register, using the destination
200    register as that value.  This among other things makes it easier to
201    convert SSE code to the equivalent AVX code:
203 \c      addps xmm1,xmm0                       ; SSE instruction
204 \c      vaddps ymm1,ymm1,ymm0                 ; AVX official long form
205 \c      vaddps ymm1,ymm0                      ; AVX contracted form
207 \b Fix Codeview malformed compiler version record.
209 \b Add the \c{CLWB} and \c{PCOMMIT} instructions.  Note that the
210    \c{PCOMMIT} instruction has been deprecated and will never be
211    included in a shipping product; it is included for completeness
212    only.
214 \b Add the \c{%pragma} preprocessor directive for soft-error directives.
216 \b Add the \c{RDPID} instruction.
218 \S{cl-2.12.02} Version 2.12.02
220 \b Fix preprocessor errors, especially \c{%error} and \c{%warning},
221    inside \c{%if} statements.
223 \b Fix relative relocations in 32-bit Mach-O.
225 \b More Codeview debug format fixes.
227 \b If the MASM \c{PTR} keyword is encountered, issue a warning.  This is
228    much more likely to indicate a MASM-ism encountered in NASM than it
229    is a valid label.  This warning can be suppressed with \c{-w-ptr},
230    the \c{[warning]} directive (see \k{opt-w}) or by the macro
231    definition \c{%idefine ptr $%?} (see \k{selfref%?}).
233 \b When an error or a warning comes from the expansion of a multi-line
234    macro, display the file and line numbers for the expanded macros.
235    Macros defined with \c{.nolist} do not get displayed.
237 \b Add macros \c{ilog2fw()} and \c{ilog2cw()} to the \c{ifunc} macro
238    package.  See \k{ilog2}.
241 \S{cl-2.12.01} Version 2.12.01
243 \b Portability fixes for some platforms.
245 \b Fix error when not specifying a list file.
247 \b Correct the handling of macro-local labels in the Codeview
248    debugging format.
250 \b Add \c{CLZERO}, \c{MONITORX} and \c{MWAITX} instructions.
253 \S{cl-2.12} Version 2.12
255 \b Major fixes to the \c{macho} backend (\k{machofmt}); earlier versions
256    would produce invalid symbols and relocations on a regular basis.
258 \b Support for thread-local storage in Mach-O.
260 \b Support for arbitrary sections in Mach-O.
262 \b Fix wrong negative size treated as a big positive value passed into
263    backend causing NASM to crash.
265 \b Fix handling of zero-extending unsigned relocations, we have been printing
266    wrong message and forgot to assign segment with predefined value before
267    passing it into output format.
269 \b Fix potential write of oversized (with size greater than allowed in
270    output format) relative relocations.
272 \b Portability fixes for building NASM with the LLVM compiler.
274 \b Add support of Codeview version 8 (\c{cv8}) debug format for
275    \c{win32} and \c{win64} formats in the \c{COFF} backend,
276    see \k{codeview}.
278 \b Allow 64-bit outputs in 16/32-bit only backends.  Unsigned 64-bit
279    relocations are zero-extended from 32-bits with a warning
280    (suppressible via \c{-w-zext-reloc}); signed 64-bit relocations are
281    an error.
283 \b Line numbers in list files now correspond to the lines in the source
284    files, instead of simply being sequential.
286 \b There is now an official 64-bit (x64 a.k.a. x86-64) build for Windows.
289 \S{cl-2.11.09} Version 2.11.09
291 \b Fix potential stack overwrite in \c{macho32} backend.
293 \b Fix relocation records in \c{macho64} backend.
295 \b Fix symbol lookup computation in \c{macho64} backend.
297 \b Adjust \c{.symtab} and \c{.rela.text} sections alignments to 8 bytes
298    in \c{elf64} backed.
300 \b Fix section length computation in \c{bin} backend which leaded in incorrect
301    relocation records.
303 \S{cl-2.11.08} Version 2.11.08
305 \b Fix section length computation in \c{bin} backend which leaded in incorrect
306    relocation records.
308 \b Add a warning for numeric preprocessor definitions passed via command
309    line which might have unexpected results otherwise.
311 \b Add ability to specify a module name record in \c{rdoff} linker with
312    \c{-mn} option.
314 \b Increase label length capacity up to 256 bytes in \c{rdoff} backend for
315    FreePascal sake, which tends to generate very long labels for procedures.
317 \b Fix segmentation failure when rip addressing is used in \c{macho64} backend.
319 \b Fix access on out of memory when handling strings with a single
320    grave. We have sixed similar problem in previous release but not
321    all cases were covered.
323 \b Fix NULL dereference in disassembled on \c{BND} instruction.
325 \S{cl-2.11.07} Version 2.11.07
327 \b Fix 256 bit \c{VMOVNTPS} instruction.
329 \b Fix \c{-MD} option handling, which was rather broken in previous
330 release changing command line api.
332 \b Fix access to unitialized space when handling strings with
333 a single grave.
335 \b Fix nil dereference in handling memory reference parsing.
337 \S{cl-2.11.06} Version 2.11.06
339 \b Update AVX512 instructions based on the Extension Reference (319433-021 Sept
340 2014).
342 \b Fix the behavior of \c{-MF} and \c{-MD} options (Bugzilla 3392280)
344 \b Updated Win32 Makefile to fix issue with build
346 \S{cl-2.11.05} Version 2.11.05
348 \b Add \c{--v} as an alias for \c{-v} (see \k{opt-v}), for
349 command-line compatibility with Yasm.
351 \b Fix a bug introduced in 2.11.03 whereby certain instructions would
352 contain multiple REX prefixes, and thus be corrupt.
354 \S{cl-2.11.04} Version 2.11.04
356 \b Removed an invalid error checking code. Sometimes a memref only with
357 a displacement can also set an evex flag. For example:
359 \c       vmovdqu32 [0xabcd]{k1}, zmm0
361 \b Fixed a bug in disassembler that EVEX.L'L vector length was not matched
362 when EVEX.b was set because it was simply considered as EVEC.RC.
363 Separated EVEX.L'L case from EVEX.RC which is ignored in matching.
365 \S{cl-2.11.03} Version 2.11.03
367 \b Fix a bug there REX prefixes were missing on instructions inside a
368 \c{TIMES} statement.
370 \S{cl-2.11.02} Version 2.11.02
372 \b Add the \c{XSAVEC}, \c{XSAVES} and \c{XRSTORS} family instructions.
374 \b Add the \c{CLFLUSHOPT} instruction.
376 \S{cl-2.11.01} Version 2.11.01
378 \b Allow instructions which implicitly uses \c{XMM0} (\c{VBLENDVPD},
379 \c{VBLENDVPS}, \c{PBLENDVB} and \c{SHA256RNDS2}) to be specified
380 without an explicit \c{xmm0} on the assembly line.  In other words,
381 the following two lines produce the same output:
383 \c      vblendvpd xmm2,xmm1,xmm0      ; Last operand is fixed xmm0
384 \c      vblendvpd xmm2,xmm1           ; Implicit xmm0 omitted
386 \b In the ELF backends, don't crash the assembler if \c{section align}
387 is specified without a value.
389 \S{cl-2.11} Version 2.11
391 \b Add support for the Intel AVX-512 instruction set:
393 \b 16 new, 512-bit SIMD registers. Total 32 \c{(ZMM0 ~ ZMM31)}
395 \b 8 new opmask registers \c{(K0 ~ K7)}. One of 7 registers \c{(K1 ~ K7)} can
396 be used as an opmask for conditional execution.
398 \b A new EVEX encoding prefix. EVEX is based on VEX and provides more
399 capabilities: opmasks, broadcasting, embedded rounding and compressed
400 displacements.
402 \c  - opmask
403 \c      VDIVPD zmm0{k1}{z}, zmm1, zmm3  ; conditional vector operation
404 \c                                      ; using opmask k1.
405 \c                                      ; {z} is for zero-masking
406 \c  - broadcasting
407 \c      VDIVPS zmm4, zmm5, [rbx]{1to16} ; load single-precision float and
408 \c                                      ; replicate it 16 times. 32 * 16 = 512
409 \c  - embedded rounding
410 \c      VCVTSI2SD xmm6, xmm7, {rz-sae}, rax ; round toward zero. note that it
411 \c                                       ; is used as if a separate operand.
412 \c                                       ; it comes after the last SIMD operand
414 \b Add support for \c{ZWORD} (512 bits), \c{DZ} and \c{RESZ}.
416 \b Add support for the MPX and SHA instruction sets.
418 \b Better handling of section redefinition.
420 \b Generate manpages when running \c{'make dist'}.
422 \b Handle all token chains in mmacro params range.
424 \b Support split [base,index] effective address:
426 \c      mov eax,[eax+8,ecx*4]   ; eax=base, ecx=index, 4=scale, 8=disp
428 This is expected to be most useful for the MPX instructions.
430 \b Support \c{BND} prefix for branch instructions (for MPX).
432 \b The \c{DEFAULT} directive can now take \c{BND} and \c{NOBND}
433 options to indicate whether all relevant branches should be getting
434 \c{BND} prefixes.  This is expected to be the normal for use in MPX
435 code.
437 \b Add \c{{evex}}, \c{{vex3}} and \c{{vex2}} instruction prefixes to
438 have NASM encode the corresponding instruction, if possible, with an EVEX,
439 3-byte VEX, or 2-byte VEX prefix, respectively.
441 \b Support for section names longer than 8 bytes in Win32/Win64 COFF.
443 \b The \c{NOSPLIT} directive by itself no longer forces a single
444 register to become an index register, unless it has an explicit
445 multiplier.
447 \c      mov eax,[nosplit eax]       ; eax as base register
448 \c      mov eax,[nosplit eax*1]     ; eax as index register
450 \S{cl-2.10.09} Version 2.10.09
452 \b Pregenerate man pages.
454 \S{cl-2.10.08} Version 2.10.08
456 \b Fix \c{VMOVNTDQA}, \c{MOVNTDQA} and \c{MOVLPD} instructions.
458 \b Fix collision for \c{VGATHERQPS}, \c{VPGATHERQD} instructions.
460 \b Fix \c{VPMOVSXBQ}, \c{VGATHERQPD}, \c{VSPLLW} instructions.
462 \b Add a bunch of AMD TBM instructions.
464 \b Fix potential stack overwrite in numbers conversion.
466 \b Allow byte size in \c{PREFETCHTx} instructions.
468 \b Make manual pages up to date.
470 \b Make \c{F3} and \c{F2} SSE prefixes to override \c{66}.
472 \b Support of AMD SVM instructions in 32 bit mode.
474 \b Fix near offsets code generation for \c{JMP}, \c{CALL} instrictions
475 in long mode.
477 \b Fix preprocessor parse regression when id is expanding to a whitespace.
479 \S{cl-2.10.07} Version 2.10.07
481 \b Fix line continuation parsing being broken in previous version.
483 \S{cl-2.10.06} Version 2.10.06
485 \b Always quote the dependency source names when using the automatic
486 dependency generation options.
488 \b If no dependency target name is specified via the \c{-MT} or
489 \c{-MQ} options, quote the default output name.
491 \b Fix assembly of shift operations in \c{CPU 8086} mode.
493 \b Fix incorrect generation of explicit immediate byte for shift by 1
494 under certain circumstances.
496 \b Fix assembly of the \c{VPCMPGTQ} instruction.
498 \b Fix RIP-relative relocations in the \c{macho64} backend.
500 \S{cl-2.10.05} Version 2.10.05
502 \b Add the \c{CLAC} and \c{STAC} instructions.
504 \S{cl-2.10.04} Version 2.10.04
506 \b Add back the inadvertently deleted 256-bit version of the \c{VORPD}
507 instruction.
509 \b Correct disassembly of instructions starting with byte \c{82} hex.
511 \b Fix corner cases in token pasting, for example:
513 \c    %define N 1e%++%+ 5
514 \c            dd N, 1e+5
516 \S{cl-2.10.03} Version 2.10.03
518 \b Correct the assembly of the instruction:
520 \c XRELEASE MOV [absolute],AL
522 \> Previous versions would incorrectly generate \c{F3 A2} for this
523 instruction and issue a warning; correct behavior is to emit \c{F3 88
524 05}.
526 \S{cl-2.10.02} Version 2.10.02
528 \b Add the \c{ifunc} macro package with integer functions, currently
529 only integer logarithms.  See \k{pkg_ifunc}.
531 \b Add the \c{RDSEED}, \c{ADCX} and \c{ADOX} instructions.
533 \S{cl-2.10.01} Version 2.10.01
535 \b Add missing VPMOVMSKB instruction with reg32, ymmreg operands.
537 \S{cl-2.10} Version 2.10
539 \b When optimization is enabled, \c{mov r64,imm} now optimizes to the
540   shortest form possible between:
542 \c      mov r32,imm32                   ;  5 bytes
543 \c      mov r64,imm32                   ;  7 bytes
544 \c      mov r64,imm64                   ; 10 bytes
546 \> To force a specific form, use the \c{STRICT} keyword, see \k{strict}.
548 \b Add support for the Intel AVX2 instruction set.
550 \b Add support for Bit Manipulation Instructions 1 and 2.
552 \b Add support for Intel Transactional Synchronization Extensions (TSX).
554 \b Add support for x32 ELF (32-bit ELF with the CPU in 64-bit mode.)
555    See \k{elffmt}.
557 \b Add support for bigendian UTF-16 and UTF-32.  See \k{unicode}.
559 \S{cl-2.09.10} Version 2.09.10
561 \b Fix up NSIS script to protect uninstaller against registry keys
562    absence or corruption. It brings in a few additional questions
563    to a user during deinstallation procedure but still it is better
564    than unpredictable file removal.
566 \S{cl-2.09.09} Version 2.09.09
568 \b Fix initialization of section attributes of \c{bin} output format.
570 \b Fix \c{mach64} output format bug that crashes NASM due to NULL symbols.
573 \S{cl-2.09.08} Version 2.09.08
575 \b Fix \c{__OUTPUT_FORMAT__} assignment when output driver alias
576    is used. For example when \c{-f elf} is used \c{__OUTPUT_FORMAT__}
577    must be set to \c{elf}, if \c{-f elf32} is used \c{__OUTPUT_FORMAT__}
578    must be assigned accordingly, i.e. to \c{elf32}. The rule applies to
579    all output driver aliases. See \k{ofmtm}.
582 \S{cl-2.09.07} Version 2.09.07
584 \b Fix attempts to close same file several times
585    when \c{-a} option is used.
587 \b Fixes for VEXTRACTF128, VMASKMOVPS encoding.
590 \S{cl-2.09.06} Version 2.09.06
592 \b Fix missed section attribute initialization in \c{bin} output target.
595 \S{cl-2.09.05} Version 2.09.05
597 \b Fix arguments encoding for VPEXTRW instruction.
599 \b Remove invalid form of VPEXTRW instruction.
601 \b Add \c{VLDDQU} as alias for \c{VLDQQU} to
602    match specification.
605 \S{cl-2.09.04} Version 2.09.04
607 \b Fix incorrect labels offset for VEX intructions.
609 \b Eliminate bogus warning on implicit operand size override.
611 \b \c{%if} term could not handle 64 bit numbers.
613 \b The COFF backend was limiting relocations number to 16 bits even if
614    in real there were a way more relocations.
617 \S{cl-2.09.03} Version 2.09.03
619 \b Print \c{%macro} name inside \c{%rep} blocks on error.
621 \b Fix preprocessor expansion behaviour. It happened sometime
622    too early and sometime simply wrong. Move behaviour back to
623    the origins (down to NASM 2.05.01).
625 \b Fix unitialized data dereference on OMF output format.
627 \b Issue warning on unterminated \c{%{} construct.
629 \b Fix for documentation typo.
632 \S{cl-2.09.02} Version 2.09.02
634 \b Fix reversed tokens when \c{%deftok} produces more than one output token.
636 \b Fix segmentation fault on disassembling some VEX instructions.
638 \b Missing \c{%endif} did not always cause error.
640 \b Fix typo in documentation.
642 \b Compound context local preprocessor single line macro identifiers
643   were not expanded early enough and as result lead to unresolved
644   symbols.
647 \S{cl-2.09.01} Version 2.09.01
649 \b Fix NULL dereference on missed %deftok second parameter.
651 \b Fix NULL dereference on invalid %substr parameters.
654 \S{cl-2.09} Version 2.09
656 \b Fixed assignment the magnitude of \c{%rep} counter. It is limited
657   to 62 bits now.
659 \b Fixed NULL dereference if argument of \c{%strlen} resolves
660   to whitespace. For example if nonexistent macro parameter is used.
662 \b \c{%ifenv}, \c{%elifenv}, \c{%ifnenv}, and \c{%elifnenv} directives
663   introduced.  See \k{ifenv}.
665 \b Fixed NULL dereference if environment variable is missed.
667 \b Updates of new AVX v7 Intel instructions.
669 \b \c{PUSH imm32} is now officially documented.
671 \b Fix for encoding the LFS, LGS and LSS in 64-bit mode.
673 \b Fixes for compatibility with OpenWatcom compiler and DOS 8.3 file
674   format limitation.
676 \b Macros parameters range expansion introduced. See \k{mlmacrange}.
678 \b Backward compatibility on expanging of local sigle macros restored.
680 \b 8 bit relocations for \c{elf} and \c{bin} output formats are introduced.
682 \b Short intersegment jumps are permitted now.
684 \b An alignment more than 64 bytes are allowed for \c{win32},
685   \c{win64} output formats.
687 \b \c{SECTALIGN} directive introduced. See \k{sectalign}.
689 \b \c{nojmp} option introduced in \c{smartalign} package. See
690   \k{pkg_smartalign}.
692 \b Short aliases \c{win}, \c{elf} and \c{macho} for output formats are
693   introduced.  Each stands for \c{win32}, \c{elf32} and \c{macho32}
694   accordingly.
696 \b Faster handling of missing directives implemented.
698 \b Various small improvements in documentation.
700 \b No hang anymore if unable to open malloc.log file.
702 \b The environments without vsnprintf function are able to build nasm again.
704 \b AMD LWP instructions updated.
706 \b Tighten EA checks. We warn a user if there overflow in EA addressing.
708 \b Make \c{-Ox} the default optimization level.  For the legacy
709   behavior, specify \c{-O0} explicitly.  See \k{opt-O}.
711 \b Environment variables read with \c{%!} or tested with \c{%ifenv}
712   can now contain non-identifier characters if surrounded by quotes.
713   See \k{getenv}.
715 \b Add a new standard macro package \c{%use fp} for floating-point
716   convenience macros.  See \k{pkg_fp}.
719 \S{cl-2.08.02} Version 2.08.02
721 \b Fix crash under certain circumstances when using the \c{%+} operator.
724 \S{cl-2.08.01} Version 2.08.01
726 \b Fix the \c{%use} statement, which was broken in 2.08.
729 \S{cl-2.08} Version 2.08
731 \b A number of enhancements/fixes in macros area.
733 \b Support for converting strings to tokens.  See \k{deftok}.
735 \b Fuzzy operand size logic introduced.
737 \b Fix COFF stack overrun on too long export identifiers.
739 \b Fix Macho-O alignment bug.
741 \b Fix crashes with -fwin32 on file with many exports.
743 \b Fix stack overrun for too long [DEBUG id].
745 \b Fix incorrect sbyte usage in IMUL (hit only if optimization
746   flag passed).
748 \b Append ending token for \c{.stabs} records in the ELF output format.
750 \b New NSIS script which uses ModernUI and MultiUser approach.
752 \b Visual Studio 2008 NASM integration (rules file).
754 \b Warn a user if a constant is too long (and as result will be stripped).
756 \b The obsoleted pre-XOP AMD SSE5 instruction set which was never actualized
757   was removed.
759 \b Fix stack overrun on too long error file name passed from the command line.
761 \b Bind symbols to the .text section by default (ie in case if SECTION
762   directive was omitted) in the ELF output format.
764 \b Fix sync points array index wrapping.
766 \b A few fixes for FMA4 and XOP instruction templates.
768 \b Add AMD Lightweight Profiling (LWP) instructions.
770 \b Fix the offset for \c{%arg} in 64-bit mode.
772 \b An undefined local macro (\c{%$}) no longer matches a global macro
773   with the same name.
775 \b Fix NULL dereference on too long local labels.
778 \S{cl-2.07} Version 2.07
780 \b NASM is now under the 2-clause BSD license.  See \k{legal}.
782 \b Fix the section type for the \c{.strtab} section in the \c{elf64}
783   output format.
785 \b Fix the handling of \c{COMMON} directives in the \c{obj} output format.
787 \b New \c{ith} and \c{srec} output formats; these are variants of the
788   \c{bin} output format which output Intel hex and Motorola S-records,
789   respectively.  See \k{ithfmt} and \k{srecfmt}.
791 \b \c{rdf2ihx} replaced with an enhanced \c{rdf2bin}, which can output
792   binary, COM, Intel hex or Motorola S-records.
794 \b The Windows installer now puts the NASM directory first in the
795   \c{PATH} of the "NASM Shell".
797 \b Revert the early expansion behavior of \c{%+} to pre-2.06 behavior:
798   \c{%+} is only expanded late.
800 \b Yet another Mach-O alignment fix.
802 \b Don't delete the list file on errors.  Also, include error and
803   warning information in the list file.
805 \b Support for 64-bit Mach-O output, see \k{machofmt}.
807 \b Fix assert failure on certain operations that involve strings with
808   high-bit bytes.
811 \S{cl-2.06} Version 2.06
813 \b This release is dedicated to the memory of Charles A. Crayne, long
814   time NASM developer as well as moderator of \c{comp.lang.asm.x86} and
815   author of the book \e{Serious Assembler}.  We miss you, Chuck.
817 \b Support for indirect macro expansion (\c{%[...]}).  See \k{indmacro}.
819 \b \c{%pop} can now take an argument, see \k{pushpop}.
821 \b The argument to \c{%use} is no longer macro-expanded.  Use
822   \c{%[...]} if macro expansion is desired.
824 \b Support for thread-local storage in ELF32 and ELF64.  See \k{elftls}.
826 \b Fix crash on \c{%ifmacro} without an argument.
828 \b Correct the arguments to the \c{POPCNT} instruction.
830 \b Fix section alignment in the Mach-O format.
832 \b Update AVX support to version 5 of the Intel specification.
834 \b Fix the handling of accesses to context-local macros from higher
835   levels in the context stack.
837 \b Treat \c{WAIT} as a prefix rather than as an instruction, thereby
838   allowing constructs like \c{O16 FSAVE} to work correctly.
840 \b Support for structures with a non-zero base offset. See \k{struc}.
842 \b Correctly handle preprocessor token concatenation (see \k{concat})
843    involving floating-point numbers.
845 \b The \c{PINSR} series of instructions have been corrected and
846    rationalized.
848 \b Removed AMD SSE5, replaced with the new XOP/FMA4/CVT16 (rev 3.03)
849    spec.
851 \b The ELF backends no longer automatically generate a \c{.comment} section.
853 \b Add additional "well-known" ELF sections with default attributes.  See
854    \k{elfsect}.
857 \S{cl-2.05.01} Version 2.05.01
859 \b Fix the \c{-w}/\c{-W} option parsing, which was broken in NASM 2.05.
862 \S{cl-2.05} Version 2.05
864 \b Fix redundant REX.W prefix on \c{JMP reg64}.
866 \b Make the behaviour of \c{-O0} match NASM 0.98 legacy behavior.
867   See \k{opt-O}.
869 \b \c{-w-user} can be used to suppress the output of \c{%warning} directives.
870   See \k{opt-w}.
872 \b Fix bug where \c{ALIGN} would issue a full alignment datum instead of
873   zero bytes.
875 \b Fix offsets in list files.
877 \b Fix \c{%include} inside multi-line macros or loops.
879 \b Fix error where NASM would generate a spurious warning on valid
880   optimizations of immediate values.
882 \b Fix arguments to a number of the \c{CVT} SSE instructions.
884 \b Fix RIP-relative offsets when the instruction carries an immediate.
886 \b Massive overhaul of the ELF64 backend for spec compliance.
888 \b Fix the Geode \c{PFRCPV} and \c{PFRSQRTV} instruction.
890 \b Fix the SSE 4.2 \c{CRC32} instruction.
893 \S{cl-2.04} Version 2.04
895 \b Sanitize macro handing in the \c{%error} directive.
897 \b New \c{%warning} directive to issue user-controlled warnings.
899 \b \c{%error} directives are now deferred to the final assembly phase.
901 \b New \c{%fatal} directive to immediately terminate assembly.
903 \b New \c{%strcat} directive to join quoted strings together.
905 \b New \c{%use} macro directive to support standard macro directives.  See
906   \k{use}.
908 \b Excess default parameters to \c{%macro} now issues a warning by default.
909   See \k{mlmacro}.
911 \b Fix \c{%ifn} and \c{%elifn}.
913 \b Fix nested \c{%else} clauses.
915 \b Correct the handling of nested \c{%rep}s.
917 \b New \c{%unmacro} directive to undeclare a multi-line macro.
918   See \k{unmacro}.
920 \b Builtin macro \c{__PASS__} which expands to the current assembly pass.
921   See \k{pass_macro}.
923 \b \c{__utf16__} and \c{__utf32__} operators to generate UTF-16 and UTF-32
924   strings.  See \k{unicode}.
926 \b Fix bug in case-insensitive matching when compiled on platforms that
927   don't use the \c{configure} script.  Of the official release binaries,
928   that only affected the OS/2 binary.
930 \b Support for x87 packed BCD constants.  See \k{bcdconst}.
932 \b Correct the \c{LTR} and \c{SLDT} instructions in 64-bit mode.
934 \b Fix unnecessary REX.W prefix on indirect jumps in 64-bit mode.
936 \b Add AVX versions of the AES instructions (\c{VAES}...).
938 \b Fix the 256-bit FMA instructions.
940 \b Add 256-bit AVX stores per the latest AVX spec.
942 \b VIA XCRYPT instructions can now be written either with or without
943   \c{REP}, apparently different versions of the VIA spec wrote them
944   differently.
946 \b Add missing 64-bit \c{MOVNTI} instruction.
948 \b Fix the operand size of \c{VMREAD} and \c{VMWRITE}.
950 \b Numerous bug fixes, especially to the AES, AVX and VTX instructions.
952 \b The optimizer now always runs until it converges.  It also runs even
953   when disabled, but doesn't optimize.  This allows most forward references
954   to be resolved properly.
956 \b \c{%push} no longer needs a context identifier; omitting the context
957   identifier results in an anonymous context.
960 \S{cl-2.03.01} Version 2.03.01
962 \b Fix buffer overflow in the listing module.
964 \b Fix the handling of hexadecimal escape codes in `...` strings.
966 \b The Postscript/PDF documentation has been reformatted.
968 \b The \c{-F} option now implies \c{-g}.
971 \S{cl-2.03} Version 2.03
973 \b Add support for Intel AVX, CLMUL and FMA instructions,
974 including YMM registers.
976 \b \c{dy}, \c{resy} and \c{yword} for 32-byte operands.
978 \b Fix some SSE5 instructions.
980 \b Intel \c{INVEPT}, \c{INVVPID} and \c{MOVBE} instructions.
982 \b Fix checking for critical expressions when the optimizer is enabled.
984 \b Support the DWARF debugging format for ELF targets.
986 \b Fix optimizations of signed bytes.
988 \b Fix operation on bigendian machines.
990 \b Fix buffer overflow in the preprocessor.
992 \b \c{SAFESEH} support for Win32, \c{IMAGEREL} for Win64 (SEH).
994 \b \c{%?} and \c{%??} to refer to the name of a macro itself.  In particular,
995 \c{%idefine keyword $%?} can be used to make a keyword "disappear".
997 \b New options for dependency generation: \c{-MD}, \c{-MF},
998 \c{-MP}, \c{-MT}, \c{-MQ}.
1000 \b New preprocessor directives \c{%pathsearch} and \c{%depend}; INCBIN
1001 reimplemented as a macro.
1003 \b \c{%include} now resolves macros in a sane manner.
1005 \b \c{%substr} can now be used to get other than one-character substrings.
1007 \b New type of character/string constants, using backquotes (\c{`...`}),
1008 which support C-style escape sequences.
1010 \b \c{%defstr} and \c{%idefstr} to stringize macro definitions before
1011 creation.
1013 \b Fix forward references used in \c{EQU} statements.
1016 \S{cl-2.02} Version 2.02
1018 \b Additional fixes for MMX operands with explicit \c{qword}, as well as
1019   (hopefully) SSE operands with \c{oword}.
1021 \b Fix handling of truncated strings with \c{DO}.
1023 \b Fix segfaults due to memory overwrites when floating-point constants
1024   were used.
1026 \b Fix segfaults due to missing include files.
1028 \b Fix OpenWatcom Makefiles for DOS and OS/2.
1030 \b Add autogenerated instruction list back into the documentation.
1032 \b ELF: Fix segfault when generating stabs, and no symbols have been
1033   defined.
1035 \b ELF: Experimental support for DWARF debugging information.
1037 \b New compile date and time standard macros.
1039 \b \c{%ifnum} now returns true for negative numbers.
1041 \b New \c{%iftoken} test for a single token.
1043 \b New \c{%ifempty} test for empty expansion.
1045 \b Add support for the \c{XSAVE} instruction group.
1047 \b Makefile for Netware/gcc.
1049 \b Fix issue with some warnings getting emitted way too many times.
1051 \b Autogenerated instruction list added to the documentation.
1054 \S{cl-2.01} Version 2.01
1056 \b Fix the handling of MMX registers with explicit \c{qword} tags on
1057   memory (broken in 2.00 due to 64-bit changes.)
1059 \b Fix the PREFETCH instructions.
1061 \b Fix the documentation.
1063 \b Fix debugging info when using \c{-f elf}
1064 (backwards compatibility alias for \c{-f elf32}).
1066 \b Man pages for rdoff tools (from the Debian project.)
1068 \b ELF: handle large numbers of sections.
1070 \b Fix corrupt output when the optimizer runs out of passes.
1073 \S{cl-2.00} Version 2.00
1075 \b Added c99 data-type compliance.
1077 \b Added general x86-64 support.
1079 \b Added win64 (x86-64 COFF) output format.
1081 \b Added \c{__BITS__} standard macro.
1083 \b Renamed the \c{elf} output format to \c{elf32} for clarity.
1085 \b Added \c{elf64} and \c{macho} (MacOS X) output formats.
1087 \b Added Numeric constants in \c{dq} directive.
1089 \b Added \c{oword}, \c{do} and \c{reso} pseudo operands.
1091 \b Allow underscores in numbers.
1093 \b Added 8-, 16- and 128-bit floating-point formats.
1095 \b Added binary, octal and hexadecimal floating-point.
1097 \b Correct the generation of floating-point constants.
1099 \b Added floating-point option control.
1101 \b Added Infinity and NaN floating point support.
1103 \b Added ELF Symbol Visibility support.
1105 \b Added setting OSABI value in ELF header directive.
1107 \b Added Generate Makefile Dependencies option.
1109 \b Added Unlimited Optimization Passes option.
1111 \b Added \c{%IFN} and \c{%ELIFN} support.
1113 \b Added Logical Negation Operator.
1115 \b Enhanced Stack Relative Preprocessor Directives.
1117 \b Enhanced ELF Debug Formats.
1119 \b Enhanced Send Errors to a File option.
1121 \b Added SSSE3, SSE4.1, SSE4.2, SSE5 support.
1123 \b Added a large number of additional instructions.
1125 \b Significant performance improvements.
1127 \b \c{-w+warning} and \c{-w-warning} can now be written as -Wwarning and
1128  -Wno-warning, respectively.  See \k{opt-w}.
1130 \b Add \c{-w+error} to treat warnings as errors.  See \k{opt-w}.
1132 \b Add \c{-w+all} and \c{-w-all} to enable or disable all suppressible
1133  warnings.  See \k{opt-w}.
1136 \H{cl-0.98.xx} NASM 0.98 Series
1138 The 0.98 series was the production versions of NASM from 1999 to 2007.
1141 \S{cl-0.98.39} Version 0.98.39
1143 \b fix buffer overflow
1145 \b fix outas86's \c{.bss} handling
1147 \b "make spotless" no longer deletes config.h.in.
1149 \b \c{%(el)if(n)idn} insensitivity to string quotes difference (#809300).
1151 \b (nasm.c)\c{__OUTPUT_FORMAT__} changed to string value instead of symbol.
1153 \S{cl-0.98.38} Version 0.98.38
1156 \b Add Makefile for 16-bit DOS binaries under OpenWatcom, and modify
1157   \c{mkdep.pl} to be able to generate completely pathless dependencies, as
1158   required by OpenWatcom wmake (it supports path searches, but not
1159   explicit paths.)
1161 \b Fix the \c{STR} instruction.
1163 \b Fix the ELF output format, which was broken under certain
1164   circumstances due to the addition of stabs support.
1166 \b Quick-fix Borland format debug-info for \c{-f obj}
1168 \b Fix for \c{%rep} with no arguments (#560568)
1170 \b Fix concatenation of preprocessor function call (#794686)
1172 \b Fix long label causes coredump (#677841)
1174 \b Use autoheader as well as autoconf to keep configure from generating
1175   ridiculously long command lines.
1177 \b Make sure that all of the formats which support debugging output
1178   actually will suppress debugging output when \c{-g} not specified.
1180 \S{cl-0.98.37} Version 0.98.37
1183 \b Paths given in \c{-I} switch searched for \c{incbin}-ed as
1184   well as \c{%include}-ed files.
1186 \b Added stabs debugging for the ELF output format, patch from
1187   Martin Wawro.
1189 \b Fix \c{output/outbin.c} to allow origin > 80000000h.
1191 \b Make \c{-U} switch work.
1193 \b Fix the use of relative offsets with explicit prefixes, e.g.
1194 \c{a32 loop foo}.
1196 \b Remove \c{backslash()}.
1198 \b Fix the \c{SMSW} and \c{SLDT} instructions.
1200 \b \c{-O2} and \c{-O3} are no longer aliases for \c{-O10} and \c{-O15}.
1201 If you mean the latter, please say so! :)
1203 \S{cl-0.98.36} Version 0.98.36
1206 \b Update rdoff - librarian/archiver - common rec - docs!
1208 \b Fix signed/unsigned problems.
1210 \b Fix \c{JMP FAR label} and \c{CALL FAR label}.
1212 \b Add new multisection support - map files - fix align bug
1214 \b Fix sysexit, movhps/movlps reg,reg bugs in insns.dat
1216 \b \c{Q} or \c{O} suffixes indicate octal
1218 \b Support Prescott new instructions (PNI).
1220 \b Cyrix \c{XSTORE} instruction.
1223 \S{cl-0.98.35} Version 0.98.35
1225 \b Fix build failure on 16-bit DOS (Makefile.bc3 workaround for compiler bug.)
1227 \b Fix dependencies and compiler warnings.
1229 \b Add "const" in a number of places.
1231 \b Add -X option to specify error reporting format (use -Xvc to
1232   integrate with Microsoft Visual Studio.)
1234 \b Minor changes for code legibility.
1236 \b Drop use of tmpnam() in rdoff (security fix.)
1239 \S{cl-0.98.34} Version 0.98.34
1241 \b Correct additional address-size vs. operand-size confusions.
1243 \b Generate dependencies for all Makefiles automatically.
1245 \b Add support for unimplemented (but theoretically available)
1246   registers such as tr0 and cr5.  Segment registers 6 and 7 are called
1247   segr6 and segr7 for the operations which they can be represented.
1249 \b Correct some disassembler bugs related to redundant address-size prefixes.
1250   Some work still remains in this area.
1252 \b Correctly generate an error for things like "SEG eax".
1254 \b Add the JMPE instruction, enabled by "CPU IA64".
1256 \b Correct compilation on newer gcc/glibc platforms.
1258 \b Issue an error on things like "jmp far eax".
1261 \S{cl-0.98.33} Version 0.98.33
1263 \b New __NASM_PATCHLEVEL__ and __NASM_VERSION_ID__ standard macros to
1264   round out the version-query macros.  version.pl now understands
1265   X.YYplWW or X.YY.ZZplWW as a version number, equivalent to
1266   X.YY.ZZ.WW (or X.YY.0.WW, as appropriate).
1268 \b New keyword "strict" to disable the optimization of specific
1269   operands.
1271 \b Fix the handing of size overrides with JMP instructions
1272   (instructions such as "jmp dword foo".)
1274 \b Fix the handling of "ABSOLUTE label", where "label" points into a
1275   relocatable segment.
1277 \b Fix OBJ output format with lots of externs.
1279 \b More documentation updates.
1281 \b Add -Ov option to get verbose information about optimizations.
1283 \b Undo a braindead change which broke \c{%elif} directives.
1285 \b Makefile updates.
1288 \S{cl-0.98.32} Version 0.98.32
1290 \b Fix NASM crashing when \c{%macro} directives were left unterminated.
1292 \b Lots of documentation updates.
1294 \b Complete rewrite of the PostScript/PDF documentation generator.
1296 \b The MS Visual C++ Makefile was updated and corrected.
1298 \b Recognize .rodata as a standard section name in ELF.
1300 \b Fix some obsolete Perl4-isms in Perl scripts.
1302 \b Fix configure.in to work with autoconf 2.5x.
1304 \b Fix a couple of "make cleaner" misses.
1306 \b Make the normal "./configure && make" work with Cygwin.
1309 \S{cl-0.98.31} Version 0.98.31
1311 \b Correctly build in a separate object directory again.
1313 \b Derive all references to the version number from the version file.
1315 \b New standard macros __NASM_SUBMINOR__ and __NASM_VER__ macros.
1317 \b Lots of Makefile updates and bug fixes.
1319 \b New \c{%ifmacro} directive to test for multiline macros.
1321 \b Documentation updates.
1323 \b Fixes for 16-bit OBJ format output.
1325 \b Changed the NASM environment variable to NASMENV.
1328 \S{cl-0.98.30} Version 0.98.30
1330 \b Changed doc files a lot: completely removed old READMExx and
1331   Wishlist files, incorporating all information in CHANGES and TODO.
1333 \b I waited a long time to rename zoutieee.c to (original) outieee.c
1335 \b moved all output modules to output/ subdirectory.
1337 \b Added 'make strip' target to strip debug info from nasm & ndisasm.
1339 \b Added INSTALL file with installation instructions.
1341 \b Added -v option description to nasm man.
1343 \b Added dist makefile target to produce source distributions.
1345 \b 16-bit support for ELF output format (GNU extension, but useful.)
1348 \S{cl-0.98.28} Version 0.98.28
1350 \b Fastcooked this for Debian's Woody release:
1351 Frank applied the INCBIN bug patch to 0.98.25alt and called
1352 it 0.98.28 to not confuse poor little apt-get.
1355 \S{cl-0.98.26} Version 0.98.26
1357 \b Reorganised files even better from 0.98.25alt
1360 \S{cl-0.98.25alt} Version 0.98.25alt
1362 \b Prettified the source tree. Moved files to more reasonable places.
1364 \b Added findleak.pl script to misc/ directory.
1366 \b Attempted to fix doc.
1369 \S{cl-0.98.25} Version 0.98.25
1371 \b Line continuation character \c{\\}.
1373 \b Docs inadvertantly reverted - "dos packaging".
1376 \S{cl-0.98.24p1} Version 0.98.24p1
1378 \b FIXME: Someone, document this please.
1381 \S{cl-0.98.24} Version 0.98.24
1383 \b Documentation - Ndisasm doc added to Nasm.doc.
1386 \S{cl-0.98.23} Version 0.98.23
1388 \b Attempted to remove rdoff version1
1390 \b Lino Mastrodomenico's patches to preproc.c (%$$ bug?).
1393 \S{cl-0.98.22} Version 0.98.22
1395 \b Update rdoff2 - attempt to remove v1.
1398 \S{cl-0.98.21} Version 0.98.21
1400 \b Optimization fixes.
1403 \S{cl-0.98.20} Version 0.98.20
1405 \b Optimization fixes.
1408 \S{cl-0.98.19} Version 0.98.19
1410 \b H. J. Lu's patch back out.
1413 \S{cl-0.98.18} Version 0.98.18
1415 \b Added ".rdata" to "-f win32".
1418 \S{cl-0.98.17} Version 0.98.17
1420 \b H. J. Lu's "bogus elf" patch. (Red Hat problem?)
1423 \S{cl-0.98.16} Version 0.98.16
1425 \b Fix whitespace before "[section ..." bug.
1428 \S{cl-0.98.15} Version 0.98.15
1430 \b Rdoff changes (?).
1432 \b Fix fixes to memory leaks.
1435 \S{cl-0.98.14} Version 0.98.14
1437 \b Fix memory leaks.
1440 \S{cl-0.98.13} Version 0.98.13
1442 \b There was no 0.98.13
1445 \S{cl-0.98.12} Version 0.98.12
1447 \b Update optimization (new function of "-O1")
1449 \b Changes to test/bintest.asm (?).
1452 \S{cl-0.98.11} Version 0.98.11
1454 \b Optimization changes.
1456 \b Ndisasm fixed.
1459 \S{cl-0.98.10} Version 0.98.10
1461 \b There was no 0.98.10
1464 \S{cl-0.98.09} Version 0.98.09
1466 \b Add multiple sections support to "-f bin".
1468 \b Changed GLOBAL_TEMP_BASE in outelf.c from 6 to 15.
1470 \b Add "-v" as an alias to the "-r" switch.
1472 \b Remove "#ifdef" from Tasm compatibility options.
1474 \b Remove redundant size-overrides on "mov ds, ex", etc.
1476 \b Fixes to SSE2, other insns.dat (?).
1478 \b Enable uppercase "I" and "P" switches.
1480 \b Case insinsitive "seg" and "wrt".
1482 \b Update install.sh (?).
1484 \b Allocate tokens in blocks.
1486 \b Improve "invalid effective address" messages.
1489 \S{cl-0.98.08} Version 0.98.08
1491 \b Add "\c{%strlen}" and "\c{%substr}" macro operators
1493 \b Fixed broken c16.mac.
1495 \b Unterminated string error reported.
1497 \b Fixed bugs as per 0.98bf
1500 \S{cl-0.98.09b with John Coffman patches released 28-Oct-2001} Version 0.98.09b with John Coffman patches released 28-Oct-2001
1502 Changes from 0.98.07 release to 98.09b as of 28-Oct-2001
1504 \b More closely compatible with 0.98 when -O0 is implied
1505 or specified.  Not strictly identical, since backward
1506 branches in range of short offsets are recognized, and signed
1507 byte values with no explicit size specification will be
1508 assembled as a single byte.
1510 \b More forgiving with the PUSH instruction.  0.98 requires
1511 a size to be specified always.  0.98.09b will imply the size
1512 from the current BITS setting (16 or 32).
1514 \b Changed definition of the optimization flag:
1516 \c    -O0     strict two-pass assembly, JMP and Jcc are
1517 \c            handled more like 0.98, except that back-
1518 \c            ward JMPs are short, if possible.
1520 \c    -O1     strict two-pass assembly, but forward
1521 \c            branches are assembled with code guaranteed
1522 \c            to reach; may produce larger code than
1523 \c            -O0, but will produce successful assembly
1524 \c            more often if branch offset sizes are not
1525 \c            specified.
1527 \c    -O2     multi-pass optimization, minimize branch
1528 \c            offsets; also will minimize signed immed-
1529 \c            iate bytes, overriding size specification.
1531 \c    -O3     like -O2, but more passes taken, if needed
1534 \S{cl-0.98.07 released 01/28/01} Version 0.98.07 released 01/28/01
1536 \b      Added Stepane Denis' SSE2 instructions to a *working*
1537         version of the code - some earlier versions were based on
1538         broken code - sorry 'bout that. version "0.98.07"
1540 \b       Cosmetic modifications to nasm.c, nasm.h,
1541         AUTHORS, MODIFIED
1544 \S{cl-0.98.06f released 01/18/01} Version 0.98.06f released 01/18/01
1547 \b Add "metalbrain"s jecxz bug fix in insns.dat
1549 \b Alter nasmdoc.src to match - version "0.98.06f"
1552 \S{cl-0.98.06e released 01/09/01} Version 0.98.06e released 01/09/01
1555 \b       Removed the "outforms.h" file - it appears to be
1556         someone's old backup of "outform.h". version "0.98.06e"
1558 \b fbk - finally added the fix for the "multiple %includes bug",
1559         known since 7/27/99 - reported originally (?) and sent to
1560         us by Austin Lunnen - he reports that John Fine had a fix
1561         within the day. Here it is...
1563 \b Nelson Rush resigns from the group. Big thanks to Nelson for
1564   his leadership and enthusiasm in getting these changes
1565   incorporated into Nasm!
1567 \b fbk - [list +], [list -] directives - ineptly implemented, should
1568         be re-written or removed, perhaps.
1570 \b Brian Raiter / fbk - "elfso bug" fix - applied to aoutb format
1571                        as well - testing might be desirable...
1573 \b James Seter - -postfix, -prefix command line switches.
1575 \b Yuri Zaporozhets - rdoff utility changes.
1578 \S{cl-0.98p1} Version 0.98p1
1580 \b GAS-like palign (Panos Minos)
1582 \b FIXME: Someone, fill this in with details
1585 \S{cl-0.98bf (bug-fixed)} Version 0.98bf (bug-fixed)
1587 \b Fixed - elf and aoutb bug - shared libraries
1588         - multiple "%include" bug in "-f obj"
1589         - jcxz, jecxz bug
1590         - unrecognized option bug in ndisasm
1592 \S{cl-0.98.03 with John Coffman's changes released 27-Jul-2000} Version 0.98.03 with John Coffman's changes released 27-Jul-2000
1594 \b Added signed byte optimizations for the 0x81/0x83 class
1595 of instructions: ADC, ADD, AND, CMP, OR, SBB, SUB, XOR:
1596 when used as 'ADD reg16,imm' or 'ADD reg32,imm.'  Also
1597 optimization of signed byte form of 'PUSH imm' and 'IMUL
1598 reg,imm'/'IMUL reg,reg,imm.'  No size specification is needed.
1600 \b Added multi-pass JMP and Jcc offset optimization.  Offsets
1601 on forward references will preferentially use the short form,
1602 without the need to code a specific size (short or near) for
1603 the branch.  Added instructions for 'Jcc label' to use the
1604 form 'Jnotcc $+3/JMP label', in cases where a short offset
1605 is out of bounds.  If compiling for a 386 or higher CPU, then
1606 the 386 form of Jcc will be used instead.
1608 \> This feature is controlled by a new command-line switch: "O",
1609 (upper case letter O).  "-O0" reverts the assembler to no
1610 extra optimization passes, "-O1" allows up to 5 extra passes,
1611 and "-O2"(default), allows up to 10 extra optimization passes.
1613 \b Added a new directive:  'cpu XXX', where XXX is any of:
1614 8086, 186, 286, 386, 486, 586, pentium, 686, PPro, P2, P3 or
1615 Katmai.  All are case insensitive.  All instructions will
1616 be selected only if they apply to the selected cpu or lower.
1617 Corrected a couple of bugs in cpu-dependence in 'insns.dat'.
1619 \b Added to 'standard.mac', the "use16" and "use32" forms of
1620 the "bits 16/32" directive. This is nothing new, just conforms
1621 to a lot of other assemblers. (minor)
1623 \b Changed label allocation from 320/32 (10000 labels @ 200K+)
1624 to 32/37 (1000 labels); makes running under DOS much easier.
1625 Since additional label space is allocated dynamically, this
1626 should have no effect on large programs with lots of labels.
1627 The 37 is a prime, believed to be better for hashing. (minor)
1630 \S{cl-0.98.03} Version 0.98.03
1632 "Integrated patchfile 0.98-0.98.01.  I call this version 0.98.03 for
1633 historical reasons: 0.98.02 was trashed." --John Coffman
1634 <johninsd@san.rr.com>, 27-Jul-2000
1636 \b Kendall Bennett's SciTech MGL changes
1638 \b Note that you must define "TASM_COMPAT" at compile-time
1639 to get the Tasm Ideal Mode compatibility.
1641 \b All changes can be compiled in and out using the TASM_COMPAT macros,
1642 and when compiled without TASM_COMPAT defined we get the exact same
1643 binary as the unmodified 0.98 sources.
1645 \b standard.mac, macros.c: Added macros to ignore TASM directives before
1646 first include
1648 \b nasm.h: Added extern declaration for tasm_compatible_mode
1650 \b nasm.c: Added global variable tasm_compatible_mode
1652 \b Added command line switch for TASM compatible mode (-t)
1654 \b Changed version command line to reflect when compiled with TASM additions
1656 \b Added response file processing to allow all arguments on a single
1657 line (response file is @resp rather than -@resp for NASM format).
1659 \b labels.c: Changes islocal() macro to support TASM style @@local labels.
1661 \b Added islocalchar() macro to support TASM style @@local labels.
1663 \b parser.c: Added support for TASM style memory references (ie: mov
1664 [DWORD eax],10 rather than the NASM style mov DWORD [eax],10).
1666 \b preproc.c: Added new directives, \c{%arg}, \c{%local}, \c{%stacksize} to directives
1667 table
1669 \b Added support for TASM style directives without a leading % symbol.
1671 \b Integrated a block of changes from Andrew Zabolotny <bit@eltech.ru>:
1673 \b A new keyword \c{%xdefine} and its case-insensitive counterpart \c{%ixdefine}.
1674 They work almost the same way as \c{%define} and \c{%idefine} but expand
1675 the definition immediately, not on the invocation. Something like a cross
1676 between \c{%define} and \c{%assign}. The "x" suffix stands for "eXpand", so
1677 "xdefine" can be deciphered as "expand-and-define". Thus you can do
1678 things like this:
1680 \c      %assign ofs     0
1682 \c      %macro  arg     1
1683 \c              %xdefine %1 dword [esp+ofs]
1684 \c              %assign ofs ofs+4
1685 \c      %endmacro
1687 \b Changed the place where the expansion of %$name macros are expanded.
1688 Now they are converted into ..@ctxnum.name form when detokenizing, so
1689 there are no quirks as before when using %$name arguments to macros,
1690 in macros etc. For example:
1692 \c      %macro  abc     1
1693 \c              %define %1 hello
1694 \c      %endm
1696 \c      abc     %$here
1697 \c      %$here
1699 \>    Now last line will be expanded into "hello" as expected. This also allows
1700     for lots of goodies, a good example are extended "proc" macros included
1701     in this archive.
1703 \b Added a check for "cstk" in smacro_defined() before calling get_ctx() -
1704     this allows for things like:
1706 \c      %ifdef %$abc
1707 \c      %endif
1709 \>    to work without warnings even in no context.
1711 \b Added a check for "cstk" in %if*ctx and %elif*ctx directives -
1712     this allows to use \c{%ifctx} without excessive warnings. If there is
1713     no active context, \c{%ifctx} goes through "false" branch.
1715 \b Removed "user error: " prefix with \c{%error} directive: it just clobbers the
1716     output and has absolutely no functionality. Besides, this allows to write
1717     macros that does not differ from built-in functions in any way.
1719 \b Added expansion of string that is output by \c{%error} directive. Now you
1720     can do things like:
1722 \c      %define hello(x) Hello, x!
1724 \c      %define %$name andy
1725 \c      %error "hello(%$name)"
1727 \> Same happened with \c{%include} directive.
1729 \b Now all directives that expect an identifier will try to expand and
1730     concatenate everything without whitespaces in between before usage.
1731     For example, with "unfixed" nasm the commands
1733 \c      %define %$abc hello
1734 \c      %define __%$abc goodbye
1735 \c      __%$abc
1737 \>    would produce "incorrect" output: last line will expand to
1739 \c      hello goodbyehello
1741 \>    Not quite what you expected, eh? :-) The answer is that preprocessor
1742     treats the \c{%define} construct as if it would be
1744 \c      %define __ %$abc goodbye
1746 \>    (note the white space between __ and %$abc). After my "fix" it
1747     will "correctly" expand into
1749 \c      goodbye
1751 \>    as expected. Note that I use quotes around words "correct", "incorrect"
1752     etc because this is rather a feature not a bug; however current behaviour
1753     is more logical (and allows more advanced macro usage :-).
1755     Same change was applied to:
1756         \c{%push},\c{%macro},\c{%imacro},\c{%define},\c{%idefine},\c{%xdefine},\c{%ixdefine},
1757         \c{%assign},\c{%iassign},\c{%undef}
1759 \b A new directive [WARNING {+|-}warning-id] have been added. It works only
1760     if the assembly phase is enabled (i.e. it doesn't work with nasm -e).
1762 \b A new warning type: macro-selfref. By default this warning is disabled;
1763     when enabled NASM warns when a macro self-references itself; for example
1764     the following source:
1766 \c        [WARNING macro-selfref]
1768 \c        %macro          push    1-*
1769 \c                %rep    %0
1770 \c                        push    %1
1771 \c                        %rotate 1
1772 \c                %endrep
1773 \c        %endmacro
1775 \c                        push    eax,ebx,ecx
1777 \>  will produce a warning, but if we remove the first line we won't see it
1778     anymore (which is The Right Thing To Do {tm} IMHO since C preprocessor
1779     eats such constructs without warnings at all).
1781 \b Added a "error" routine to preprocessor which always will set ERR_PASS1
1782     bit in severity_code. This removes annoying repeated errors on first
1783     and second passes from preprocessor.
1785 \b Added the %+ operator in single-line macros for concatenating two
1786     identifiers. Usage example:
1788 \c        %define _myfunc _otherfunc
1789 \c        %define cextern(x) _ %+ x
1790 \c        cextern (myfunc)
1792 \>    After first expansion, third line will become "_myfunc". After this
1793     expansion is performed again so it becomes "_otherunc".
1795 \b Now if preprocessor is in a non-emitting state, no warning or error
1796     will be emitted. Example:
1798 \c        %if 1
1799 \c                mov     eax,ebx
1800 \c        %else
1801 \c                put anything you want between these two brackets,
1802 \c                even macro-parameter references %1 or local
1803 \c                labels %$zz or macro-local labels %%zz - no
1804 \c                warning will be emitted.
1805 \c        %endif
1807 \b Context-local variables on expansion as a last resort are looked up
1808     in outer contexts. For example, the following piece:
1810 \c        %push   outer
1811 \c        %define %$a [esp]
1813 \c                %push   inner
1814 \c                %$a
1815 \c                %pop
1816 \c        %pop
1818 \>    will expand correctly the fourth line to [esp]; if we'll define another
1819     %$a inside the "inner" context, it will take precedence over outer
1820     definition. However, this modification has been applied only to
1821     expand_smacro and not to smacro_define: as a consequence expansion
1822     looks in outer contexts, but \c{%ifdef} won't look in outer contexts.
1824 \>    This behaviour is needed because we don't want nested contexts to
1825     act on already defined local macros. Example:
1827 \c        %define %$arg1  [esp+4]
1828 \c        test    eax,eax
1829 \c        if      nz
1830 \c                mov     eax,%$arg1
1831 \c        endif
1833 \>    In this example the "if" mmacro enters into the "if" context, so %$arg1
1834     is not valid anymore inside "if". Of course it could be worked around
1835     by using explicitely %$$arg1 but this is ugly IMHO.
1837 \b Fixed memory leak in \c{%undef}. The origline wasn't freed before
1838     exiting on success.
1840 \b Fixed trap in preprocessor when line expanded to empty set of tokens.
1841     This happens, for example, in the following case:
1843 \c        #define SOMETHING
1844 \c        SOMETHING
1847 \S{cl-0.98} Version 0.98
1849 All changes since NASM 0.98p3 have been produced by H. Peter Anvin <hpa@zytor.com>.
1851 \b The documentation comment delimiter is \# not #.
1853 \b Allow EQU definitions to refer to external labels; reported by
1854   Pedro Gimeno.
1856 \b Re-enable support for RDOFF v1; reported by Pedro Gimeno.
1858 \b Updated License file per OK from Simon and Julian.
1861 \S{cl-0.98p9} Version 0.98p9
1863 \b Update documentation (although the instruction set reference will
1864   have to wait; I don't want to hold up the 0.98 release for it.)
1866 \b Verified that the NASM implementation of the PEXTRW and PMOVMSKB
1867   instructions is correct.  The encoding differs from what the Intel
1868   manuals document, but the Pentium III behaviour matches NASM, not
1869   the Intel manuals.
1871 \b Fix handling of implicit sizes in PSHUFW and PINSRW, reported by
1872   Stefan Hoffmeister.
1874 \b Resurrect the -s option, which was removed when changing the
1875   diagnostic output to stdout.
1878 \S{cl-0.98p8} Version 0.98p8
1880 \b Fix for "DB" when NASM is running on a bigendian machine.
1882 \b Invoke insns.pl once for each output script, making Makefile.in
1883   legal for "make -j".
1885 \b Improve the Unix configure-based makefiles to make package
1886   creation easier.
1888 \b Included an RPM .spec file for building RPM (RedHat Package Manager)
1889   packages on Linux or Unix systems.
1891 \b Fix Makefile dependency problems.
1893 \b Change src/rdsrc.pl to include sectioning information in info
1894   output; required for install-info to work.
1896 \b Updated the RDOFF distribution to version 2 from Jules; minor
1897   massaging to make it compile in my environment.
1899 \b Split doc files that can be built by anyone with a Perl interpreter off
1900   into a separate archive.
1902 \b "Dress rehearsal" release!
1905 \S{cl-0.98p7} Version 0.98p7
1907 \b Fixed opcodes with a third byte-sized immediate argument to not
1908   complain if given "byte" on the immediate.
1910 \b Allow \c{%undef} to remove single-line macros with arguments.  This
1911   matches the behaviour of #undef in the C preprocessor.
1913 \b Allow -d, -u, -i and -p to be specified as -D, -U, -I and -P for
1914   compatibility with most C compilers and preprocessors.  This allows
1915   Makefile options to be shared between cc and nasm, for example.
1917 \b Minor cleanups.
1919 \b Went through the list of Katmai instructions and hopefully fixed the
1920   (rather few) mistakes in it.
1922 \b (Hopefully) fixed a number of disassembler bugs related to ambiguous
1923   instructions (disambiguated by -p) and SSE instructions with REP.
1925 \b Fix for bug reported by Mark Junger: "call dword 0x12345678" should
1926   work and may add an OSP (affected CALL, JMP, Jcc).
1928 \b Fix for environments when "stderr" isn't a compile-time constant.
1931 \S{cl-0.98p6} Version 0.98p6
1934 \b Took officially over coordination of the 0.98 release; so drop
1935   the p3.x notation. Skipped p4 and p5 to avoid confusion with John
1936   Fine's J4 and J5 releases.
1938 \b Update the documentation; however, it still doesn't include
1939   documentation for the various new instructions.  I somehow wonder if
1940   it makes sense to have an instruction set reference in the assembler
1941   manual when Intel et al have PDF versions of their manuals online.
1943 \b Recognize "idt" or "centaur" for the -p option to ndisasm.
1945 \b Changed error messages back to stderr where they belong, but add an
1946   -E option to redirect them elsewhere (the DOS shell cannot redirect
1947   stderr.)
1949 \b -M option to generate Makefile dependencies (based on code from Alex
1950   Verstak.)
1952 \b \c{%undef} preprocessor directive, and -u option, that undefines a
1953   single-line macro.
1955 \b OS/2 Makefile (Mkfiles/Makefile.os2) for Borland under OS/2; from
1956   Chuck Crayne.
1958 \b Various minor bugfixes (reported by):
1959   - Dangling \c{%s} in preproc.c (Martin Junker)
1961 \b THERE ARE KNOWN BUGS IN SSE AND THE OTHER KATMAI INSTRUCTIONS.  I am
1962   on a trip and didn't bring the Katmai instruction reference, so I
1963   can't work on them right now.
1965 \b Updated the License file per agreement with Simon and Jules to
1966   include a GPL distribution clause.
1969 \S{cl-0.98p3.7} Version 0.98p3.7
1971 \b (Hopefully) fixed the canned Makefiles to include the outrdf2 and
1972   zoutieee modules.
1974 \b Renamed changes.asm to changed.asm.
1977 \S{cl-0.98p3.6} Version 0.98p3.6
1979 \b Fixed a bunch of instructions that were added in 0.98p3.5 which had
1980   memory operands, and the address-size prefix was missing from the
1981   instruction pattern.
1984 \S{cl-0.98p3.5} Version 0.98p3.5
1986 \b Merged in changes from John S. Fine's 0.98-J5 release.  John's based
1987   0.98-J5 on my 0.98p3.3 release; this merges the changes.
1989 \b Expanded the instructions flag field to a long so we can fit more
1990   flags; mark SSE (KNI) and AMD or Katmai-specific instructions as
1991   such.
1993 \b Fix the "PRIV" flag on a bunch of instructions, and create new
1994   "PROT" flag for protected-mode-only instructions (orthogonal to if
1995   the instruction is privileged!) and new "SMM" flag for SMM-only
1996   instructions.
1998 \b Added AMD-only SYSCALL and SYSRET instructions.
2000 \b Make SSE actually work, and add new Katmai MMX instructions.
2002 \b Added a -p (preferred vendor) option to ndisasm so that it can
2003   distinguish e.g. Cyrix opcodes also used in SSE.  For example:
2005 \c      ndisasm -p cyrix aliased.bin
2006 \c      00000000  670F514310        paddsiw mm0,[ebx+0x10]
2007 \c      00000005  670F514320        paddsiw mm0,[ebx+0x20]
2008 \c      ndisasm -p intel aliased.bin
2009 \c      00000000  670F514310        sqrtps xmm0,[ebx+0x10]
2010 \c      00000005  670F514320        sqrtps xmm0,[ebx+0x20]
2012 \b Added a bunch of Cyrix-specific instructions.
2015 \S{cl-0.98p3.4} Version 0.98p3.4
2017 \b Made at least an attempt to modify all the additional Makefiles (in
2018   the Mkfiles directory).  I can't test it, but this was the best I
2019   could do.
2021 \b DOS DJGPP+"Opus Make" Makefile from John S. Fine.
2023 \b changes.asm changes from John S. Fine.
2026 \S{cl-0.98p3.3} Version 0.98p3.3
2028 \b Patch from Conan Brink to allow nesting of \c{%rep} directives.
2030 \b If we're going to allow INT01 as an alias for INT1/ICEBP (one of
2031   Jules 0.98p3 changes), then we should allow INT03 as an alias for INT3
2032   as well.
2034 \b Updated changes.asm to include the latest changes.
2036 \b Tried to clean up the <CR>s that had snuck in from a DOS/Windows
2037   environment into my Unix environment, and try to make sure than
2038   DOS/Windows users get them back.
2040 \b We would silently generate broken tools if insns.dat wasn't sorted
2041   properly.  Change insns.pl so that the order doesn't matter.
2043 \b Fix bug in insns.pl (introduced by me) which would cause conditional
2044   instructions to have an extra "cc" in disassembly, e.g. "jnz"
2045   disassembled as "jccnz".
2048 \S{cl-0.98p3.2} Version 0.98p3.2
2050 \b Merged in John S. Fine's changes from his 0.98-J4 prerelease; see
2051   http://www.csoft.net/cz/johnfine/
2053 \b Changed previous "spotless" Makefile target (appropriate for distribution)
2054   to "distclean", and added "cleaner" target which is same as "clean"
2055   except deletes files generated by Perl scripts; "spotless" is union.
2057 \b Removed BASIC programs from distribution.  Get a Perl interpreter
2058   instead (see below.)
2060 \b Calling this "pre-release 3.2" rather than "p3-hpa2" because of
2061   John's contributions.
2063 \b Actually link in the IEEE output format (zoutieee.c); fix a bunch of
2064   compiler warnings in that file.  Note I don't know what IEEE output
2065   is supposed to look like, so these changes were made "blind".
2068 \S{cl-0.98p3-hpa} Version 0.98p3-hpa
2070 \b Merged nasm098p3.zip with nasm-0.97.tar.gz to create a fully
2071   buildable version for Unix systems (Makefile.in updates, etc.)
2073 \b Changed insns.pl to create the instruction tables in nasm.h and
2074   names.c, so that a new instruction can be added by adding it *only*
2075   to insns.dat.
2077 \b Added the following new instructions: SYSENTER, SYSEXIT, FXSAVE,
2078   FXRSTOR, UD1, UD2 (the latter two are two opcodes that Intel
2079   guarantee will never be used; one of them is documented as UD2 in
2080   Intel documentation, the other one just as "Undefined Opcode" --
2081   calling it UD1 seemed to make sense.)
2083 \b MAX_SYMBOL was defined to be 9, but LOADALL286 and LOADALL386 are 10
2084   characters long.  Now MAX_SYMBOL is derived from insns.dat.
2086 \b A note on the BASIC programs included: forget them.  insns.bas is
2087   already out of date.  Get yourself a Perl interpreter for your
2088   platform of choice at
2089   \W{http://www.cpan.org/ports/index.html}{http://www.cpan.org/ports/index.html}.
2092 \S{cl-0.98p3} Version 0.98 pre-release 3
2094 \b added response file support, improved command line handling, new layout
2095 help screen
2097 \b fixed limit checking bug, 'OUT byte nn, reg' bug, and a couple of rdoff
2098 related bugs, updated Wishlist; 0.98 Prerelease 3.
2101 \S{cl-0.98p2} Version 0.98 pre-release 2
2103 \b fixed bug in outcoff.c to do with truncating section names longer
2104 than 8 characters, referencing beyond end of string; 0.98 pre-release 2
2107 \S{cl-0.98p1} Version 0.98 pre-release 1
2109 \b Fixed a bug whereby STRUC didn't work at all in RDF.
2111 \b Fixed a problem with group specification in PUBDEFs in OBJ.
2113 \b Improved ease of adding new output formats. Contribution due to
2114 Fox Cutter.
2116 \b Fixed a bug in relocations in the `bin' format: was showing up when
2117 a relocatable reference crossed an 8192-byte boundary in any output
2118 section.
2120 \b Fixed a bug in local labels: local-label lookups were inconsistent
2121 between passes one and two if an EQU occurred between the definition
2122 of a global label and the subsequent use of a local label local to
2123 that global.
2125 \b Fixed a seg-fault in the preprocessor (again) which happened when
2126 you use a blank line as the first line of a multi-line macro
2127 definition and then defined a label on the same line as a call to
2128 that macro.
2130 \b Fixed a stale-pointer bug in the handling of the NASM environment
2131 variable. Thanks to Thomas McWilliams.
2133 \b ELF had a hard limit on the number of sections which caused
2134 segfaults when transgressed. Fixed.
2136 \b Added ability for ndisasm to read from stdin by using `-' as the
2137 filename.
2139 \b ndisasm wasn't outputting the TO keyword. Fixed.
2141 \b Fixed error cascade on bogus expression in \c{%if} - an error in
2142 evaluation was causing the entire \c{%if} to be discarded, thus creating
2143 trouble later when the \c{%else} or \c{%endif} was encountered.
2145 \b Forward reference tracking was instruction-granular not operand-
2146 granular, which was causing 286-specific code to be generated
2147 needlessly on code of the form `shr word [forwardref],1'. Thanks to
2148 Jim Hague for sending a patch.
2150 \b All messages now appear on stdout, as sending them to stderr serves
2151 no useful purpose other than to make redirection difficult.
2153 \b Fixed the problem with EQUs pointing to an external symbol - this
2154 now generates an error message.
2156 \b Allowed multiple size prefixes to an operand, of which only the first
2157 is taken into account.
2159 \b Incorporated John Fine's changes, including fixes of a large number
2160 of preprocessor bugs, some small problems in OBJ, and a reworking of
2161 label handling to define labels before their line is assembled, rather
2162 than after.
2164 \b Reformatted a lot of the source code to be more readable. Included
2165 'coding.txt' as a guideline for how to format code for contributors.
2167 \b Stopped nested \c{%reps} causing a panic - they now cause a slightly more
2168 friendly error message instead.
2170 \b Fixed floating point constant problems (patch by Pedro Gimeno)
2172 \b Fixed the return value of insn_size() not being checked for -1, indicating
2173 an error.
2175 \b Incorporated 3Dnow! instructions.
2177 \b Fixed the 'mov eax, eax + ebx' bug.
2179 \b Fixed the GLOBAL EQU bug in ELF. Released developers release 3.
2181 \b Incorporated John Fine's command line parsing changes
2183 \b Incorporated David Lindauer's OMF debug support
2185 \b Made changes for LCC 4.0 support (\c{__NASM_CDecl__}, removed register size
2186 specification warning when sizes agree).
2189 \H{cl-0.9x} NASM 0.9 Series
2191 Revisions before 0.98.
2194 \S{cl-0.97} Version 0.97 released December 1997
2196 \b This was entirely a bug-fix release to 0.96, which seems to have got
2197 cursed. Silly me.
2199 \b Fixed stupid mistake in OBJ which caused `MOV EAX,<constant>' to
2200 fail. Caused by an error in the `MOV EAX,<segment>' support.
2202 \b ndisasm hung at EOF when compiled with lcc on Linux because lcc on
2203 Linux somehow breaks feof(). ndisasm now does not rely on feof().
2205 \b A heading in the documentation was missing due to a markup error in
2206 the indexing. Fixed.
2208 \b Fixed failure to update all pointers on realloc() within extended-
2209 operand code in parser.c. Was causing wrong behaviour and seg faults
2210 on lines such as `dd 0.0,0.0,0.0,0.0,...'
2212 \b Fixed a subtle preprocessor bug whereby invoking one multi-line
2213 macro on the first line of the expansion of another, when the second
2214 had been invoked with a label defined before it, didn't expand the
2215 inner macro.
2217 \b Added internal.doc back in to the distribution archives - it was
2218 missing in 0.96 *blush*
2220 \b Fixed bug causing 0.96 to be unable to assemble its own test files,
2221 specifically objtest.asm. *blush again*
2223 \b Fixed seg-faults and bogus error messages caused by mismatching
2224 \c{%rep} and \c{%endrep} within multi-line macro definitions.
2226 \b Fixed a problem with buffer overrun in OBJ, which was causing
2227 corruption at ends of long PUBDEF records.
2229 \b Separated DOS archives into main-program and documentation to reduce
2230 download size.
2233 \S{cl-0.96} Version 0.96 released November 1997
2235 \b Fixed a bug whereby, if `nasm sourcefile' would cause a filename
2236 collision warning and put output into `nasm.out', then `nasm
2237 sourcefile -o outputfile' still gave the warning even though the
2238 `-o' was honoured.
2239 Fixed name pollution under Digital UNIX: one of its header files
2240 defined R_SP, which broke the enum in nasm.h.
2242 \b Fixed minor instruction table problems: FUCOM and FUCOMP didn't have
2243 two-operand forms; NDISASM didn't recognise the longer register
2244 forms of PUSH and POP (eg FF F3 for PUSH BX); TEST mem,imm32 was
2245 flagged as undocumented; the 32-bit forms of CMOV had 16-bit operand
2246 size prefixes; `AAD imm' and `AAM imm' are no longer flagged as
2247 undocumented because the Intel Architecture reference documents
2248 them.
2250 \b Fixed a problem with the local-label mechanism, whereby strange
2251 types of symbol (EQUs, auto-defined OBJ segment base symbols)
2252 interfered with the `previous global label' value and screwed up
2253 local labels.
2255 \b Fixed a bug whereby the stub preprocessor didn't communicate with
2256 the listing file generator, so that the -a and -l options in
2257 conjunction would produce a useless listing file.
2259 \b Merged `os2' object file format back into `obj', after discovering
2260 that `obj' _also_ shouldn't have a link pass separator in a module
2261 containing a non-trivial MODEND. Flat segments are now declared
2262 using the FLAT attribute. `os2' is no longer a valid object format
2263 name: use `obj'.
2265 \b Removed the fixed-size temporary storage in the evaluator. Very very
2266 long expressions (like `mov ax,1+1+1+1+...' for two hundred 1s or
2267 so) should now no longer crash NASM.
2269 \b Fixed a bug involving segfaults on disassembly of MMX instructions,
2270 by changing the meaning of one of the operand-type flags in nasm.h.
2271 This may cause other apparently unrelated MMX problems; it needs to
2272 be tested thoroughly.
2274 \b Fixed some buffer overrun problems with large OBJ output files.
2275 Thanks to DJ Delorie for the bug report and fix.
2277 \b Made preprocess-only mode actually listen to the \c{%line} markers as it
2278 prints them, so that it can report errors more sanely.
2280 \b Re-designed the evaluator to keep more sensible track of expressions
2281 involving forward references: can now cope with previously-nightmare
2282 situations such as:
2284 \c   mov ax,foo | bar
2285 \c   foo equ 1
2286 \c   bar equ 2
2288 \b Added the ALIGN and ALIGNB standard macros.
2290 \b Added PIC support in ELF: use of WRT to obtain the four extra
2291 relocation types needed.
2293 \b Added the ability for output file formats to define their own
2294 extensions to the GLOBAL, COMMON and EXTERN directives.
2296 \b Implemented common-variable alignment, and global-symbol type and
2297 size declarations, in ELF.
2299 \b Implemented NEAR and FAR keywords for common variables, plus
2300 far-common element size specification, in OBJ.
2302 \b Added a feature whereby EXTERNs and COMMONs in OBJ can be given a
2303 default WRT specification (either a segment or a group).
2305 \b Transformed the Unix NASM archive into an auto-configuring package.
2307 \b Added a sanity-check for people applying SEG to things which are
2308 already segment bases: this previously went unnoticed by the SEG
2309 processing and caused OBJ-driver panics later.
2311 \b Added the ability, in OBJ format, to deal with `MOV EAX,<segment>'
2312 type references: OBJ doesn't directly support dword-size segment
2313 base fixups, but as long as the low two bytes of the constant term
2314 are zero, a word-size fixup can be generated instead and it will
2315 work.
2317 \b Added the ability to specify sections' alignment requirements in
2318 Win32 object files and pure binary files.
2320 \b Added preprocess-time expression evaluation: the \c{%assign} (and
2321 \c{%iassign}) directive and the bare \c{%if} (and \c{%elif}) conditional. Added
2322 relational operators to the evaluator, for use only in \c{%if}
2323 constructs: the standard relationals = < > <= >= <> (and C-like
2324 synonyms == and !=) plus low-precedence logical operators &&, ^^ and
2327 \b Added a preprocessor repeat construct: \c{%rep} / \c{%exitrep} / \c{%endrep}.
2329 \b Added the __FILE__ and __LINE__ standard macros.
2331 \b Added a sanity check for number constants being greater than
2332 0xFFFFFFFF. The warning can be disabled.
2334 \b Added the %0 token whereby a variadic multi-line macro can tell how
2335 many parameters it's been given in a specific invocation.
2337 \b Added \c{%rotate}, allowing multi-line macro parameters to be cycled.
2339 \b Added the `*' option for the maximum parameter count on multi-line
2340 macros, allowing them to take arbitrarily many parameters.
2342 \b Added the ability for the user-level forms of EXTERN, GLOBAL and
2343 COMMON to take more than one argument.
2345 \b Added the IMPORT and EXPORT directives in OBJ format, to deal with
2346 Windows DLLs.
2348 \b Added some more preprocessor \c{%if} constructs: \c{%ifidn} / \c{%ifidni} (exact
2349 textual identity), and \c{%ifid} / \c{%ifnum} / \c{%ifstr} (token type testing).
2351 \b Added the ability to distinguish SHL AX,1 (the 8086 version) from
2352 SHL AX,BYTE 1 (the 286-and-upwards version whose constant happens to
2353 be 1).
2355 \b Added NetBSD/FreeBSD/OpenBSD's variant of a.out format, complete
2356 with PIC shared library features.
2358 \b Changed NASM's idiosyncratic handling of FCLEX, FDISI, FENI, FINIT,
2359 FSAVE, FSTCW, FSTENV, and FSTSW to bring it into line with the
2360 otherwise accepted standard. The previous behaviour, though it was a
2361 deliberate feature, was a deliberate feature based on a
2362 misunderstanding. Apologies for the inconvenience.
2364 \b Improved the flexibility of ABSOLUTE: you can now give it an
2365 expression rather than being restricted to a constant, and it can
2366 take relocatable arguments as well.
2368 \b Added the ability for a variable to be declared as EXTERN multiple
2369 times, and the subsequent definitions are just ignored.
2371 \b We now allow instruction prefixes (CS, DS, LOCK, REPZ etc) to be
2372 alone on a line (without a following instruction).
2374 \b Improved sanity checks on whether the arguments to EXTERN, GLOBAL
2375 and COMMON are valid identifiers.
2377 \b Added misc/exebin.mac to allow direct generation of .EXE files by
2378 hacking up an EXE header using DB and DW; also added test/binexe.asm
2379 to demonstrate the use of this. Thanks to Yann Guidon for
2380 contributing the EXE header code.
2382 \b ndisasm forgot to check whether the input file had been successfully
2383 opened. Now it does. Doh!
2385 \b Added the Cyrix extensions to the MMX instruction set.
2387 \b Added a hinting mechanism to allow [EAX+EBX] and [EBX+EAX] to be
2388 assembled differently. This is important since [ESI+EBP] and
2389 [EBP+ESI] have different default base segment registers.
2391 \b Added support for the PharLap OMF extension for 4096-byte segment
2392 alignment.
2395 \S{cl-0.95 released July 1997} Version 0.95 released July 1997
2397 \b Fixed yet another ELF bug. This one manifested if the user relied on
2398 the default segment, and attempted to define global symbols without
2399 first explicitly declaring the target segment.
2401 \b Added makefiles (for NASM and the RDF tools) to build Win32 console
2402 apps under Symantec C++. Donated by Mark Junker.
2404 \b Added `macros.bas' and `insns.bas', QBasic versions of the Perl
2405 scripts that convert `standard.mac' to `macros.c' and convert
2406 `insns.dat' to `insnsa.c' and `insnsd.c'. Also thanks to Mark
2407 Junker.
2409 \b Changed the diassembled forms of the conditional instructions so
2410 that JB is now emitted as JC, and other similar changes. Suggested
2411 list by Ulrich Doewich.
2413 \b Added `@' to the list of valid characters to begin an identifier
2414 with.
2416 \b Documentary changes, notably the addition of the `Common Problems'
2417 section in nasm.doc.
2419 \b Fixed a bug relating to 32-bit PC-relative fixups in OBJ.
2421 \b Fixed a bug in perm_copy() in labels.c which was causing exceptions
2422 in cleanup_labels() on some systems.
2424 \b Positivity sanity check in TIMES argument changed from a warning to
2425 an error following a further complaint.
2427 \b Changed the acceptable limits on byte and word operands to allow
2428 things like `~10111001b' to work.
2430 \b Fixed a major problem in the preprocessor which caused seg-faults if
2431 macro definitions contained blank lines or comment-only lines.
2433 \b Fixed inadequate error checking on the commas separating the
2434 arguments to `db', `dw' etc.
2436 \b Fixed a crippling bug in the handling of macros with operand counts
2437 defined with a `+' modifier.
2439 \b Fixed a bug whereby object file formats which stored the input file
2440 name in the output file (such as OBJ and COFF) weren't doing so
2441 correctly when the output file name was specified on the command
2442 line.
2444 \b Removed [INC] and [INCLUDE] support for good, since they were
2445 obsolete anyway.
2447 \b Fixed a bug in OBJ which caused all fixups to be output in 16-bit
2448 (old-format) FIXUPP records, rather than putting the 32-bit ones in
2449 FIXUPP32 (new-format) records.
2451 \b Added, tentatively, OS/2 object file support (as a minor variant on
2452 OBJ).
2454 \b Updates to Fox Cutter's Borland C makefile, Makefile.bc2.
2456 \b Removed a spurious second fclose() on the output file.
2458 \b Added the `-s' command line option to redirect all messages which
2459 would go to stderr (errors, help text) to stdout instead.
2461 \b Added the `-w' command line option to selectively suppress some
2462 classes of assembly warning messages.
2464 \b Added the `-p' pre-include and `-d' pre-define command-line options.
2466 \b Added an include file search path: the `-i' command line option.
2468 \b Fixed a silly little preprocessor bug whereby starting a line with a
2469 `%!' environment-variable reference caused an `unknown directive'
2470 error.
2472 \b Added the long-awaited listing file support: the `-l' command line
2473 option.
2475 \b Fixed a problem with OBJ format whereby, in the absence of any
2476 explicit segment definition, non-global symbols declared in the
2477 implicit default segment generated spurious EXTDEF records in the
2478 output.
2480 \b Added the NASM environment variable.
2482 \b From this version forward, Win32 console-mode binaries will be
2483 included in the DOS distribution in addition to the 16-bit binaries.
2484 Added Makefile.vc for this purpose.
2486 \b Added `return 0;' to test/objlink.c to prevent compiler warnings.
2488 \b Added the __NASM_MAJOR__ and __NASM_MINOR__ standard defines.
2490 \b Added an alternative memory-reference syntax in which prefixing an
2491 operand with `&' is equivalent to enclosing it in square brackets,
2492 at the request of Fox Cutter.
2494 \b Errors in pass two now cause the program to return a non-zero error
2495 code, which they didn't before.
2497 \b Fixed the single-line macro cycle detection, which didn't work at
2498 all on macros with no parameters (caused an infinite loop). Also
2499 changed the behaviour of single-line macro cycle detection to work
2500 like cpp, so that macros like `extrn' as given in the documentation
2501 can be implemented.
2503 \b Fixed the implementation of WRT, which was too restrictive in that
2504 you couldn't do `mov ax,[di+abc wrt dgroup]' because (di+abc) wasn't
2505 a relocatable reference.
2508 \S{cl-0.94 released April 1997} Version 0.94 released April 1997
2511 \b Major item: added the macro processor.
2513 \b Added undocumented instructions SMI, IBTS, XBTS and LOADALL286. Also
2514 reorganised CMPXCHG instruction into early-486 and Pentium forms.
2515 Thanks to Thobias Jones for the information.
2517 \b Fixed two more stupid bugs in ELF, which were causing `ld' to
2518 continue to seg-fault in a lot of non-trivial cases.
2520 \b Fixed a seg-fault in the label manager.
2522 \b Stopped FBLD and FBSTP from _requiring_ the TWORD keyword, which is
2523 the only option for BCD loads/stores in any case.
2525 \b Ensured FLDCW, FSTCW and FSTSW can cope with the WORD keyword, if
2526 anyone bothers to provide it. Previously they complained unless no
2527 keyword at all was present.
2529 \b Some forms of FDIV/FDIVR and FSUB/FSUBR were still inverted: a
2530 vestige of a bug that I thought had been fixed in 0.92. This was
2531 fixed, hopefully for good this time...
2533 \b Another minor phase error (insofar as a phase error can _ever_ be
2534 minor) fixed, this one occurring in code of the form
2536 \c   rol ax,forward_reference
2537 \c   forward_reference equ 1
2539 \b The number supplied to TIMES is now sanity-checked for positivity,
2540 and also may be greater than 64K (which previously didn't work on
2541 16-bit systems).
2543 \b Added Watcom C makefiles, and misc/pmw.bat, donated by Dominik Behr.
2545 \b Added the INCBIN pseudo-opcode.
2547 \b Due to the advent of the preprocessor, the [INCLUDE] and [INC]
2548 directives have become obsolete. They are still supported in this
2549 version, with a warning, but won't be in the next.
2551 \b Fixed a bug in OBJ format, which caused incorrect object records to
2552 be output when absolute labels were made global.
2554 \b Updates to RDOFF subdirectory, and changes to outrdf.c.
2557 \S{cl-0.93 released January 1997} Version 0.93 released January 1997
2559 This release went out in a great hurry after semi-crippling bugs
2560 were found in 0.92.
2562 \b Really \e{did} fix the stack overflows this time. *blush*
2564 \b Had problems with EA instruction sizes changing between passes, when
2565 an offset contained a forward reference and so 4 bytes were
2566 allocated for the offset in pass one; by pass two the symbol had
2567 been defined and happened to be a small absolute value, so only 1
2568 byte got allocated, causing instruction size mismatch between passes
2569 and hence incorrect address calculations. Fixed.
2571 \b Stupid bug in the revised ELF section generation fixed (associated
2572 string-table section for .symtab was hard-coded as 7, even when this
2573 didn't fit with the real section table). Was causing `ld' to
2574 seg-fault under Linux.
2576 \b Included a new Borland C makefile, Makefile.bc2, donated by Fox
2577 Cutter <lmb@comtch.iea.com>.
2580 \S{cl-0.92 released January 1997} Version 0.92 released January 1997
2582 \b The FDIVP/FDIVRP and FSUBP/FSUBRP pairs had been inverted: this was
2583 fixed. This also affected the LCC driver.
2585 \b Fixed a bug regarding 32-bit effective addresses of the form
2586 \c{[other_register+ESP]}.
2588 \b Documentary changes, notably documentation of the fact that Borland
2589 Win32 compilers use `obj' rather than `win32' object format.
2591 \b Fixed the COMENT record in OBJ files, which was formatted
2592 incorrectly.
2594 \b Fixed a bug causing segfaults in large RDF files.
2596 \b OBJ format now strips initial periods from segment and group
2597 definitions, in order to avoid complications with the local label
2598 syntax.
2600 \b Fixed a bug in disassembling far calls and jumps in NDISASM.
2602 \b Added support for user-defined sections in COFF and ELF files.
2604 \b Compiled the DOS binaries with a sensible amount of stack, to
2605 prevent stack overflows on any arithmetic expression containing
2606 parentheses.
2608 \b Fixed a bug in handling of files that do not terminate in a newline.
2611 \S{cl-0.91 released November 1996} Version 0.91 released November 1996
2613 \b Loads of bug fixes.
2615 \b Support for RDF added.
2617 \b Support for DBG debugging format added.
2619 \b Support for 32-bit extensions to Microsoft OBJ format added.
2621 \b Revised for Borland C: some variable names changed, makefile added.
2623 \b LCC support revised to actually work.
2625 \b JMP/CALL NEAR/FAR notation added.
2627 \b `a16', `o16', `a32' and `o32' prefixes added.
2629 \b Range checking on short jumps implemented.
2631 \b MMX instruction support added.
2633 \b Negative floating point constant support added.
2635 \b Memory handling improved to bypass 64K barrier under DOS.
2637 \b \c{$} prefix to force treatment of reserved words as identifiers added.
2639 \b Default-size mechanism for object formats added.
2641 \b Compile-time configurability added.
2643 \b \c{#}, \c{@}, \c{~} and c\{?} are now valid characters in labels.
2645 \b \c{-e} and \c{-k} options in NDISASM added.
2648 \S{cl-0.90 released October 1996} Version 0.90 released October 1996
2650 First release version. First support for object file output. Other
2651 changes from previous version (0.3x) too numerous to document.