insns: One more slab of AVX2 instructions
[nasm.git] / doc / changes.src
blobd3ed5746ee9d43e97a1f5080677fef1529dbe8e2
1 \#
2 \# NASM revision history in nasmdoc format
3 \#
5 \H{cl-2.xx} NASM 2 Series
7 The NASM 2 series support x86-64, and is the production version of NASM
8 since 2007.
10 \S{cl-2.10} Version 2.10
12 \b When optimization is enabled, \c{mov r64,imm} now optimizes to the
13   shortest form possible between:
15 \c      mov r32,imm32                   ;  5 bytes
16 \c      mov r64,imm32                   ;  7 bytes
17 \c      mov r64,imm64                   ; 10 bytes
19 To force a specific form, use the \c{STRICT} keyword, see \k{strict}.
22 \S{cl-2.09.10} Version 2.09.10
24 \b Fix up NSIS script to protect uninstaller against registry keys
25    absence or corruption. It brings in a few additional questions
26    to a user during deinstallation procedure but still it is better
27    than unpredictable file removal.
30 \S{cl-2.09.09} Version 2.09.09
32 \b Fix initialization of section attributes of \c{bin} output format.
34 \b Fix \c{mach64} output format bug that crashes NASM due to NULL symbols.
37 \S{cl-2.09.08} Version 2.09.08
39 \b Fix \c{__OUTPUT_FORMAT__} assignment when output driver alias
40    is used. For example when \c{-f elf} is used \c{__OUTPUT_FORMAT__}
41    must be set to \c{elf}, if \c{-f elf32} is used \c{__OUTPUT_FORMAT__}
42    must be assigned accordingly, i.e. to \c{elf32}. The rule applies to
43    all output driver aliases. See \k{ofmtm}.
46 \S{cl-2.09.07} Version 2.09.07
48 \b Fix attempts to close same file several times
49    when \c{-a} option is used.
51 \b Fixes for VEXTRACTF128, VMASKMOVPS encoding.
54 \S{cl-2.09.06} Version 2.09.06
56 \b Fix missed section attribute initialization in \c{bin} output target.
59 \S{cl-2.09.05} Version 2.09.05
61 \b Fix arguments encoding for VPEXTRW instruction.
63 \b Remove invalid form of VPEXTRW instruction.
65 \b Add \c{VLDDQU} as alias for \c{VLDQQU} to
66    match specification.
69 \S{cl-2.09.04} Version 2.09.04
71 \b Fix incorrect labels offset for VEX intructions.
73 \b Eliminate bogus warning on implicit operand size override.
75 \b \c{%if} term could not handle 64 bit numbers.
77 \b The COFF backend was limiting relocations number to 16 bits even if
78    in real there were a way more relocations.
81 \S{cl-2.09.03} Version 2.09.03
83 \b Print \c{%macro} name inside \c{%rep} blocks on error.
85 \b Fix preprocessor expansion behaviour. It happened sometime
86    too early and sometime simply wrong. Move behaviour back to
87    the origins (down to NASM 2.05.01).
89 \b Fix unitialized data dereference on OMF output format.
91 \b Issue warning on unterminated \c{%{} construct.
93 \b Fix for documentation typo.
96 \S{cl-2.09.02} Version 2.09.02
98 \b Fix reversed tokens when \c{%deftok} produces more than one output token.
100 \b Fix segmentation fault on disassembling some VEX instructions.
102 \b Missing \c{%endif} did not always cause error.
104 \b Fix typo in documentation.
106 \b Compound context local preprocessor single line macro identifiers
107   were not expanded early enough and as result lead to unresolved
108   symbols.
111 \S{cl-2.09.01} Version 2.09.01
113 \b Fix NULL dereference on missed %deftok second parameter.
115 \b Fix NULL dereference on invalid %substr parameters.
118 \S{cl-2.09} Version 2.09
120 \b Fixed assignment the magnitude of \c{%rep} counter. It is limited
121   to 62 bits now.
123 \b Fixed NULL dereference if argument of \c{%strlen} resolves
124   to whitespace. For example if nonexistent macro parameter is used.
126 \b \c{%ifenv}, \c{%elifenv}, \c{%ifnenv}, and \c{%elifnenv} directives
127   introduced.  See \k{ifenv}.
129 \b Fixed NULL dereference if environment variable is missed.
131 \b Updates of new AVX v7 Intel instructions.
133 \b \c{PUSH imm32} is now officially documented.
135 \b Fix for encoding the LFS, LGS and LSS in 64-bit mode.
137 \b Fixes for compatibility with OpenWatcom compiler and DOS 8.3 file
138   format limitation.
140 \b Macros parameters range expansion introduced. See \k{mlmacrange}.
142 \b Backward compatibility on expanging of local sigle macros restored.
144 \b 8 bit relocations for \c{elf} and \c{bin} output formats are introduced.
146 \b Short intersegment jumps are permitted now.
148 \b An alignment more than 64 bytes are allowed for \c{win32},
149   \c{win64} output formats.
151 \b \c{SECTALIGN} directive introduced. See \k{sectalign}.
153 \b \c{nojmp} option introduced in \c{smartalign} package. See
154   \k{pkg_smartalign}.
156 \b Short aliases \c{win}, \c{elf} and \c{macho} for output formats are
157   introduced.  Each stands for \c{win32}, \c{elf32} and \c{macho32}
158   accordingly.
160 \b Faster handling of missing directives implemented.
162 \b Various small improvements in documentation.
164 \b No hang anymore if unable to open malloc.log file.
166 \b The environments without vsnprintf function are able to build nasm again.
168 \b AMD LWP instructions updated.
170 \b Tighten EA checks. We warn a user if there overflow in EA addressing.
172 \b Make \c{-Ox} the default optimization level.  For the legacy
173   behavior, specify \c{-O0} explicitly.  See \k{opt-O}.
175 \b Environment variables read with \c{%!} or tested with \c{%ifenv}
176   can now contain non-identifier characters if surrounded by quotes.
177   See \k{getenv}.
179 \b Add a new standard macro package \c{%use fp} for floating-point
180   convenience macros.  See \k{pkg_fp}.
183 \S{cl-2.08.02} Version 2.08.02
185 \b Fix crash under certain circumstances when using the \c{%+} operator.
188 \S{cl-2.08.01} Version 2.08.01
190 \b Fix the \c{%use} statement, which was broken in 2.08.
193 \S{cl-2.08} Version 2.08
195 \b A number of enhancements/fixes in macros area.
197 \#\b Support for arbitrarily terminating macro expansions \c{%exitmacro}.
198 \#  See \k{exitmacro}.
200 \#\b Support for recursive macro expansion \c{%rmacro}/\c{%irmacro}.
201 \#  See \k{mlrmacro}.
203 \b Support for converting strings to tokens.  See \k{deftok}.
205 \b Fuzzy operand size logic introduced.
207 \b Fix COFF stack overrun on too long export identifiers.
209 \b Fix Macho-O alignment bug.
211 \b Fix crashes with -fwin32 on file with many exports.
213 \b Fix stack overrun for too long [DEBUG id].
215 \b Fix incorrect sbyte usage in IMUL (hit only if optimization
216   flag passed).
218 \b Append ending token for \c{.stabs} records in the ELF output format.
220 \b New NSIS script which uses ModernUI and MultiUser approach.
222 \b Visual Studio 2008 NASM integration (rules file).
224 \b Warn a user if a constant is too long (and as result will be stripped).
226 \b The obsoleted pre-XOP AMD SSE5 instruction set which was never actualized
227   was removed.
229 \b Fix stack overrun on too long error file name passed from the command line.
231 \b Bind symbols to the .text section by default (ie in case if SECTION
232   directive was omitted) in the ELF output format.
234 \b Fix sync points array index wrapping.
236 \b A few fixes for FMA4 and XOP instruction templates.
238 \b Add AMD Lightweight Profiling (LWP) instructions.
240 \b Fix the offset for \c{%arg} in 64-bit mode.
242 \b An undefined local macro (\c{%$}) no longer matches a global macro
243   with the same name.
245 \b Fix NULL dereference on too long local labels.
248 \S{cl-2.07} Version 2.07
250 \b NASM is now under the 2-clause BSD license.  See \k{legal}.
252 \b Fix the section type for the \c{.strtab} section in the \c{elf64}
253   output format.
255 \b Fix the handling of \c{COMMON} directives in the \c{obj} output format.
257 \b New \c{ith} and \c{srec} output formats; these are variants of the
258   \c{bin} output format which output Intel hex and Motorola S-records,
259   respectively.  See \k{ithfmt} and \k{srecfmt}.
261 \b \c{rdf2ihx} replaced with an enhanced \c{rdf2bin}, which can output
262   binary, COM, Intel hex or Motorola S-records.
264 \b The Windows installer now puts the NASM directory first in the
265   \c{PATH} of the "NASM Shell".
267 \b Revert the early expansion behavior of \c{%+} to pre-2.06 behavior:
268   \c{%+} is only expanded late.
270 \b Yet another Mach-O alignment fix.
272 \b Don't delete the list file on errors.  Also, include error and
273   warning information in the list file.
275 \b Support for 64-bit Mach-O output, see \k{machofmt}.
277 \b Fix assert failure on certain operations that involve strings with
278   high-bit bytes.
281 \S{cl-2.06} Version 2.06
283 \b This release is dedicated to the memory of Charles A. Crayne, long
284   time NASM developer as well as moderator of \c{comp.lang.asm.x86} and
285   author of the book \e{Serious Assembler}.  We miss you, Chuck.
287 \b Support for indirect macro expansion (\c{%[...]}).  See \k{indmacro}.
289 \b \c{%pop} can now take an argument, see \k{pushpop}.
291 \b The argument to \c{%use} is no longer macro-expanded.  Use
292   \c{%[...]} if macro expansion is desired.
294 \b Support for thread-local storage in ELF32 and ELF64.  See \k{elftls}.
296 \b Fix crash on \c{%ifmacro} without an argument.
298 \b Correct the arguments to the \c{POPCNT} instruction.
300 \b Fix section alignment in the Mach-O format.
302 \b Update AVX support to version 5 of the Intel specification.
304 \b Fix the handling of accesses to context-local macros from higher
305   levels in the context stack.
307 \b Treat \c{WAIT} as a prefix rather than as an instruction, thereby
308   allowing constructs like \c{O16 FSAVE} to work correctly.
310 \b Support for structures with a non-zero base offset. See \k{struc}.
312 \b Correctly handle preprocessor token concatenation (see \k{concat})
313    involving floating-point numbers.
315 \b The \c{PINSR} series of instructions have been corrected and
316    rationalized.
318 \b Removed AMD SSE5, replaced with the new XOP/FMA4/CVT16 (rev 3.03)
319    spec.
321 \b The ELF backends no longer automatically generate a \c{.comment} section.
323 \b Add additional "well-known" ELF sections with default attributes.  See
324    \k{elfsect}.
327 \S{cl-2.05.01} Version 2.05.01
329 \b Fix the \c{-w}/\c{-W} option parsing, which was broken in NASM 2.05.
332 \S{cl-2.05} Version 2.05
334 \b Fix redundant REX.W prefix on \c{JMP reg64}.
336 \b Make the behaviour of \c{-O0} match NASM 0.98 legacy behavior.
337   See \k{opt-O}.
339 \b \c{-w-user} can be used to suppress the output of \c{%warning} directives.
340   See \k{opt-w}.
342 \b Fix bug where \c{ALIGN} would issue a full alignment datum instead of
343   zero bytes.
345 \b Fix offsets in list files.
347 \b Fix \c{%include} inside multi-line macros or loops.
349 \b Fix error where NASM would generate a spurious warning on valid
350   optimizations of immediate values.
352 \b Fix arguments to a number of the \c{CVT} SSE instructions.
354 \b Fix RIP-relative offsets when the instruction carries an immediate.
356 \b Massive overhaul of the ELF64 backend for spec compliance.
358 \b Fix the Geode \c{PFRCPV} and \c{PFRSQRTV} instruction.
360 \b Fix the SSE 4.2 \c{CRC32} instruction.
363 \S{cl-2.04} Version 2.04
365 \b Sanitize macro handing in the \c{%error} directive.
367 \b New \c{%warning} directive to issue user-controlled warnings.
369 \b \c{%error} directives are now deferred to the final assembly phase.
371 \b New \c{%fatal} directive to immediately terminate assembly.
373 \b New \c{%strcat} directive to join quoted strings together.
375 \b New \c{%use} macro directive to support standard macro directives.  See
376   \k{use}.
378 \b Excess default parameters to \c{%macro} now issues a warning by default.
379   See \k{mlmacro}.
381 \b Fix \c{%ifn} and \c{%elifn}.
383 \b Fix nested \c{%else} clauses.
385 \b Correct the handling of nested \c{%rep}s.
387 \b New \c{%unmacro} directive to undeclare a multi-line macro.
388   See \k{unmacro}.
390 \b Builtin macro \c{__PASS__} which expands to the current assembly pass.
391   See \k{pass_macro}.
393 \b \c{__utf16__} and \c{__utf32__} operators to generate UTF-16 and UTF-32
394   strings.  See \k{unicode}.
396 \b Fix bug in case-insensitive matching when compiled on platforms that
397   don't use the \c{configure} script.  Of the official release binaries,
398   that only affected the OS/2 binary.
400 \b Support for x87 packed BCD constants.  See \k{bcdconst}.
402 \b Correct the \c{LTR} and \c{SLDT} instructions in 64-bit mode.
404 \b Fix unnecessary REX.W prefix on indirect jumps in 64-bit mode.
406 \b Add AVX versions of the AES instructions (\c{VAES}...).
408 \b Fix the 256-bit FMA instructions.
410 \b Add 256-bit AVX stores per the latest AVX spec.
412 \b VIA XCRYPT instructions can now be written either with or without
413   \c{REP}, apparently different versions of the VIA spec wrote them
414   differently.
416 \b Add missing 64-bit \c{MOVNTI} instruction.
418 \b Fix the operand size of \c{VMREAD} and \c{VMWRITE}.
420 \b Numerous bug fixes, especially to the AES, AVX and VTX instructions.
422 \b The optimizer now always runs until it converges.  It also runs even
423   when disabled, but doesn't optimize.  This allows most forward references
424   to be resolved properly.
426 \b \c{%push} no longer needs a context identifier; omitting the context
427   identifier results in an anonymous context.
430 \S{cl-2.03.01} Version 2.03.01
432 \b Fix buffer overflow in the listing module.
434 \b Fix the handling of hexadecimal escape codes in `...` strings.
436 \b The Postscript/PDF documentation has been reformatted.
438 \b The \c{-F} option now implies \c{-g}.
441 \S{cl-2.03} Version 2.03
443 \b Add support for Intel AVX, CLMUL and FMA instructions,
444 including YMM registers.
446 \b \c{dy}, \c{resy} and \c{yword} for 32-byte operands.
448 \b Fix some SSE5 instructions.
450 \b Intel \c{INVEPT}, \c{INVVPID} and \c{MOVBE} instructions.
452 \b Fix checking for critical expressions when the optimizer is enabled.
454 \b Support the DWARF debugging format for ELF targets.
456 \b Fix optimizations of signed bytes.
458 \b Fix operation on bigendian machines.
460 \b Fix buffer overflow in the preprocessor.
462 \b \c{SAFESEH} support for Win32, \c{IMAGEREL} for Win64 (SEH).
464 \b \c{%?} and \c{%??} to refer to the name of a macro itself.  In particular,
465 \c{%idefine keyword $%?} can be used to make a keyword "disappear".
467 \b New options for dependency generation: \c{-MD}, \c{-MF},
468 \c{-MP}, \c{-MT}, \c{-MQ}.
470 \b New preprocessor directives \c{%pathsearch} and \c{%depend}; INCBIN
471 reimplemented as a macro.
473 \b \c{%include} now resolves macros in a sane manner.
475 \b \c{%substr} can now be used to get other than one-character substrings.
477 \b New type of character/string constants, using backquotes (\c{`...`}),
478 which support C-style escape sequences.
480 \b \c{%defstr} and \c{%idefstr} to stringize macro definitions before
481 creation.
483 \b Fix forward references used in \c{EQU} statements.
486 \S{cl-2.02} Version 2.02
488 \b Additional fixes for MMX operands with explicit \c{qword}, as well as
489   (hopefully) SSE operands with \c{oword}.
491 \b Fix handling of truncated strings with \c{DO}.
493 \b Fix segfaults due to memory overwrites when floating-point constants
494   were used.
496 \b Fix segfaults due to missing include files.
498 \b Fix OpenWatcom Makefiles for DOS and OS/2.
500 \b Add autogenerated instruction list back into the documentation.
502 \b ELF: Fix segfault when generating stabs, and no symbols have been
503   defined.
505 \b ELF: Experimental support for DWARF debugging information.
507 \b New compile date and time standard macros.
509 \b \c{%ifnum} now returns true for negative numbers.
511 \b New \c{%iftoken} test for a single token.
513 \b New \c{%ifempty} test for empty expansion.
515 \b Add support for the \c{XSAVE} instruction group.
517 \b Makefile for Netware/gcc.
519 \b Fix issue with some warnings getting emitted way too many times.
521 \b Autogenerated instruction list added to the documentation.
524 \S{cl-2.01} Version 2.01
526 \b Fix the handling of MMX registers with explicit \c{qword} tags on
527   memory (broken in 2.00 due to 64-bit changes.)
529 \b Fix the PREFETCH instructions.
531 \b Fix the documentation.
533 \b Fix debugging info when using \c{-f elf}
534 (backwards compatibility alias for \c{-f elf32}).
536 \b Man pages for rdoff tools (from the Debian project.)
538 \b ELF: handle large numbers of sections.
540 \b Fix corrupt output when the optimizer runs out of passes.
543 \S{cl-2.00} Version 2.00
545 \b Added c99 data-type compliance.
547 \b Added general x86-64 support.
549 \b Added win64 (x86-64 COFF) output format.
551 \b Added \c{__BITS__} standard macro.
553 \b Renamed the \c{elf} output format to \c{elf32} for clarity.
555 \b Added \c{elf64} and \c{macho} (MacOS X) output formats.
557 \b Added Numeric constants in \c{dq} directive.
559 \b Added \c{oword}, \c{do} and \c{reso} pseudo operands.
561 \b Allow underscores in numbers.
563 \b Added 8-, 16- and 128-bit floating-point formats.
565 \b Added binary, octal and hexadecimal floating-point.
567 \b Correct the generation of floating-point constants.
569 \b Added floating-point option control.
571 \b Added Infinity and NaN floating point support.
573 \b Added ELF Symbol Visibility support.
575 \b Added setting OSABI value in ELF header directive.
577 \b Added Generate Makefile Dependencies option.
579 \b Added Unlimited Optimization Passes option.
581 \b Added \c{%IFN} and \c{%ELIFN} support.
583 \b Added Logical Negation Operator.
585 \b Enhanced Stack Relative Preprocessor Directives.
587 \b Enhanced ELF Debug Formats.
589 \b Enhanced Send Errors to a File option.
591 \b Added SSSE3, SSE4.1, SSE4.2, SSE5 support.
593 \b Added a large number of additional instructions.
595 \b Significant performance improvements.
597 \b \c{-w+warning} and \c{-w-warning} can now be written as -Wwarning and
598  -Wno-warning, respectively.  See \k{opt-w}.
600 \b Add \c{-w+error} to treat warnings as errors.  See \k{opt-w}.
602 \b Add \c{-w+all} and \c{-w-all} to enable or disable all suppressible
603  warnings.  See \k{opt-w}.
606 \H{cl-0.98.xx} NASM 0.98 Series
608 The 0.98 series was the production versions of NASM from 1999 to 2007.
611 \S{cl-0.98.39} Version 0.98.39
613 \b fix buffer overflow
615 \b fix outas86's \c{.bss} handling
617 \b "make spotless" no longer deletes config.h.in.
619 \b \c{%(el)if(n)idn} insensitivity to string quotes difference (#809300).
621 \b (nasm.c)\c{__OUTPUT_FORMAT__} changed to string value instead of symbol.
623 \S{cl-0.98.38} Version 0.98.38
626 \b Add Makefile for 16-bit DOS binaries under OpenWatcom, and modify
627   \c{mkdep.pl} to be able to generate completely pathless dependencies, as
628   required by OpenWatcom wmake (it supports path searches, but not
629   explicit paths.)
631 \b Fix the \c{STR} instruction.
633 \b Fix the ELF output format, which was broken under certain
634   circumstances due to the addition of stabs support.
636 \b Quick-fix Borland format debug-info for \c{-f obj}
638 \b Fix for \c{%rep} with no arguments (#560568)
640 \b Fix concatenation of preprocessor function call (#794686)
642 \b Fix long label causes coredump (#677841)
644 \b Use autoheader as well as autoconf to keep configure from generating
645   ridiculously long command lines.
647 \b Make sure that all of the formats which support debugging output
648   actually will suppress debugging output when \c{-g} not specified.
650 \S{cl-0.98.37} Version 0.98.37
653 \b Paths given in \c{-I} switch searched for \c{incbin}-ed as
654   well as \c{%include}-ed files.
656 \b Added stabs debugging for the ELF output format, patch from
657   Martin Wawro.
659 \b Fix \c{output/outbin.c} to allow origin > 80000000h.
661 \b Make \c{-U} switch work.
663 \b Fix the use of relative offsets with explicit prefixes, e.g.
664 \c{a32 loop foo}.
666 \b Remove \c{backslash()}.
668 \b Fix the \c{SMSW} and \c{SLDT} instructions.
670 \b \c{-O2} and \c{-O3} are no longer aliases for \c{-O10} and \c{-O15}.
671 If you mean the latter, please say so! :)
673 \S{cl-0.98.36} Version 0.98.36
676 \b Update rdoff - librarian/archiver - common rec - docs!
678 \b Fix signed/unsigned problems.
680 \b Fix \c{JMP FAR label} and \c{CALL FAR label}.
682 \b Add new multisection support - map files - fix align bug
684 \b Fix sysexit, movhps/movlps reg,reg bugs in insns.dat
686 \b \c{Q} or \c{O} suffixes indicate octal
688 \b Support Prescott new instructions (PNI).
690 \b Cyrix \c{XSTORE} instruction.
693 \S{cl-0.98.35} Version 0.98.35
695 \b Fix build failure on 16-bit DOS (Makefile.bc3 workaround for compiler bug.)
697 \b Fix dependencies and compiler warnings.
699 \b Add "const" in a number of places.
701 \b Add -X option to specify error reporting format (use -Xvc to
702   integrate with Microsoft Visual Studio.)
704 \b Minor changes for code legibility.
706 \b Drop use of tmpnam() in rdoff (security fix.)
709 \S{cl-0.98.34} Version 0.98.34
711 \b Correct additional address-size vs. operand-size confusions.
713 \b Generate dependencies for all Makefiles automatically.
715 \b Add support for unimplemented (but theoretically available)
716   registers such as tr0 and cr5.  Segment registers 6 and 7 are called
717   segr6 and segr7 for the operations which they can be represented.
719 \b Correct some disassembler bugs related to redundant address-size prefixes.
720   Some work still remains in this area.
722 \b Correctly generate an error for things like "SEG eax".
724 \b Add the JMPE instruction, enabled by "CPU IA64".
726 \b Correct compilation on newer gcc/glibc platforms.
728 \b Issue an error on things like "jmp far eax".
731 \S{cl-0.98.33} Version 0.98.33
733 \b New __NASM_PATCHLEVEL__ and __NASM_VERSION_ID__ standard macros to
734   round out the version-query macros.  version.pl now understands
735   X.YYplWW or X.YY.ZZplWW as a version number, equivalent to
736   X.YY.ZZ.WW (or X.YY.0.WW, as appropriate).
738 \b New keyword "strict" to disable the optimization of specific
739   operands.
741 \b Fix the handing of size overrides with JMP instructions
742   (instructions such as "jmp dword foo".)
744 \b Fix the handling of "ABSOLUTE label", where "label" points into a
745   relocatable segment.
747 \b Fix OBJ output format with lots of externs.
749 \b More documentation updates.
751 \b Add -Ov option to get verbose information about optimizations.
753 \b Undo a braindead change which broke \c{%elif} directives.
755 \b Makefile updates.
758 \S{cl-0.98.32} Version 0.98.32
760 \b Fix NASM crashing when \c{%macro} directives were left unterminated.
762 \b Lots of documentation updates.
764 \b Complete rewrite of the PostScript/PDF documentation generator.
766 \b The MS Visual C++ Makefile was updated and corrected.
768 \b Recognize .rodata as a standard section name in ELF.
770 \b Fix some obsolete Perl4-isms in Perl scripts.
772 \b Fix configure.in to work with autoconf 2.5x.
774 \b Fix a couple of "make cleaner" misses.
776 \b Make the normal "./configure && make" work with Cygwin.
779 \S{cl-0.98.31} Version 0.98.31
781 \b Correctly build in a separate object directory again.
783 \b Derive all references to the version number from the version file.
785 \b New standard macros __NASM_SUBMINOR__ and __NASM_VER__ macros.
787 \b Lots of Makefile updates and bug fixes.
789 \b New \c{%ifmacro} directive to test for multiline macros.
791 \b Documentation updates.
793 \b Fixes for 16-bit OBJ format output.
795 \b Changed the NASM environment variable to NASMENV.
798 \S{cl-0.98.30} Version 0.98.30
800 \b Changed doc files a lot: completely removed old READMExx and
801   Wishlist files, incorporating all information in CHANGES and TODO.
803 \b I waited a long time to rename zoutieee.c to (original) outieee.c
805 \b moved all output modules to output/ subdirectory.
807 \b Added 'make strip' target to strip debug info from nasm & ndisasm.
809 \b Added INSTALL file with installation instructions.
811 \b Added -v option description to nasm man.
813 \b Added dist makefile target to produce source distributions.
815 \b 16-bit support for ELF output format (GNU extension, but useful.)
818 \S{cl-0.98.28} Version 0.98.28
820 \b Fastcooked this for Debian's Woody release:
821 Frank applied the INCBIN bug patch to 0.98.25alt and called
822 it 0.98.28 to not confuse poor little apt-get.
825 \S{cl-0.98.26} Version 0.98.26
827 \b Reorganised files even better from 0.98.25alt
830 \S{cl-0.98.25alt} Version 0.98.25alt
832 \b Prettified the source tree. Moved files to more reasonable places.
834 \b Added findleak.pl script to misc/ directory.
836 \b Attempted to fix doc.
839 \S{cl-0.98.25} Version 0.98.25
841 \b Line continuation character \c{\\}.
843 \b Docs inadvertantly reverted - "dos packaging".
846 \S{cl-0.98.24p1} Version 0.98.24p1
848 \b FIXME: Someone, document this please.
851 \S{cl-0.98.24} Version 0.98.24
853 \b Documentation - Ndisasm doc added to Nasm.doc.
856 \S{cl-0.98.23} Version 0.98.23
858 \b Attempted to remove rdoff version1
860 \b Lino Mastrodomenico's patches to preproc.c (%$$ bug?).
863 \S{cl-0.98.22} Version 0.98.22
865 \b Update rdoff2 - attempt to remove v1.
868 \S{cl-0.98.21} Version 0.98.21
870 \b Optimization fixes.
873 \S{cl-0.98.20} Version 0.98.20
875 \b Optimization fixes.
878 \S{cl-0.98.19} Version 0.98.19
880 \b H. J. Lu's patch back out.
883 \S{cl-0.98.18} Version 0.98.18
885 \b Added ".rdata" to "-f win32".
888 \S{cl-0.98.17} Version 0.98.17
890 \b H. J. Lu's "bogus elf" patch. (Red Hat problem?)
893 \S{cl-0.98.16} Version 0.98.16
895 \b Fix whitespace before "[section ..." bug.
898 \S{cl-0.98.15} Version 0.98.15
900 \b Rdoff changes (?).
902 \b Fix fixes to memory leaks.
905 \S{cl-0.98.14} Version 0.98.14
907 \b Fix memory leaks.
910 \S{cl-0.98.13} Version 0.98.13
912 \b There was no 0.98.13
915 \S{cl-0.98.12} Version 0.98.12
917 \b Update optimization (new function of "-O1")
919 \b Changes to test/bintest.asm (?).
922 \S{cl-0.98.11} Version 0.98.11
924 \b Optimization changes.
926 \b Ndisasm fixed.
929 \S{cl-0.98.10} Version 0.98.10
931 \b There was no 0.98.10
934 \S{cl-0.98.09} Version 0.98.09
936 \b Add multiple sections support to "-f bin".
938 \b Changed GLOBAL_TEMP_BASE in outelf.c from 6 to 15.
940 \b Add "-v" as an alias to the "-r" switch.
942 \b Remove "#ifdef" from Tasm compatibility options.
944 \b Remove redundant size-overrides on "mov ds, ex", etc.
946 \b Fixes to SSE2, other insns.dat (?).
948 \b Enable uppercase "I" and "P" switches.
950 \b Case insinsitive "seg" and "wrt".
952 \b Update install.sh (?).
954 \b Allocate tokens in blocks.
956 \b Improve "invalid effective address" messages.
959 \S{cl-0.98.08} Version 0.98.08
961 \b Add "\c{%strlen}" and "\c{%substr}" macro operators
963 \b Fixed broken c16.mac.
965 \b Unterminated string error reported.
967 \b Fixed bugs as per 0.98bf
970 \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
972 Changes from 0.98.07 release to 98.09b as of 28-Oct-2001
974 \b More closely compatible with 0.98 when -O0 is implied
975 or specified.  Not strictly identical, since backward 
976 branches in range of short offsets are recognized, and signed
977 byte values with no explicit size specification will be
978 assembled as a single byte.
980 \b More forgiving with the PUSH instruction.  0.98 requires
981 a size to be specified always.  0.98.09b will imply the size
982 from the current BITS setting (16 or 32).
984 \b Changed definition of the optimization flag:
986         -O0     strict two-pass assembly, JMP and Jcc are
987                 handled more like 0.98, except that back-
988                 ward JMPs are short, if possible.
990         -O1     strict two-pass assembly, but forward
991                 branches are assembled with code guaranteed
992                 to reach; may produce larger code than
993                 -O0, but will produce successful assembly
994                 more often if branch offset sizes are not
995                 specified.
997         -O2     multi-pass optimization, minimize branch
998                 offsets; also will minimize signed immed-
999                 iate bytes, overriding size specification.
1001         -O3     like -O2, but more passes taken, if needed
1004 \S{cl-0.98.07 released 01/28/01} Version 0.98.07 released 01/28/01
1006 \b       Added Stepane Denis' SSE2 instructions to a *working*
1007         version of the code - some earlier versions were based on
1008         broken code - sorry 'bout that. version "0.98.07"
1011 01/28/01
1014 \b       Cosmetic modifications to nasm.c, nasm.h,
1015         AUTHORS, MODIFIED
1018 \S{cl-0.98.06f released 01/18/01} Version 0.98.06f released 01/18/01
1021 \b       - Add "metalbrain"s jecxz bug fix in insns.dat
1022         - alter nasmdoc.src to match - version "0.98.06f"
1025 \S{cl-0.98.06e released 01/09/01} Version 0.98.06e released 01/09/01
1028 \b       Removed the "outforms.h" file - it appears to be
1029         someone's old backup of "outform.h". version "0.98.06e" 
1031 01/09/01
1033 \b fbk - finally added the fix for the "multiple %includes bug",
1034         known since 7/27/99 - reported originally (?) and sent to
1035         us by Austin Lunnen - he reports that John Fine had a fix
1036         within the day. Here it is...
1038 \b Nelson Rush resigns from the group. Big thanks to Nelson for
1039   his leadership and enthusiasm in getting these changes
1040   incorporated into Nasm!
1042 \b fbk - [list +], [list -] directives - ineptly implemented, should
1043         be re-written or removed, perhaps.
1045 \b Brian Raiter / fbk - "elfso bug" fix - applied to aoutb format
1046                        as well - testing might be desirable...
1048 08/07/00
1050 \b James Seter - -postfix, -prefix command line switches.
1052 \b Yuri Zaporogets - rdoff utility changes.
1055 \S{cl-0.98p1} Version 0.98p1
1057 \b GAS-like palign (Panos Minos)
1059 \b FIXME: Someone, fill this in with details
1062 \S{cl-0.98bf (bug-fixed)} Version 0.98bf (bug-fixed)
1064 \b Fixed - elf and aoutb bug - shared libraries
1065         - multiple "%include" bug in "-f obj"   
1066         - jcxz, jecxz bug
1067         - unrecognized option bug in ndisasm 
1069 \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
1071 \b Added signed byte optimizations for the 0x81/0x83 class
1072 of instructions: ADC, ADD, AND, CMP, OR, SBB, SUB, XOR:
1073 when used as 'ADD reg16,imm' or 'ADD reg32,imm.'  Also
1074 optimization of signed byte form of 'PUSH imm' and 'IMUL
1075 reg,imm'/'IMUL reg,reg,imm.'  No size specification is needed.
1077 \b Added multi-pass JMP and Jcc offset optimization.  Offsets
1078 on forward references will preferentially use the short form,
1079 without the need to code a specific size (short or near) for
1080 the branch.  Added instructions for 'Jcc label' to use the
1081 form 'Jnotcc $+3/JMP label', in cases where a short offset
1082 is out of bounds.  If compiling for a 386 or higher CPU, then
1083 the 386 form of Jcc will be used instead.
1085 This feature is controlled by a new command-line switch: "O",
1086 (upper case letter O).  "-O0" reverts the assembler to no
1087 extra optimization passes, "-O1" allows up to 5 extra passes,
1088 and "-O2"(default), allows up to 10 extra optimization passes.
1090 \b Added a new directive:  'cpu XXX', where XXX is any of: 
1091 8086, 186, 286, 386, 486, 586, pentium, 686, PPro, P2, P3 or
1092 Katmai.  All are case insensitive.  All instructions will
1093 be selected only if they apply to the selected cpu or lower.
1094 Corrected a couple of bugs in cpu-dependence in 'insns.dat'.
1096 \b Added to 'standard.mac', the "use16" and "use32" forms of
1097 the "bits 16/32" directive. This is nothing new, just conforms
1098 to a lot of other assemblers. (minor)
1100 \b Changed label allocation from 320/32 (10000 labels @ 200K+) 
1101 to 32/37 (1000 labels); makes running under DOS much easier.
1102 Since additional label space is allocated dynamically, this
1103 should have no effect on large programs with lots of labels.
1104 The 37 is a prime, believed to be better for hashing. (minor)
1107 \S{cl-0.98.03} Version 0.98.03
1109 "Integrated patchfile 0.98-0.98.01.  I call this version 0.98.03 for
1110 historical reasons: 0.98.02 was trashed." --John Coffman
1111 <johninsd@san.rr.com>, 27-Jul-2000
1113 \b Kendall Bennett's SciTech MGL changes
1115 \b Note that you must define "TASM_COMPAT" at compile-time
1116 to get the Tasm Ideal Mode compatibility.
1118 \b All changes can be compiled in and out using the TASM_COMPAT macros,
1119 and when compiled without TASM_COMPAT defined we get the exact same
1120 binary as the unmodified 0.98 sources.
1122 \b standard.mac, macros.c: Added macros to ignore TASM directives before
1123 first include
1125 \b nasm.h: Added extern declaration for tasm_compatible_mode
1127 \b nasm.c: Added global variable tasm_compatible_mode
1129 \b Added command line switch for TASM compatible mode (-t)
1131 \b Changed version command line to reflect when compiled with TASM additions
1133 \b Added response file processing to allow all arguments on a single
1134 line (response file is @resp rather than -@resp for NASM format).
1136 \b labels.c: Changes islocal() macro to support TASM style @@local labels.
1138 \b Added islocalchar() macro to support TASM style @@local labels.
1140 \b parser.c: Added support for TASM style memory references (ie: mov
1141 [DWORD eax],10 rather than the NASM style mov DWORD [eax],10).
1143 \b preproc.c: Added new directives, \c{%arg}, \c{%local}, \c{%stacksize} to directives
1144 table
1146 \b Added support for TASM style directives without a leading % symbol.
1148 \b Integrated a block of changes from Andrew Zabolotny <bit@eltech.ru>:
1150 \b A new keyword \c{%xdefine} and its case-insensitive counterpart \c{%ixdefine}.
1151 They work almost the same way as \c{%define} and \c{%idefine} but expand
1152 the definition immediately, not on the invocation. Something like a cross
1153 between \c{%define} and \c{%assign}. The "x" suffix stands for "eXpand", so
1154 "xdefine" can be deciphered as "expand-and-define". Thus you can do
1155 things like this:
1157 \c      %assign ofs     0
1159 \c      %macro  arg     1
1160 \c              %xdefine %1 dword [esp+ofs]
1161 \c              %assign ofs ofs+4
1162 \c      %endmacro
1164 \b Changed the place where the expansion of %$name macros are expanded.
1165 Now they are converted into ..@ctxnum.name form when detokenizing, so
1166 there are no quirks as before when using %$name arguments to macros,
1167 in macros etc. For example:
1169 \c      %macro  abc     1
1170 \c              %define %1 hello
1171 \c      %endm
1173 \c      abc     %$here
1174 \c      %$here
1176     Now last line will be expanded into "hello" as expected. This also allows
1177     for lots of goodies, a good example are extended "proc" macros included
1178     in this archive.
1180 \b Added a check for "cstk" in smacro_defined() before calling get_ctx() -
1181     this allows for things like:
1183 \c      %ifdef %$abc
1184 \c      %endif
1186     to work without warnings even in no context.
1188 \b Added a check for "cstk" in %if*ctx and %elif*ctx directives -
1189     this allows to use \c{%ifctx} without excessive warnings. If there is
1190     no active context, \c{%ifctx} goes through "false" branch.
1192 \b Removed "user error: " prefix with \c{%error} directive: it just clobbers the
1193     output and has absolutely no functionality. Besides, this allows to write
1194     macros that does not differ from built-in functions in any way.
1196 \b Added expansion of string that is output by \c{%error} directive. Now you
1197     can do things like:
1199 \c      %define hello(x) Hello, x!
1201 \c      %define %$name andy
1202 \c      %error "hello(%$name)"
1204     Same happened with \c{%include} directive.
1206 \b Now all directives that expect an identifier will try to expand and
1207     concatenate everything without whitespaces in between before usage.
1208     For example, with "unfixed" nasm the commands
1210 \c      %define %$abc hello
1211 \c      %define __%$abc goodbye
1212 \c      __%$abc
1214     would produce "incorrect" output: last line will expand to
1216 \c      hello goodbyehello
1218     Not quite what you expected, eh? :-) The answer is that preprocessor
1219     treats the \c{%define} construct as if it would be
1221 \c      %define __ %$abc goodbye
1223     (note the white space between __ and %$abc). After my "fix" it
1224     will "correctly" expand into
1226 \c      goodbye
1228     as expected. Note that I use quotes around words "correct", "incorrect"
1229     etc because this is rather a feature not a bug; however current behaviour
1230     is more logical (and allows more advanced macro usage :-).
1232     Same change was applied to:
1233         \c{%push},\c{%macro},\c{%imacro},\c{%define},\c{%idefine},\c{%xdefine},\c{%ixdefine},
1234         \c{%assign},\c{%iassign},\c{%undef}
1236 \b A new directive [WARNING {+|-}warning-id] have been added. It works only
1237     if the assembly phase is enabled (i.e. it doesn't work with nasm -e).
1239 \b A new warning type: macro-selfref. By default this warning is disabled;
1240     when enabled NASM warns when a macro self-references itself; for example
1241     the following source:
1243 \c        [WARNING macro-selfref]
1245 \c        %macro          push    1-*
1246 \c                %rep    %0
1247 \c                        push    %1
1248 \c                        %rotate 1
1249 \c                %endrep
1250 \c        %endmacro
1252 \c                        push    eax,ebx,ecx
1254     will produce a warning, but if we remove the first line we won't see it
1255     anymore (which is The Right Thing To Do {tm} IMHO since C preprocessor
1256     eats such constructs without warnings at all).
1258 \b Added a "error" routine to preprocessor which always will set ERR_PASS1
1259     bit in severity_code. This removes annoying repeated errors on first
1260     and second passes from preprocessor.
1262 \b Added the %+ operator in single-line macros for concatenating two
1263     identifiers. Usage example:
1265 \c        %define _myfunc _otherfunc
1266 \c        %define cextern(x) _ %+ x
1267 \c        cextern (myfunc)
1269     After first expansion, third line will become "_myfunc". After this
1270     expansion is performed again so it becomes "_otherunc".
1272 \b Now if preprocessor is in a non-emitting state, no warning or error
1273     will be emitted. Example:
1275 \c        %if 1
1276 \c                mov     eax,ebx
1277 \c        %else
1278 \c                put anything you want between these two brackets,
1279 \c                even macro-parameter references %1 or local
1280 \c                labels %$zz or macro-local labels %%zz - no
1281 \c                warning will be emitted.
1282 \c        %endif
1284 \b Context-local variables on expansion as a last resort are looked up
1285     in outer contexts. For example, the following piece:
1287 \c        %push   outer
1288 \c        %define %$a [esp]
1290 \c                %push   inner
1291 \c                %$a
1292 \c                %pop
1293 \c        %pop
1295     will expand correctly the fourth line to [esp]; if we'll define another
1296     %$a inside the "inner" context, it will take precedence over outer
1297     definition. However, this modification has been applied only to
1298     expand_smacro and not to smacro_define: as a consequence expansion
1299     looks in outer contexts, but \c{%ifdef} won't look in outer contexts.
1301     This behaviour is needed because we don't want nested contexts to
1302     act on already defined local macros. Example:
1304 \c        %define %$arg1  [esp+4]
1305 \c        test    eax,eax
1306 \c        if      nz
1307 \c                mov     eax,%$arg1
1308 \c        endif
1310     In this example the "if" mmacro enters into the "if" context, so %$arg1
1311     is not valid anymore inside "if". Of course it could be worked around
1312     by using explicitely %$$arg1 but this is ugly IMHO.
1314 \b Fixed memory leak in \c{%undef}. The origline wasn't freed before
1315     exiting on success.
1317 \b Fixed trap in preprocessor when line expanded to empty set of tokens.
1318     This happens, for example, in the following case:
1320 \c        #define SOMETHING
1321 \c        SOMETHING
1324 \S{cl-0.98} Version 0.98
1326 All changes since NASM 0.98p3 have been produced by H. Peter Anvin <hpa@zytor.com>.
1328 \b The documentation comment delimiter is \# not #.
1330 \b Allow EQU definitions to refer to external labels; reported by
1331   Pedro Gimeno.
1333 \b Re-enable support for RDOFF v1; reported by Pedro Gimeno.
1335 \b Updated License file per OK from Simon and Julian.
1338 \S{cl-0.98p9} Version 0.98p9
1340 \b Update documentation (although the instruction set reference will
1341   have to wait; I don't want to hold up the 0.98 release for it.)
1343 \b Verified that the NASM implementation of the PEXTRW and PMOVMSKB
1344   instructions is correct.  The encoding differs from what the Intel
1345   manuals document, but the Pentium III behaviour matches NASM, not
1346   the Intel manuals.
1348 \b Fix handling of implicit sizes in PSHUFW and PINSRW, reported by
1349   Stefan Hoffmeister.
1351 \b Resurrect the -s option, which was removed when changing the
1352   diagnostic output to stdout.
1355 \S{cl-0.98p8} Version 0.98p8
1357 \b Fix for "DB" when NASM is running on a bigendian machine.
1359 \b Invoke insns.pl once for each output script, making Makefile.in
1360   legal for "make -j".
1362 \b Improve the Unix configure-based makefiles to make package
1363   creation easier.
1365 \b Included an RPM .spec file for building RPM (RedHat Package Manager)
1366   packages on Linux or Unix systems.
1368 \b Fix Makefile dependency problems.
1370 \b Change src/rdsrc.pl to include sectioning information in info
1371   output; required for install-info to work.
1373 \b Updated the RDOFF distribution to version 2 from Jules; minor
1374   massaging to make it compile in my environment.
1376 \b Split doc files that can be built by anyone with a Perl interpreter off
1377   into a separate archive.
1379 \b "Dress rehearsal" release!
1382 \S{cl-0.98p7} Version 0.98p7
1384 \b Fixed opcodes with a third byte-sized immediate argument to not
1385   complain if given "byte" on the immediate.
1387 \b Allow \c{%undef} to remove single-line macros with arguments.  This
1388   matches the behaviour of #undef in the C preprocessor.
1390 \b Allow -d, -u, -i and -p to be specified as -D, -U, -I and -P for
1391   compatibility with most C compilers and preprocessors.  This allows
1392   Makefile options to be shared between cc and nasm, for example.
1394 \b Minor cleanups.
1396 \b Went through the list of Katmai instructions and hopefully fixed the
1397   (rather few) mistakes in it.
1399 \b (Hopefully) fixed a number of disassembler bugs related to ambiguous
1400   instructions (disambiguated by -p) and SSE instructions with REP.
1402 \b Fix for bug reported by Mark Junger: "call dword 0x12345678" should
1403   work and may add an OSP (affected CALL, JMP, Jcc).
1405 \b Fix for environments when "stderr" isn't a compile-time constant.
1408 \S{cl-0.98p6} Version 0.98p6
1411 \b Took officially over coordination of the 0.98 release; so drop
1412   the p3.x notation. Skipped p4 and p5 to avoid confusion with John
1413   Fine's J4 and J5 releases.
1415 \b Update the documentation; however, it still doesn't include
1416   documentation for the various new instructions.  I somehow wonder if
1417   it makes sense to have an instruction set reference in the assembler
1418   manual when Intel et al have PDF versions of their manuals online.
1420 \b Recognize "idt" or "centaur" for the -p option to ndisasm.
1422 \b Changed error messages back to stderr where they belong, but add an
1423   -E option to redirect them elsewhere (the DOS shell cannot redirect
1424   stderr.)
1426 \b -M option to generate Makefile dependencies (based on code from Alex
1427   Verstak.)
1429 \b \c{%undef} preprocessor directive, and -u option, that undefines a
1430   single-line macro.
1432 \b OS/2 Makefile (Mkfiles/Makefile.os2) for Borland under OS/2; from
1433   Chuck Crayne.
1435 \b Various minor bugfixes (reported by):
1436   - Dangling \c{%s} in preproc.c (Martin Junker)
1438 \b THERE ARE KNOWN BUGS IN SSE AND THE OTHER KATMAI INSTRUCTIONS.  I am
1439   on a trip and didn't bring the Katmai instruction reference, so I
1440   can't work on them right now.
1442 \b Updated the License file per agreement with Simon and Jules to
1443   include a GPL distribution clause.
1446 \S{cl-0.98p3.7} Version 0.98p3.7
1448 \b (Hopefully) fixed the canned Makefiles to include the outrdf2 and
1449   zoutieee modules.
1451 \b Renamed changes.asm to changed.asm.
1454 \S{cl-0.98p3.6} Version 0.98p3.6
1456 \b Fixed a bunch of instructions that were added in 0.98p3.5 which had
1457   memory operands, and the address-size prefix was missing from the
1458   instruction pattern.
1461 \S{cl-0.98p3.5} Version 0.98p3.5
1463 \b Merged in changes from John S. Fine's 0.98-J5 release.  John's based
1464   0.98-J5 on my 0.98p3.3 release; this merges the changes.
1466 \b Expanded the instructions flag field to a long so we can fit more
1467   flags; mark SSE (KNI) and AMD or Katmai-specific instructions as
1468   such.
1470 \b Fix the "PRIV" flag on a bunch of instructions, and create new
1471   "PROT" flag for protected-mode-only instructions (orthogonal to if
1472   the instruction is privileged!) and new "SMM" flag for SMM-only
1473   instructions.
1475 \b Added AMD-only SYSCALL and SYSRET instructions.
1477 \b Make SSE actually work, and add new Katmai MMX instructions.
1479 \b Added a -p (preferred vendor) option to ndisasm so that it can
1480   distinguish e.g. Cyrix opcodes also used in SSE.  For example:
1482 \c      ndisasm -p cyrix aliased.bin
1483 \c      00000000  670F514310        paddsiw mm0,[ebx+0x10]
1484 \c      00000005  670F514320        paddsiw mm0,[ebx+0x20]
1485 \c      ndisasm -p intel aliased.bin
1486 \c      00000000  670F514310        sqrtps xmm0,[ebx+0x10]
1487 \c      00000005  670F514320        sqrtps xmm0,[ebx+0x20]
1489 \b Added a bunch of Cyrix-specific instructions.
1492 \S{cl-0.98p3.4} Version 0.98p3.4
1494 \b Made at least an attempt to modify all the additional Makefiles (in
1495   the Mkfiles directory).  I can't test it, but this was the best I
1496   could do.
1498 \b DOS DJGPP+"Opus Make" Makefile from John S. Fine.
1500 \b changes.asm changes from John S. Fine.
1503 \S{cl-0.98p3.3} Version 0.98p3.3
1505 \b Patch from Conan Brink to allow nesting of \c{%rep} directives.
1507 \b If we're going to allow INT01 as an alias for INT1/ICEBP (one of
1508   Jules 0.98p3 changes), then we should allow INT03 as an alias for INT3
1509   as well.
1511 \b Updated changes.asm to include the latest changes.
1513 \b Tried to clean up the <CR>s that had snuck in from a DOS/Windows
1514   environment into my Unix environment, and try to make sure than
1515   DOS/Windows users get them back.
1517 \b We would silently generate broken tools if insns.dat wasn't sorted
1518   properly.  Change insns.pl so that the order doesn't matter.
1520 \b Fix bug in insns.pl (introduced by me) which would cause conditional
1521   instructions to have an extra "cc" in disassembly, e.g. "jnz"
1522   disassembled as "jccnz".
1525 \S{cl-0.98p3.2} Version 0.98p3.2
1527 \b Merged in John S. Fine's changes from his 0.98-J4 prerelease; see
1528   http://www.csoft.net/cz/johnfine/
1530 \b Changed previous "spotless" Makefile target (appropriate for distribution)
1531   to "distclean", and added "cleaner" target which is same as "clean"
1532   except deletes files generated by Perl scripts; "spotless" is union.
1534 \b Removed BASIC programs from distribution.  Get a Perl interpreter
1535   instead (see below.)
1537 \b Calling this "pre-release 3.2" rather than "p3-hpa2" because of
1538   John's contributions.
1540 \b Actually link in the IEEE output format (zoutieee.c); fix a bunch of
1541   compiler warnings in that file.  Note I don't know what IEEE output
1542   is supposed to look like, so these changes were made "blind".
1545 \S{cl-0.98p3-hpa} Version 0.98p3-hpa
1547 \b Merged nasm098p3.zip with nasm-0.97.tar.gz to create a fully
1548   buildable version for Unix systems (Makefile.in updates, etc.)
1550 \b Changed insns.pl to create the instruction tables in nasm.h and
1551   names.c, so that a new instruction can be added by adding it *only*
1552   to insns.dat.
1554 \b Added the following new instructions: SYSENTER, SYSEXIT, FXSAVE,
1555   FXRSTOR, UD1, UD2 (the latter two are two opcodes that Intel
1556   guarantee will never be used; one of them is documented as UD2 in
1557   Intel documentation, the other one just as "Undefined Opcode" --
1558   calling it UD1 seemed to make sense.)
1560 \b MAX_SYMBOL was defined to be 9, but LOADALL286 and LOADALL386 are 10
1561   characters long.  Now MAX_SYMBOL is derived from insns.dat.
1563 \b A note on the BASIC programs included: forget them.  insns.bas is
1564   already out of date.  Get yourself a Perl interpreter for your
1565   platform of choice at
1566   \W{http://www.cpan.org/ports/index.html}{http://www.cpan.org/ports/index.html}.
1569 \S{cl-0.98p3} Version 0.98 pre-release 3
1571 \b added response file support, improved command line handling, new layout
1572 help screen
1574 \b fixed limit checking bug, 'OUT byte nn, reg' bug, and a couple of rdoff
1575 related bugs, updated Wishlist; 0.98 Prerelease 3.
1578 \S{cl-0.98p2} Version 0.98 pre-release 2
1580 \b fixed bug in outcoff.c to do with truncating section names longer
1581 than 8 characters, referencing beyond end of string; 0.98 pre-release 2
1584 \S{cl-0.98p1} Version 0.98 pre-release 1
1586 \b Fixed a bug whereby STRUC didn't work at all in RDF.
1588 \b Fixed a problem with group specification in PUBDEFs in OBJ.
1590 \b Improved ease of adding new output formats. Contribution due to
1591 Fox Cutter.
1593 \b Fixed a bug in relocations in the `bin' format: was showing up when
1594 a relocatable reference crossed an 8192-byte boundary in any output
1595 section.
1597 \b Fixed a bug in local labels: local-label lookups were inconsistent
1598 between passes one and two if an EQU occurred between the definition
1599 of a global label and the subsequent use of a local label local to
1600 that global.
1602 \b Fixed a seg-fault in the preprocessor (again) which happened when
1603 you use a blank line as the first line of a multi-line macro
1604 definition and then defined a label on the same line as a call to
1605 that macro.
1607 \b Fixed a stale-pointer bug in the handling of the NASM environment
1608 variable. Thanks to Thomas McWilliams.
1610 \b ELF had a hard limit on the number of sections which caused
1611 segfaults when transgressed. Fixed.
1613 \b Added ability for ndisasm to read from stdin by using `-' as the
1614 filename.
1616 \b ndisasm wasn't outputting the TO keyword. Fixed.
1618 \b Fixed error cascade on bogus expression in \c{%if} - an error in
1619 evaluation was causing the entire \c{%if} to be discarded, thus creating
1620 trouble later when the \c{%else} or \c{%endif} was encountered.
1622 \b Forward reference tracking was instruction-granular not operand-
1623 granular, which was causing 286-specific code to be generated
1624 needlessly on code of the form `shr word [forwardref],1'. Thanks to
1625 Jim Hague for sending a patch.
1627 \b All messages now appear on stdout, as sending them to stderr serves
1628 no useful purpose other than to make redirection difficult.
1630 \b Fixed the problem with EQUs pointing to an external symbol - this
1631 now generates an error message.
1633 \b Allowed multiple size prefixes to an operand, of which only the first
1634 is taken into account.
1636 \b Incorporated John Fine's changes, including fixes of a large number
1637 of preprocessor bugs, some small problems in OBJ, and a reworking of
1638 label handling to define labels before their line is assembled, rather
1639 than after.
1641 \b Reformatted a lot of the source code to be more readable. Included
1642 'coding.txt' as a guideline for how to format code for contributors.
1644 \b Stopped nested \c{%reps} causing a panic - they now cause a slightly more
1645 friendly error message instead.
1647 \b Fixed floating point constant problems (patch by Pedro Gimeno)
1649 \b Fixed the return value of insn_size() not being checked for -1, indicating
1650 an error.
1652 \b Incorporated 3Dnow! instructions.
1654 \b Fixed the 'mov eax, eax + ebx' bug.
1656 \b Fixed the GLOBAL EQU bug in ELF. Released developers release 3.
1658 \b Incorporated John Fine's command line parsing changes
1660 \b Incorporated David Lindauer's OMF debug support
1662 \b Made changes for LCC 4.0 support (\c{__NASM_CDecl__}, removed register size
1663 specification warning when sizes agree).
1666 \H{cl-0.9x} NASM 0.9 Series
1668 Revisions before 0.98.
1671 \S{cl-0.97} Version 0.97 released December 1997
1673 \b This was entirely a bug-fix release to 0.96, which seems to have got
1674 cursed. Silly me.
1676 \b Fixed stupid mistake in OBJ which caused `MOV EAX,<constant>' to
1677 fail. Caused by an error in the `MOV EAX,<segment>' support.
1679 \b ndisasm hung at EOF when compiled with lcc on Linux because lcc on
1680 Linux somehow breaks feof(). ndisasm now does not rely on feof().
1682 \b A heading in the documentation was missing due to a markup error in
1683 the indexing. Fixed.
1685 \b Fixed failure to update all pointers on realloc() within extended-
1686 operand code in parser.c. Was causing wrong behaviour and seg faults
1687 on lines such as `dd 0.0,0.0,0.0,0.0,...'
1689 \b Fixed a subtle preprocessor bug whereby invoking one multi-line
1690 macro on the first line of the expansion of another, when the second
1691 had been invoked with a label defined before it, didn't expand the
1692 inner macro. 
1694 \b Added internal.doc back in to the distribution archives - it was
1695 missing in 0.96 *blush*
1697 \b Fixed bug causing 0.96 to be unable to assemble its own test files,
1698 specifically objtest.asm. *blush again*
1700 \b Fixed seg-faults and bogus error messages caused by mismatching
1701 \c{%rep} and \c{%endrep} within multi-line macro definitions.
1703 \b Fixed a problem with buffer overrun in OBJ, which was causing
1704 corruption at ends of long PUBDEF records.
1706 \b Separated DOS archives into main-program and documentation to reduce
1707 download size.
1710 \S{cl-0.96} Version 0.96 released November 1997
1712 \b Fixed a bug whereby, if `nasm sourcefile' would cause a filename
1713 collision warning and put output into `nasm.out', then `nasm
1714 sourcefile -o outputfile' still gave the warning even though the
1715 `-o' was honoured.
1716 Fixed name pollution under Digital UNIX: one of its header files
1717 defined R_SP, which broke the enum in nasm.h.
1719 \b Fixed minor instruction table problems: FUCOM and FUCOMP didn't have
1720 two-operand forms; NDISASM didn't recognise the longer register
1721 forms of PUSH and POP (eg FF F3 for PUSH BX); TEST mem,imm32 was
1722 flagged as undocumented; the 32-bit forms of CMOV had 16-bit operand
1723 size prefixes; `AAD imm' and `AAM imm' are no longer flagged as
1724 undocumented because the Intel Architecture reference documents
1725 them.
1727 \b Fixed a problem with the local-label mechanism, whereby strange
1728 types of symbol (EQUs, auto-defined OBJ segment base symbols)
1729 interfered with the `previous global label' value and screwed up
1730 local labels.
1732 \b Fixed a bug whereby the stub preprocessor didn't communicate with
1733 the listing file generator, so that the -a and -l options in
1734 conjunction would produce a useless listing file.
1736 \b Merged `os2' object file format back into `obj', after discovering
1737 that `obj' _also_ shouldn't have a link pass separator in a module
1738 containing a non-trivial MODEND. Flat segments are now declared
1739 using the FLAT attribute. `os2' is no longer a valid object format
1740 name: use `obj'.
1742 \b Removed the fixed-size temporary storage in the evaluator. Very very
1743 long expressions (like `mov ax,1+1+1+1+...' for two hundred 1s or
1744 so) should now no longer crash NASM.
1746 \b Fixed a bug involving segfaults on disassembly of MMX instructions,
1747 by changing the meaning of one of the operand-type flags in nasm.h.
1748 This may cause other apparently unrelated MMX problems; it needs to
1749 be tested thoroughly.
1751 \b Fixed some buffer overrun problems with large OBJ output files.
1752 Thanks to DJ Delorie for the bug report and fix.
1754 \b Made preprocess-only mode actually listen to the \c{%line} markers as it
1755 prints them, so that it can report errors more sanely.
1757 \b Re-designed the evaluator to keep more sensible track of expressions
1758 involving forward references: can now cope with previously-nightmare
1759 situations such as:
1761 \c   mov ax,foo | bar
1762 \c   foo equ 1
1763 \c   bar equ 2
1765 \b Added the ALIGN and ALIGNB standard macros.
1767 \b Added PIC support in ELF: use of WRT to obtain the four extra
1768 relocation types needed.
1770 \b Added the ability for output file formats to define their own
1771 extensions to the GLOBAL, COMMON and EXTERN directives.
1773 \b Implemented common-variable alignment, and global-symbol type and
1774 size declarations, in ELF.
1776 \b Implemented NEAR and FAR keywords for common variables, plus
1777 far-common element size specification, in OBJ.
1779 \b Added a feature whereby EXTERNs and COMMONs in OBJ can be given a
1780 default WRT specification (either a segment or a group).
1782 \b Transformed the Unix NASM archive into an auto-configuring package.
1784 \b Added a sanity-check for people applying SEG to things which are
1785 already segment bases: this previously went unnoticed by the SEG
1786 processing and caused OBJ-driver panics later.
1788 \b Added the ability, in OBJ format, to deal with `MOV EAX,<segment>'
1789 type references: OBJ doesn't directly support dword-size segment
1790 base fixups, but as long as the low two bytes of the constant term
1791 are zero, a word-size fixup can be generated instead and it will
1792 work.
1794 \b Added the ability to specify sections' alignment requirements in
1795 Win32 object files and pure binary files.
1797 \b Added preprocess-time expression evaluation: the \c{%assign} (and
1798 \c{%iassign}) directive and the bare \c{%if} (and \c{%elif}) conditional. Added
1799 relational operators to the evaluator, for use only in \c{%if}
1800 constructs: the standard relationals = < > <= >= <> (and C-like
1801 synonyms == and !=) plus low-precedence logical operators &&, ^^ and
1804 \b Added a preprocessor repeat construct: \c{%rep} / \c{%exitrep} / \c{%endrep}.
1806 \b Added the __FILE__ and __LINE__ standard macros.
1808 \b Added a sanity check for number constants being greater than
1809 0xFFFFFFFF. The warning can be disabled.
1811 \b Added the %0 token whereby a variadic multi-line macro can tell how
1812 many parameters it's been given in a specific invocation.
1814 \b Added \c{%rotate}, allowing multi-line macro parameters to be cycled.
1816 \b Added the `*' option for the maximum parameter count on multi-line
1817 macros, allowing them to take arbitrarily many parameters.
1819 \b Added the ability for the user-level forms of EXTERN, GLOBAL and
1820 COMMON to take more than one argument.
1822 \b Added the IMPORT and EXPORT directives in OBJ format, to deal with
1823 Windows DLLs.
1825 \b Added some more preprocessor \c{%if} constructs: \c{%ifidn} / \c{%ifidni} (exact
1826 textual identity), and \c{%ifid} / \c{%ifnum} / \c{%ifstr} (token type testing).
1828 \b Added the ability to distinguish SHL AX,1 (the 8086 version) from
1829 SHL AX,BYTE 1 (the 286-and-upwards version whose constant happens to
1830 be 1).
1832 \b Added NetBSD/FreeBSD/OpenBSD's variant of a.out format, complete
1833 with PIC shared library features.
1835 \b Changed NASM's idiosyncratic handling of FCLEX, FDISI, FENI, FINIT,
1836 FSAVE, FSTCW, FSTENV, and FSTSW to bring it into line with the
1837 otherwise accepted standard. The previous behaviour, though it was a
1838 deliberate feature, was a deliberate feature based on a
1839 misunderstanding. Apologies for the inconvenience.
1841 \b Improved the flexibility of ABSOLUTE: you can now give it an
1842 expression rather than being restricted to a constant, and it can
1843 take relocatable arguments as well.
1845 \b Added the ability for a variable to be declared as EXTERN multiple
1846 times, and the subsequent definitions are just ignored.
1848 \b We now allow instruction prefixes (CS, DS, LOCK, REPZ etc) to be
1849 alone on a line (without a following instruction).
1851 \b Improved sanity checks on whether the arguments to EXTERN, GLOBAL
1852 and COMMON are valid identifiers.
1854 \b Added misc/exebin.mac to allow direct generation of .EXE files by
1855 hacking up an EXE header using DB and DW; also added test/binexe.asm
1856 to demonstrate the use of this. Thanks to Yann Guidon for
1857 contributing the EXE header code.
1859 \b ndisasm forgot to check whether the input file had been successfully
1860 opened. Now it does. Doh!
1862 \b Added the Cyrix extensions to the MMX instruction set.
1864 \b Added a hinting mechanism to allow [EAX+EBX] and [EBX+EAX] to be
1865 assembled differently. This is important since [ESI+EBP] and
1866 [EBP+ESI] have different default base segment registers.
1868 \b Added support for the PharLap OMF extension for 4096-byte segment
1869 alignment.
1872 \S{cl-0.95 released July 1997} Version 0.95 released July 1997
1874 \b Fixed yet another ELF bug. This one manifested if the user relied on
1875 the default segment, and attempted to define global symbols without
1876 first explicitly declaring the target segment.
1878 \b Added makefiles (for NASM and the RDF tools) to build Win32 console
1879 apps under Symantec C++. Donated by Mark Junker.
1881 \b Added `macros.bas' and `insns.bas', QBasic versions of the Perl
1882 scripts that convert `standard.mac' to `macros.c' and convert
1883 `insns.dat' to `insnsa.c' and `insnsd.c'. Also thanks to Mark
1884 Junker.
1886 \b Changed the diassembled forms of the conditional instructions so
1887 that JB is now emitted as JC, and other similar changes. Suggested
1888 list by Ulrich Doewich.
1890 \b Added `@' to the list of valid characters to begin an identifier
1891 with.
1893 \b Documentary changes, notably the addition of the `Common Problems'
1894 section in nasm.doc.
1896 \b Fixed a bug relating to 32-bit PC-relative fixups in OBJ.
1898 \b Fixed a bug in perm_copy() in labels.c which was causing exceptions
1899 in cleanup_labels() on some systems.
1901 \b Positivity sanity check in TIMES argument changed from a warning to
1902 an error following a further complaint.
1904 \b Changed the acceptable limits on byte and word operands to allow
1905 things like `~10111001b' to work.
1907 \b Fixed a major problem in the preprocessor which caused seg-faults if
1908 macro definitions contained blank lines or comment-only lines.
1910 \b Fixed inadequate error checking on the commas separating the
1911 arguments to `db', `dw' etc.
1913 \b Fixed a crippling bug in the handling of macros with operand counts
1914 defined with a `+' modifier.
1916 \b Fixed a bug whereby object file formats which stored the input file
1917 name in the output file (such as OBJ and COFF) weren't doing so
1918 correctly when the output file name was specified on the command
1919 line.
1921 \b Removed [INC] and [INCLUDE] support for good, since they were
1922 obsolete anyway.
1924 \b Fixed a bug in OBJ which caused all fixups to be output in 16-bit
1925 (old-format) FIXUPP records, rather than putting the 32-bit ones in
1926 FIXUPP32 (new-format) records.
1928 \b Added, tentatively, OS/2 object file support (as a minor variant on
1929 OBJ).
1931 \b Updates to Fox Cutter's Borland C makefile, Makefile.bc2.
1933 \b Removed a spurious second fclose() on the output file.
1935 \b Added the `-s' command line option to redirect all messages which
1936 would go to stderr (errors, help text) to stdout instead.
1938 \b Added the `-w' command line option to selectively suppress some
1939 classes of assembly warning messages.
1941 \b Added the `-p' pre-include and `-d' pre-define command-line options.
1943 \b Added an include file search path: the `-i' command line option.
1945 \b Fixed a silly little preprocessor bug whereby starting a line with a
1946 `%!' environment-variable reference caused an `unknown directive'
1947 error.
1949 \b Added the long-awaited listing file support: the `-l' command line
1950 option.
1952 \b Fixed a problem with OBJ format whereby, in the absence of any
1953 explicit segment definition, non-global symbols declared in the
1954 implicit default segment generated spurious EXTDEF records in the
1955 output.
1957 \b Added the NASM environment variable.
1959 \b From this version forward, Win32 console-mode binaries will be
1960 included in the DOS distribution in addition to the 16-bit binaries.
1961 Added Makefile.vc for this purpose.
1963 \b Added `return 0;' to test/objlink.c to prevent compiler warnings.
1965 \b Added the __NASM_MAJOR__ and __NASM_MINOR__ standard defines.
1967 \b Added an alternative memory-reference syntax in which prefixing an
1968 operand with `&' is equivalent to enclosing it in square brackets,
1969 at the request of Fox Cutter.
1971 \b Errors in pass two now cause the program to return a non-zero error
1972 code, which they didn't before.
1974 \b Fixed the single-line macro cycle detection, which didn't work at
1975 all on macros with no parameters (caused an infinite loop). Also
1976 changed the behaviour of single-line macro cycle detection to work
1977 like cpp, so that macros like `extrn' as given in the documentation
1978 can be implemented.
1980 \b Fixed the implementation of WRT, which was too restrictive in that
1981 you couldn't do `mov ax,[di+abc wrt dgroup]' because (di+abc) wasn't
1982 a relocatable reference.
1985 \S{cl-0.94 released April 1997} Version 0.94 released April 1997
1988 \b Major item: added the macro processor.
1990 \b Added undocumented instructions SMI, IBTS, XBTS and LOADALL286. Also
1991 reorganised CMPXCHG instruction into early-486 and Pentium forms.
1992 Thanks to Thobias Jones for the information.
1994 \b Fixed two more stupid bugs in ELF, which were causing `ld' to
1995 continue to seg-fault in a lot of non-trivial cases.
1997 \b Fixed a seg-fault in the label manager.
1999 \b Stopped FBLD and FBSTP from _requiring_ the TWORD keyword, which is
2000 the only option for BCD loads/stores in any case.
2002 \b Ensured FLDCW, FSTCW and FSTSW can cope with the WORD keyword, if
2003 anyone bothers to provide it. Previously they complained unless no
2004 keyword at all was present.
2006 \b Some forms of FDIV/FDIVR and FSUB/FSUBR were still inverted: a
2007 vestige of a bug that I thought had been fixed in 0.92. This was
2008 fixed, hopefully for good this time...
2010 \b Another minor phase error (insofar as a phase error can _ever_ be
2011 minor) fixed, this one occurring in code of the form
2013 \c   rol ax,forward_reference
2014 \c   forward_reference equ 1
2016 \b The number supplied to TIMES is now sanity-checked for positivity,
2017 and also may be greater than 64K (which previously didn't work on
2018 16-bit systems).
2020 \b Added Watcom C makefiles, and misc/pmw.bat, donated by Dominik Behr.
2022 \b Added the INCBIN pseudo-opcode.
2024 \b Due to the advent of the preprocessor, the [INCLUDE] and [INC]
2025 directives have become obsolete. They are still supported in this
2026 version, with a warning, but won't be in the next.
2028 \b Fixed a bug in OBJ format, which caused incorrect object records to
2029 be output when absolute labels were made global.
2031 \b Updates to RDOFF subdirectory, and changes to outrdf.c.
2034 \S{cl-0.93 released January 1997} Version 0.93 released January 1997
2036 This release went out in a great hurry after semi-crippling bugs
2037 were found in 0.92.
2039 \b Really \e{did} fix the stack overflows this time. *blush*
2041 \b Had problems with EA instruction sizes changing between passes, when
2042 an offset contained a forward reference and so 4 bytes were
2043 allocated for the offset in pass one; by pass two the symbol had
2044 been defined and happened to be a small absolute value, so only 1
2045 byte got allocated, causing instruction size mismatch between passes
2046 and hence incorrect address calculations. Fixed.
2048 \b Stupid bug in the revised ELF section generation fixed (associated
2049 string-table section for .symtab was hard-coded as 7, even when this
2050 didn't fit with the real section table). Was causing `ld' to
2051 seg-fault under Linux.
2053 \b Included a new Borland C makefile, Makefile.bc2, donated by Fox
2054 Cutter <lmb@comtch.iea.com>.
2057 \S{cl-0.92 released January 1997} Version 0.92 released January 1997
2059 \b The FDIVP/FDIVRP and FSUBP/FSUBRP pairs had been inverted: this was
2060 fixed. This also affected the LCC driver.
2062 \b Fixed a bug regarding 32-bit effective addresses of the form
2063 \c{[other_register+ESP]}.
2065 \b Documentary changes, notably documentation of the fact that Borland
2066 Win32 compilers use `obj' rather than `win32' object format.
2068 \b Fixed the COMENT record in OBJ files, which was formatted
2069 incorrectly.
2071 \b Fixed a bug causing segfaults in large RDF files.
2073 \b OBJ format now strips initial periods from segment and group
2074 definitions, in order to avoid complications with the local label
2075 syntax.
2077 \b Fixed a bug in disassembling far calls and jumps in NDISASM.
2079 \b Added support for user-defined sections in COFF and ELF files.
2081 \b Compiled the DOS binaries with a sensible amount of stack, to
2082 prevent stack overflows on any arithmetic expression containing
2083 parentheses.
2085 \b Fixed a bug in handling of files that do not terminate in a newline.
2088 \S{cl-0.91 released November 1996} Version 0.91 released November 1996
2090 \b Loads of bug fixes.
2092 \b Support for RDF added.
2094 \b Support for DBG debugging format added.
2096 \b Support for 32-bit extensions to Microsoft OBJ format added.
2098 \b Revised for Borland C: some variable names changed, makefile added.
2100 \b LCC support revised to actually work.
2102 \b JMP/CALL NEAR/FAR notation added.
2104 \b `a16', `o16', `a32' and `o32' prefixes added.
2106 \b Range checking on short jumps implemented.
2108 \b MMX instruction support added.
2110 \b Negative floating point constant support added.
2112 \b Memory handling improved to bypass 64K barrier under DOS.
2114 \b \c{$} prefix to force treatment of reserved words as identifiers added.
2116 \b Default-size mechanism for object formats added.
2118 \b Compile-time configurability added.
2120 \b \c{#}, \c{@}, \c{~} and c\{?} are now valid characters in labels.
2122 \b \c{-e} and \c{-k} options in NDISASM added.
2125 \S{cl-0.90 released October 1996} Version 0.90 released October 1996
2127 First release version. First support for object file output. Other
2128 changes from previous version (0.3x) too numerous to document.