doc: Document AVX2, BMI1, BMI2 and TSX support.
[nasm.git] / doc / changes.src
blobab6fb52aecc63a2e6d649e6f869ecddeac8ca6ad
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 Support for delayed preprocessing \c{%final}
13   See \k{final}.
15 \b Support for comment blocks \c{%comment}.
16   See \k{comment}.
18 \b Support for arbitrarily terminating conditional loops \c{%exitwhile}.
19   See \k{exitwhile}.
21 \b Support for conditional loops \c{%while}.
22   See \k{while}.
24 \b Support for arbitrarily terminating macro expansions \c{%exitmacro}.
25   See \k{exitmacro}.
27 \b Support for recursive macro expansion \c{%rmacro}/\c{%irmacro}.
28   See \k{mlrmacro}.
30 \b When optimization is enabled, \c{mov r64,imm} now optimizes to the
31   shortest form possible between:
33 \c      mov r32,imm32                   ;  5 bytes
34 \c      mov r64,imm32                   ;  7 bytes
35 \c      mov r64,imm64                   ; 10 bytes
37 To force a specific form, use the \c{STRICT} keyword, see \k{strict}.
39 \b Add support for the Intel AVX2 instruction set.
41 \b Add support for Bit Manipulation Instructions 1 and 2.
43 \b Add support for Intel Transactional Synchronization Extensions (TSX).
45 \S{cl-2.09.10} Version 2.09.10
47 \b Fix up NSIS script to protect uninstaller against registry keys
48    absence or corruption. It brings in a few additional questions
49    to a user during deinstallation procedure but still it is better
50    than unpredictable file removal.
53 \S{cl-2.09.09} Version 2.09.09
55 \b Fix initialization of section attributes of \c{bin} output format.
57 \b Fix \c{mach64} output format bug that crashes NASM due to NULL symbols.
60 \S{cl-2.09.08} Version 2.09.08
62 \b Fix \c{__OUTPUT_FORMAT__} assignment when output driver alias
63    is used. For example when \c{-f elf} is used \c{__OUTPUT_FORMAT__}
64    must be set to \c{elf}, if \c{-f elf32} is used \c{__OUTPUT_FORMAT__}
65    must be assigned accordingly, i.e. to \c{elf32}. The rule applies to
66    all output driver aliases. See \k{ofmtm}.
69 \S{cl-2.09.07} Version 2.09.07
71 \b Fix attempts to close same file several times
72    when \c{-a} option is used.
74 \b Fixes for VEXTRACTF128, VMASKMOVPS encoding.
77 \S{cl-2.09.06} Version 2.09.06
79 \b Fix missed section attribute initialization in \c{bin} output target.
82 \S{cl-2.09.05} Version 2.09.05
84 \b Fix arguments encoding for VPEXTRW instruction.
86 \b Remove invalid form of VPEXTRW instruction.
88 \b Add \c{VLDDQU} as alias for \c{VLDQQU} to
89    match specification.
92 \S{cl-2.09.04} Version 2.09.04
94 \b Fix incorrect labels offset for VEX intructions.
96 \b Eliminate bogus warning on implicit operand size override.
98 \b \c{%if} term could not handle 64 bit numbers.
100 \b The COFF backend was limiting relocations number to 16 bits even if
101    in real there were a way more relocations.
104 \S{cl-2.09.03} Version 2.09.03
106 \b Print \c{%macro} name inside \c{%rep} blocks on error.
108 \b Fix preprocessor expansion behaviour. It happened sometime
109    too early and sometime simply wrong. Move behaviour back to
110    the origins (down to NASM 2.05.01).
112 \b Fix unitialized data dereference on OMF output format.
114 \b Issue warning on unterminated \c{%{} construct.
116 \b Fix for documentation typo.
119 \S{cl-2.09.02} Version 2.09.02
121 \b Fix reversed tokens when \c{%deftok} produces more than one output token.
123 \b Fix segmentation fault on disassembling some VEX instructions.
125 \b Missing \c{%endif} did not always cause error.
127 \b Fix typo in documentation.
129 \b Compound context local preprocessor single line macro identifiers
130   were not expanded early enough and as result lead to unresolved
131   symbols.
134 \S{cl-2.09.01} Version 2.09.01
136 \b Fix NULL dereference on missed %deftok second parameter.
138 \b Fix NULL dereference on invalid %substr parameters.
141 \S{cl-2.09} Version 2.09
143 \b Fixed assignment the magnitude of \c{%rep} counter. It is limited
144   to 62 bits now.
146 \b Fixed NULL dereference if argument of \c{%strlen} resolves
147   to whitespace. For example if nonexistent macro parameter is used.
149 \b \c{%ifenv}, \c{%elifenv}, \c{%ifnenv}, and \c{%elifnenv} directives
150   introduced.  See \k{ifenv}.
152 \b Fixed NULL dereference if environment variable is missed.
154 \b Updates of new AVX v7 Intel instructions.
156 \b \c{PUSH imm32} is now officially documented.
158 \b Fix for encoding the LFS, LGS and LSS in 64-bit mode.
160 \b Fixes for compatibility with OpenWatcom compiler and DOS 8.3 file
161   format limitation.
163 \b Macros parameters range expansion introduced. See \k{mlmacrange}.
165 \b Backward compatibility on expanging of local sigle macros restored.
167 \b 8 bit relocations for \c{elf} and \c{bin} output formats are introduced.
169 \b Short intersegment jumps are permitted now.
171 \b An alignment more than 64 bytes are allowed for \c{win32},
172   \c{win64} output formats.
174 \b \c{SECTALIGN} directive introduced. See \k{sectalign}.
176 \b \c{nojmp} option introduced in \c{smartalign} package. See
177   \k{pkg_smartalign}.
179 \b Short aliases \c{win}, \c{elf} and \c{macho} for output formats are
180   introduced.  Each stands for \c{win32}, \c{elf32} and \c{macho32}
181   accordingly.
183 \b Faster handling of missing directives implemented.
185 \b Various small improvements in documentation.
187 \b No hang anymore if unable to open malloc.log file.
189 \b The environments without vsnprintf function are able to build nasm again.
191 \b AMD LWP instructions updated.
193 \b Tighten EA checks. We warn a user if there overflow in EA addressing.
195 \b Make \c{-Ox} the default optimization level.  For the legacy
196   behavior, specify \c{-O0} explicitly.  See \k{opt-O}.
198 \b Environment variables read with \c{%!} or tested with \c{%ifenv}
199   can now contain non-identifier characters if surrounded by quotes.
200   See \k{getenv}.
202 \b Add a new standard macro package \c{%use fp} for floating-point
203   convenience macros.  See \k{pkg_fp}.
206 \S{cl-2.08.02} Version 2.08.02
208 \b Fix crash under certain circumstances when using the \c{%+} operator.
211 \S{cl-2.08.01} Version 2.08.01
213 \b Fix the \c{%use} statement, which was broken in 2.08.
216 \S{cl-2.08} Version 2.08
218 \b A number of enhancements/fixes in macros area.
220 \b Support for converting strings to tokens.  See \k{deftok}.
222 \b Fuzzy operand size logic introduced.
224 \b Fix COFF stack overrun on too long export identifiers.
226 \b Fix Macho-O alignment bug.
228 \b Fix crashes with -fwin32 on file with many exports.
230 \b Fix stack overrun for too long [DEBUG id].
232 \b Fix incorrect sbyte usage in IMUL (hit only if optimization
233   flag passed).
235 \b Append ending token for \c{.stabs} records in the ELF output format.
237 \b New NSIS script which uses ModernUI and MultiUser approach.
239 \b Visual Studio 2008 NASM integration (rules file).
241 \b Warn a user if a constant is too long (and as result will be stripped).
243 \b The obsoleted pre-XOP AMD SSE5 instruction set which was never actualized
244   was removed.
246 \b Fix stack overrun on too long error file name passed from the command line.
248 \b Bind symbols to the .text section by default (ie in case if SECTION
249   directive was omitted) in the ELF output format.
251 \b Fix sync points array index wrapping.
253 \b A few fixes for FMA4 and XOP instruction templates.
255 \b Add AMD Lightweight Profiling (LWP) instructions.
257 \b Fix the offset for \c{%arg} in 64-bit mode.
259 \b An undefined local macro (\c{%$}) no longer matches a global macro
260   with the same name.
262 \b Fix NULL dereference on too long local labels.
265 \S{cl-2.07} Version 2.07
267 \b NASM is now under the 2-clause BSD license.  See \k{legal}.
269 \b Fix the section type for the \c{.strtab} section in the \c{elf64}
270   output format.
272 \b Fix the handling of \c{COMMON} directives in the \c{obj} output format.
274 \b New \c{ith} and \c{srec} output formats; these are variants of the
275   \c{bin} output format which output Intel hex and Motorola S-records,
276   respectively.  See \k{ithfmt} and \k{srecfmt}.
278 \b \c{rdf2ihx} replaced with an enhanced \c{rdf2bin}, which can output
279   binary, COM, Intel hex or Motorola S-records.
281 \b The Windows installer now puts the NASM directory first in the
282   \c{PATH} of the "NASM Shell".
284 \b Revert the early expansion behavior of \c{%+} to pre-2.06 behavior:
285   \c{%+} is only expanded late.
287 \b Yet another Mach-O alignment fix.
289 \b Don't delete the list file on errors.  Also, include error and
290   warning information in the list file.
292 \b Support for 64-bit Mach-O output, see \k{machofmt}.
294 \b Fix assert failure on certain operations that involve strings with
295   high-bit bytes.
298 \S{cl-2.06} Version 2.06
300 \b This release is dedicated to the memory of Charles A. Crayne, long
301   time NASM developer as well as moderator of \c{comp.lang.asm.x86} and
302   author of the book \e{Serious Assembler}.  We miss you, Chuck.
304 \b Support for indirect macro expansion (\c{%[...]}).  See \k{indmacro}.
306 \b \c{%pop} can now take an argument, see \k{pushpop}.
308 \b The argument to \c{%use} is no longer macro-expanded.  Use
309   \c{%[...]} if macro expansion is desired.
311 \b Support for thread-local storage in ELF32 and ELF64.  See \k{elftls}.
313 \b Fix crash on \c{%ifmacro} without an argument.
315 \b Correct the arguments to the \c{POPCNT} instruction.
317 \b Fix section alignment in the Mach-O format.
319 \b Update AVX support to version 5 of the Intel specification.
321 \b Fix the handling of accesses to context-local macros from higher
322   levels in the context stack.
324 \b Treat \c{WAIT} as a prefix rather than as an instruction, thereby
325   allowing constructs like \c{O16 FSAVE} to work correctly.
327 \b Support for structures with a non-zero base offset. See \k{struc}.
329 \b Correctly handle preprocessor token concatenation (see \k{concat})
330    involving floating-point numbers.
332 \b The \c{PINSR} series of instructions have been corrected and
333    rationalized.
335 \b Removed AMD SSE5, replaced with the new XOP/FMA4/CVT16 (rev 3.03)
336    spec.
338 \b The ELF backends no longer automatically generate a \c{.comment} section.
340 \b Add additional "well-known" ELF sections with default attributes.  See
341    \k{elfsect}.
344 \S{cl-2.05.01} Version 2.05.01
346 \b Fix the \c{-w}/\c{-W} option parsing, which was broken in NASM 2.05.
349 \S{cl-2.05} Version 2.05
351 \b Fix redundant REX.W prefix on \c{JMP reg64}.
353 \b Make the behaviour of \c{-O0} match NASM 0.98 legacy behavior.
354   See \k{opt-O}.
356 \b \c{-w-user} can be used to suppress the output of \c{%warning} directives.
357   See \k{opt-w}.
359 \b Fix bug where \c{ALIGN} would issue a full alignment datum instead of
360   zero bytes.
362 \b Fix offsets in list files.
364 \b Fix \c{%include} inside multi-line macros or loops.
366 \b Fix error where NASM would generate a spurious warning on valid
367   optimizations of immediate values.
369 \b Fix arguments to a number of the \c{CVT} SSE instructions.
371 \b Fix RIP-relative offsets when the instruction carries an immediate.
373 \b Massive overhaul of the ELF64 backend for spec compliance.
375 \b Fix the Geode \c{PFRCPV} and \c{PFRSQRTV} instruction.
377 \b Fix the SSE 4.2 \c{CRC32} instruction.
380 \S{cl-2.04} Version 2.04
382 \b Sanitize macro handing in the \c{%error} directive.
384 \b New \c{%warning} directive to issue user-controlled warnings.
386 \b \c{%error} directives are now deferred to the final assembly phase.
388 \b New \c{%fatal} directive to immediately terminate assembly.
390 \b New \c{%strcat} directive to join quoted strings together.
392 \b New \c{%use} macro directive to support standard macro directives.  See
393   \k{use}.
395 \b Excess default parameters to \c{%macro} now issues a warning by default.
396   See \k{mlmacro}.
398 \b Fix \c{%ifn} and \c{%elifn}.
400 \b Fix nested \c{%else} clauses.
402 \b Correct the handling of nested \c{%rep}s.
404 \b New \c{%unmacro} directive to undeclare a multi-line macro.
405   See \k{unmacro}.
407 \b Builtin macro \c{__PASS__} which expands to the current assembly pass.
408   See \k{pass_macro}.
410 \b \c{__utf16__} and \c{__utf32__} operators to generate UTF-16 and UTF-32
411   strings.  See \k{unicode}.
413 \b Fix bug in case-insensitive matching when compiled on platforms that
414   don't use the \c{configure} script.  Of the official release binaries,
415   that only affected the OS/2 binary.
417 \b Support for x87 packed BCD constants.  See \k{bcdconst}.
419 \b Correct the \c{LTR} and \c{SLDT} instructions in 64-bit mode.
421 \b Fix unnecessary REX.W prefix on indirect jumps in 64-bit mode.
423 \b Add AVX versions of the AES instructions (\c{VAES}...).
425 \b Fix the 256-bit FMA instructions.
427 \b Add 256-bit AVX stores per the latest AVX spec.
429 \b VIA XCRYPT instructions can now be written either with or without
430   \c{REP}, apparently different versions of the VIA spec wrote them
431   differently.
433 \b Add missing 64-bit \c{MOVNTI} instruction.
435 \b Fix the operand size of \c{VMREAD} and \c{VMWRITE}.
437 \b Numerous bug fixes, especially to the AES, AVX and VTX instructions.
439 \b The optimizer now always runs until it converges.  It also runs even
440   when disabled, but doesn't optimize.  This allows most forward references
441   to be resolved properly.
443 \b \c{%push} no longer needs a context identifier; omitting the context
444   identifier results in an anonymous context.
447 \S{cl-2.03.01} Version 2.03.01
449 \b Fix buffer overflow in the listing module.
451 \b Fix the handling of hexadecimal escape codes in `...` strings.
453 \b The Postscript/PDF documentation has been reformatted.
455 \b The \c{-F} option now implies \c{-g}.
458 \S{cl-2.03} Version 2.03
460 \b Add support for Intel AVX, CLMUL and FMA instructions,
461 including YMM registers.
463 \b \c{dy}, \c{resy} and \c{yword} for 32-byte operands.
465 \b Fix some SSE5 instructions.
467 \b Intel \c{INVEPT}, \c{INVVPID} and \c{MOVBE} instructions.
469 \b Fix checking for critical expressions when the optimizer is enabled.
471 \b Support the DWARF debugging format for ELF targets.
473 \b Fix optimizations of signed bytes.
475 \b Fix operation on bigendian machines.
477 \b Fix buffer overflow in the preprocessor.
479 \b \c{SAFESEH} support for Win32, \c{IMAGEREL} for Win64 (SEH).
481 \b \c{%?} and \c{%??} to refer to the name of a macro itself.  In particular,
482 \c{%idefine keyword $%?} can be used to make a keyword "disappear".
484 \b New options for dependency generation: \c{-MD}, \c{-MF},
485 \c{-MP}, \c{-MT}, \c{-MQ}.
487 \b New preprocessor directives \c{%pathsearch} and \c{%depend}; INCBIN
488 reimplemented as a macro.
490 \b \c{%include} now resolves macros in a sane manner.
492 \b \c{%substr} can now be used to get other than one-character substrings.
494 \b New type of character/string constants, using backquotes (\c{`...`}),
495 which support C-style escape sequences.
497 \b \c{%defstr} and \c{%idefstr} to stringize macro definitions before
498 creation.
500 \b Fix forward references used in \c{EQU} statements.
503 \S{cl-2.02} Version 2.02
505 \b Additional fixes for MMX operands with explicit \c{qword}, as well as
506   (hopefully) SSE operands with \c{oword}.
508 \b Fix handling of truncated strings with \c{DO}.
510 \b Fix segfaults due to memory overwrites when floating-point constants
511   were used.
513 \b Fix segfaults due to missing include files.
515 \b Fix OpenWatcom Makefiles for DOS and OS/2.
517 \b Add autogenerated instruction list back into the documentation.
519 \b ELF: Fix segfault when generating stabs, and no symbols have been
520   defined.
522 \b ELF: Experimental support for DWARF debugging information.
524 \b New compile date and time standard macros.
526 \b \c{%ifnum} now returns true for negative numbers.
528 \b New \c{%iftoken} test for a single token.
530 \b New \c{%ifempty} test for empty expansion.
532 \b Add support for the \c{XSAVE} instruction group.
534 \b Makefile for Netware/gcc.
536 \b Fix issue with some warnings getting emitted way too many times.
538 \b Autogenerated instruction list added to the documentation.
541 \S{cl-2.01} Version 2.01
543 \b Fix the handling of MMX registers with explicit \c{qword} tags on
544   memory (broken in 2.00 due to 64-bit changes.)
546 \b Fix the PREFETCH instructions.
548 \b Fix the documentation.
550 \b Fix debugging info when using \c{-f elf}
551 (backwards compatibility alias for \c{-f elf32}).
553 \b Man pages for rdoff tools (from the Debian project.)
555 \b ELF: handle large numbers of sections.
557 \b Fix corrupt output when the optimizer runs out of passes.
560 \S{cl-2.00} Version 2.00
562 \b Added c99 data-type compliance.
564 \b Added general x86-64 support.
566 \b Added win64 (x86-64 COFF) output format.
568 \b Added \c{__BITS__} standard macro.
570 \b Renamed the \c{elf} output format to \c{elf32} for clarity.
572 \b Added \c{elf64} and \c{macho} (MacOS X) output formats.
574 \b Added Numeric constants in \c{dq} directive.
576 \b Added \c{oword}, \c{do} and \c{reso} pseudo operands.
578 \b Allow underscores in numbers.
580 \b Added 8-, 16- and 128-bit floating-point formats.
582 \b Added binary, octal and hexadecimal floating-point.
584 \b Correct the generation of floating-point constants.
586 \b Added floating-point option control.
588 \b Added Infinity and NaN floating point support.
590 \b Added ELF Symbol Visibility support.
592 \b Added setting OSABI value in ELF header directive.
594 \b Added Generate Makefile Dependencies option.
596 \b Added Unlimited Optimization Passes option.
598 \b Added \c{%IFN} and \c{%ELIFN} support.
600 \b Added Logical Negation Operator.
602 \b Enhanced Stack Relative Preprocessor Directives.
604 \b Enhanced ELF Debug Formats.
606 \b Enhanced Send Errors to a File option.
608 \b Added SSSE3, SSE4.1, SSE4.2, SSE5 support.
610 \b Added a large number of additional instructions.
612 \b Significant performance improvements.
614 \b \c{-w+warning} and \c{-w-warning} can now be written as -Wwarning and
615  -Wno-warning, respectively.  See \k{opt-w}.
617 \b Add \c{-w+error} to treat warnings as errors.  See \k{opt-w}.
619 \b Add \c{-w+all} and \c{-w-all} to enable or disable all suppressible
620  warnings.  See \k{opt-w}.
623 \H{cl-0.98.xx} NASM 0.98 Series
625 The 0.98 series was the production versions of NASM from 1999 to 2007.
628 \S{cl-0.98.39} Version 0.98.39
630 \b fix buffer overflow
632 \b fix outas86's \c{.bss} handling
634 \b "make spotless" no longer deletes config.h.in.
636 \b \c{%(el)if(n)idn} insensitivity to string quotes difference (#809300).
638 \b (nasm.c)\c{__OUTPUT_FORMAT__} changed to string value instead of symbol.
640 \S{cl-0.98.38} Version 0.98.38
643 \b Add Makefile for 16-bit DOS binaries under OpenWatcom, and modify
644   \c{mkdep.pl} to be able to generate completely pathless dependencies, as
645   required by OpenWatcom wmake (it supports path searches, but not
646   explicit paths.)
648 \b Fix the \c{STR} instruction.
650 \b Fix the ELF output format, which was broken under certain
651   circumstances due to the addition of stabs support.
653 \b Quick-fix Borland format debug-info for \c{-f obj}
655 \b Fix for \c{%rep} with no arguments (#560568)
657 \b Fix concatenation of preprocessor function call (#794686)
659 \b Fix long label causes coredump (#677841)
661 \b Use autoheader as well as autoconf to keep configure from generating
662   ridiculously long command lines.
664 \b Make sure that all of the formats which support debugging output
665   actually will suppress debugging output when \c{-g} not specified.
667 \S{cl-0.98.37} Version 0.98.37
670 \b Paths given in \c{-I} switch searched for \c{incbin}-ed as
671   well as \c{%include}-ed files.
673 \b Added stabs debugging for the ELF output format, patch from
674   Martin Wawro.
676 \b Fix \c{output/outbin.c} to allow origin > 80000000h.
678 \b Make \c{-U} switch work.
680 \b Fix the use of relative offsets with explicit prefixes, e.g.
681 \c{a32 loop foo}.
683 \b Remove \c{backslash()}.
685 \b Fix the \c{SMSW} and \c{SLDT} instructions.
687 \b \c{-O2} and \c{-O3} are no longer aliases for \c{-O10} and \c{-O15}.
688 If you mean the latter, please say so! :)
690 \S{cl-0.98.36} Version 0.98.36
693 \b Update rdoff - librarian/archiver - common rec - docs!
695 \b Fix signed/unsigned problems.
697 \b Fix \c{JMP FAR label} and \c{CALL FAR label}.
699 \b Add new multisection support - map files - fix align bug
701 \b Fix sysexit, movhps/movlps reg,reg bugs in insns.dat
703 \b \c{Q} or \c{O} suffixes indicate octal
705 \b Support Prescott new instructions (PNI).
707 \b Cyrix \c{XSTORE} instruction.
710 \S{cl-0.98.35} Version 0.98.35
712 \b Fix build failure on 16-bit DOS (Makefile.bc3 workaround for compiler bug.)
714 \b Fix dependencies and compiler warnings.
716 \b Add "const" in a number of places.
718 \b Add -X option to specify error reporting format (use -Xvc to
719   integrate with Microsoft Visual Studio.)
721 \b Minor changes for code legibility.
723 \b Drop use of tmpnam() in rdoff (security fix.)
726 \S{cl-0.98.34} Version 0.98.34
728 \b Correct additional address-size vs. operand-size confusions.
730 \b Generate dependencies for all Makefiles automatically.
732 \b Add support for unimplemented (but theoretically available)
733   registers such as tr0 and cr5.  Segment registers 6 and 7 are called
734   segr6 and segr7 for the operations which they can be represented.
736 \b Correct some disassembler bugs related to redundant address-size prefixes.
737   Some work still remains in this area.
739 \b Correctly generate an error for things like "SEG eax".
741 \b Add the JMPE instruction, enabled by "CPU IA64".
743 \b Correct compilation on newer gcc/glibc platforms.
745 \b Issue an error on things like "jmp far eax".
748 \S{cl-0.98.33} Version 0.98.33
750 \b New __NASM_PATCHLEVEL__ and __NASM_VERSION_ID__ standard macros to
751   round out the version-query macros.  version.pl now understands
752   X.YYplWW or X.YY.ZZplWW as a version number, equivalent to
753   X.YY.ZZ.WW (or X.YY.0.WW, as appropriate).
755 \b New keyword "strict" to disable the optimization of specific
756   operands.
758 \b Fix the handing of size overrides with JMP instructions
759   (instructions such as "jmp dword foo".)
761 \b Fix the handling of "ABSOLUTE label", where "label" points into a
762   relocatable segment.
764 \b Fix OBJ output format with lots of externs.
766 \b More documentation updates.
768 \b Add -Ov option to get verbose information about optimizations.
770 \b Undo a braindead change which broke \c{%elif} directives.
772 \b Makefile updates.
775 \S{cl-0.98.32} Version 0.98.32
777 \b Fix NASM crashing when \c{%macro} directives were left unterminated.
779 \b Lots of documentation updates.
781 \b Complete rewrite of the PostScript/PDF documentation generator.
783 \b The MS Visual C++ Makefile was updated and corrected.
785 \b Recognize .rodata as a standard section name in ELF.
787 \b Fix some obsolete Perl4-isms in Perl scripts.
789 \b Fix configure.in to work with autoconf 2.5x.
791 \b Fix a couple of "make cleaner" misses.
793 \b Make the normal "./configure && make" work with Cygwin.
796 \S{cl-0.98.31} Version 0.98.31
798 \b Correctly build in a separate object directory again.
800 \b Derive all references to the version number from the version file.
802 \b New standard macros __NASM_SUBMINOR__ and __NASM_VER__ macros.
804 \b Lots of Makefile updates and bug fixes.
806 \b New \c{%ifmacro} directive to test for multiline macros.
808 \b Documentation updates.
810 \b Fixes for 16-bit OBJ format output.
812 \b Changed the NASM environment variable to NASMENV.
815 \S{cl-0.98.30} Version 0.98.30
817 \b Changed doc files a lot: completely removed old READMExx and
818   Wishlist files, incorporating all information in CHANGES and TODO.
820 \b I waited a long time to rename zoutieee.c to (original) outieee.c
822 \b moved all output modules to output/ subdirectory.
824 \b Added 'make strip' target to strip debug info from nasm & ndisasm.
826 \b Added INSTALL file with installation instructions.
828 \b Added -v option description to nasm man.
830 \b Added dist makefile target to produce source distributions.
832 \b 16-bit support for ELF output format (GNU extension, but useful.)
835 \S{cl-0.98.28} Version 0.98.28
837 \b Fastcooked this for Debian's Woody release:
838 Frank applied the INCBIN bug patch to 0.98.25alt and called
839 it 0.98.28 to not confuse poor little apt-get.
842 \S{cl-0.98.26} Version 0.98.26
844 \b Reorganised files even better from 0.98.25alt
847 \S{cl-0.98.25alt} Version 0.98.25alt
849 \b Prettified the source tree. Moved files to more reasonable places.
851 \b Added findleak.pl script to misc/ directory.
853 \b Attempted to fix doc.
856 \S{cl-0.98.25} Version 0.98.25
858 \b Line continuation character \c{\\}.
860 \b Docs inadvertantly reverted - "dos packaging".
863 \S{cl-0.98.24p1} Version 0.98.24p1
865 \b FIXME: Someone, document this please.
868 \S{cl-0.98.24} Version 0.98.24
870 \b Documentation - Ndisasm doc added to Nasm.doc.
873 \S{cl-0.98.23} Version 0.98.23
875 \b Attempted to remove rdoff version1
877 \b Lino Mastrodomenico's patches to preproc.c (%$$ bug?).
880 \S{cl-0.98.22} Version 0.98.22
882 \b Update rdoff2 - attempt to remove v1.
885 \S{cl-0.98.21} Version 0.98.21
887 \b Optimization fixes.
890 \S{cl-0.98.20} Version 0.98.20
892 \b Optimization fixes.
895 \S{cl-0.98.19} Version 0.98.19
897 \b H. J. Lu's patch back out.
900 \S{cl-0.98.18} Version 0.98.18
902 \b Added ".rdata" to "-f win32".
905 \S{cl-0.98.17} Version 0.98.17
907 \b H. J. Lu's "bogus elf" patch. (Red Hat problem?)
910 \S{cl-0.98.16} Version 0.98.16
912 \b Fix whitespace before "[section ..." bug.
915 \S{cl-0.98.15} Version 0.98.15
917 \b Rdoff changes (?).
919 \b Fix fixes to memory leaks.
922 \S{cl-0.98.14} Version 0.98.14
924 \b Fix memory leaks.
927 \S{cl-0.98.13} Version 0.98.13
929 \b There was no 0.98.13
932 \S{cl-0.98.12} Version 0.98.12
934 \b Update optimization (new function of "-O1")
936 \b Changes to test/bintest.asm (?).
939 \S{cl-0.98.11} Version 0.98.11
941 \b Optimization changes.
943 \b Ndisasm fixed.
946 \S{cl-0.98.10} Version 0.98.10
948 \b There was no 0.98.10
951 \S{cl-0.98.09} Version 0.98.09
953 \b Add multiple sections support to "-f bin".
955 \b Changed GLOBAL_TEMP_BASE in outelf.c from 6 to 15.
957 \b Add "-v" as an alias to the "-r" switch.
959 \b Remove "#ifdef" from Tasm compatibility options.
961 \b Remove redundant size-overrides on "mov ds, ex", etc.
963 \b Fixes to SSE2, other insns.dat (?).
965 \b Enable uppercase "I" and "P" switches.
967 \b Case insinsitive "seg" and "wrt".
969 \b Update install.sh (?).
971 \b Allocate tokens in blocks.
973 \b Improve "invalid effective address" messages.
976 \S{cl-0.98.08} Version 0.98.08
978 \b Add "\c{%strlen}" and "\c{%substr}" macro operators
980 \b Fixed broken c16.mac.
982 \b Unterminated string error reported.
984 \b Fixed bugs as per 0.98bf
987 \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
989 Changes from 0.98.07 release to 98.09b as of 28-Oct-2001
991 \b More closely compatible with 0.98 when -O0 is implied
992 or specified.  Not strictly identical, since backward 
993 branches in range of short offsets are recognized, and signed
994 byte values with no explicit size specification will be
995 assembled as a single byte.
997 \b More forgiving with the PUSH instruction.  0.98 requires
998 a size to be specified always.  0.98.09b will imply the size
999 from the current BITS setting (16 or 32).
1001 \b Changed definition of the optimization flag:
1003         -O0     strict two-pass assembly, JMP and Jcc are
1004                 handled more like 0.98, except that back-
1005                 ward JMPs are short, if possible.
1007         -O1     strict two-pass assembly, but forward
1008                 branches are assembled with code guaranteed
1009                 to reach; may produce larger code than
1010                 -O0, but will produce successful assembly
1011                 more often if branch offset sizes are not
1012                 specified.
1014         -O2     multi-pass optimization, minimize branch
1015                 offsets; also will minimize signed immed-
1016                 iate bytes, overriding size specification.
1018         -O3     like -O2, but more passes taken, if needed
1021 \S{cl-0.98.07 released 01/28/01} Version 0.98.07 released 01/28/01
1023 \b       Added Stepane Denis' SSE2 instructions to a *working*
1024         version of the code - some earlier versions were based on
1025         broken code - sorry 'bout that. version "0.98.07"
1028 01/28/01
1031 \b       Cosmetic modifications to nasm.c, nasm.h,
1032         AUTHORS, MODIFIED
1035 \S{cl-0.98.06f released 01/18/01} Version 0.98.06f released 01/18/01
1038 \b       - Add "metalbrain"s jecxz bug fix in insns.dat
1039         - alter nasmdoc.src to match - version "0.98.06f"
1042 \S{cl-0.98.06e released 01/09/01} Version 0.98.06e released 01/09/01
1045 \b       Removed the "outforms.h" file - it appears to be
1046         someone's old backup of "outform.h". version "0.98.06e" 
1048 01/09/01
1050 \b fbk - finally added the fix for the "multiple %includes bug",
1051         known since 7/27/99 - reported originally (?) and sent to
1052         us by Austin Lunnen - he reports that John Fine had a fix
1053         within the day. Here it is...
1055 \b Nelson Rush resigns from the group. Big thanks to Nelson for
1056   his leadership and enthusiasm in getting these changes
1057   incorporated into Nasm!
1059 \b fbk - [list +], [list -] directives - ineptly implemented, should
1060         be re-written or removed, perhaps.
1062 \b Brian Raiter / fbk - "elfso bug" fix - applied to aoutb format
1063                        as well - testing might be desirable...
1065 08/07/00
1067 \b James Seter - -postfix, -prefix command line switches.
1069 \b Yuri Zaporogets - rdoff utility changes.
1072 \S{cl-0.98p1} Version 0.98p1
1074 \b GAS-like palign (Panos Minos)
1076 \b FIXME: Someone, fill this in with details
1079 \S{cl-0.98bf (bug-fixed)} Version 0.98bf (bug-fixed)
1081 \b Fixed - elf and aoutb bug - shared libraries
1082         - multiple "%include" bug in "-f obj"   
1083         - jcxz, jecxz bug
1084         - unrecognized option bug in ndisasm 
1086 \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
1088 \b Added signed byte optimizations for the 0x81/0x83 class
1089 of instructions: ADC, ADD, AND, CMP, OR, SBB, SUB, XOR:
1090 when used as 'ADD reg16,imm' or 'ADD reg32,imm.'  Also
1091 optimization of signed byte form of 'PUSH imm' and 'IMUL
1092 reg,imm'/'IMUL reg,reg,imm.'  No size specification is needed.
1094 \b Added multi-pass JMP and Jcc offset optimization.  Offsets
1095 on forward references will preferentially use the short form,
1096 without the need to code a specific size (short or near) for
1097 the branch.  Added instructions for 'Jcc label' to use the
1098 form 'Jnotcc $+3/JMP label', in cases where a short offset
1099 is out of bounds.  If compiling for a 386 or higher CPU, then
1100 the 386 form of Jcc will be used instead.
1102 This feature is controlled by a new command-line switch: "O",
1103 (upper case letter O).  "-O0" reverts the assembler to no
1104 extra optimization passes, "-O1" allows up to 5 extra passes,
1105 and "-O2"(default), allows up to 10 extra optimization passes.
1107 \b Added a new directive:  'cpu XXX', where XXX is any of: 
1108 8086, 186, 286, 386, 486, 586, pentium, 686, PPro, P2, P3 or
1109 Katmai.  All are case insensitive.  All instructions will
1110 be selected only if they apply to the selected cpu or lower.
1111 Corrected a couple of bugs in cpu-dependence in 'insns.dat'.
1113 \b Added to 'standard.mac', the "use16" and "use32" forms of
1114 the "bits 16/32" directive. This is nothing new, just conforms
1115 to a lot of other assemblers. (minor)
1117 \b Changed label allocation from 320/32 (10000 labels @ 200K+) 
1118 to 32/37 (1000 labels); makes running under DOS much easier.
1119 Since additional label space is allocated dynamically, this
1120 should have no effect on large programs with lots of labels.
1121 The 37 is a prime, believed to be better for hashing. (minor)
1124 \S{cl-0.98.03} Version 0.98.03
1126 "Integrated patchfile 0.98-0.98.01.  I call this version 0.98.03 for
1127 historical reasons: 0.98.02 was trashed." --John Coffman
1128 <johninsd@san.rr.com>, 27-Jul-2000
1130 \b Kendall Bennett's SciTech MGL changes
1132 \b Note that you must define "TASM_COMPAT" at compile-time
1133 to get the Tasm Ideal Mode compatibility.
1135 \b All changes can be compiled in and out using the TASM_COMPAT macros,
1136 and when compiled without TASM_COMPAT defined we get the exact same
1137 binary as the unmodified 0.98 sources.
1139 \b standard.mac, macros.c: Added macros to ignore TASM directives before
1140 first include
1142 \b nasm.h: Added extern declaration for tasm_compatible_mode
1144 \b nasm.c: Added global variable tasm_compatible_mode
1146 \b Added command line switch for TASM compatible mode (-t)
1148 \b Changed version command line to reflect when compiled with TASM additions
1150 \b Added response file processing to allow all arguments on a single
1151 line (response file is @resp rather than -@resp for NASM format).
1153 \b labels.c: Changes islocal() macro to support TASM style @@local labels.
1155 \b Added islocalchar() macro to support TASM style @@local labels.
1157 \b parser.c: Added support for TASM style memory references (ie: mov
1158 [DWORD eax],10 rather than the NASM style mov DWORD [eax],10).
1160 \b preproc.c: Added new directives, \c{%arg}, \c{%local}, \c{%stacksize} to directives
1161 table
1163 \b Added support for TASM style directives without a leading % symbol.
1165 \b Integrated a block of changes from Andrew Zabolotny <bit@eltech.ru>:
1167 \b A new keyword \c{%xdefine} and its case-insensitive counterpart \c{%ixdefine}.
1168 They work almost the same way as \c{%define} and \c{%idefine} but expand
1169 the definition immediately, not on the invocation. Something like a cross
1170 between \c{%define} and \c{%assign}. The "x" suffix stands for "eXpand", so
1171 "xdefine" can be deciphered as "expand-and-define". Thus you can do
1172 things like this:
1174 \c      %assign ofs     0
1176 \c      %macro  arg     1
1177 \c              %xdefine %1 dword [esp+ofs]
1178 \c              %assign ofs ofs+4
1179 \c      %endmacro
1181 \b Changed the place where the expansion of %$name macros are expanded.
1182 Now they are converted into ..@ctxnum.name form when detokenizing, so
1183 there are no quirks as before when using %$name arguments to macros,
1184 in macros etc. For example:
1186 \c      %macro  abc     1
1187 \c              %define %1 hello
1188 \c      %endm
1190 \c      abc     %$here
1191 \c      %$here
1193     Now last line will be expanded into "hello" as expected. This also allows
1194     for lots of goodies, a good example are extended "proc" macros included
1195     in this archive.
1197 \b Added a check for "cstk" in smacro_defined() before calling get_ctx() -
1198     this allows for things like:
1200 \c      %ifdef %$abc
1201 \c      %endif
1203     to work without warnings even in no context.
1205 \b Added a check for "cstk" in %if*ctx and %elif*ctx directives -
1206     this allows to use \c{%ifctx} without excessive warnings. If there is
1207     no active context, \c{%ifctx} goes through "false" branch.
1209 \b Removed "user error: " prefix with \c{%error} directive: it just clobbers the
1210     output and has absolutely no functionality. Besides, this allows to write
1211     macros that does not differ from built-in functions in any way.
1213 \b Added expansion of string that is output by \c{%error} directive. Now you
1214     can do things like:
1216 \c      %define hello(x) Hello, x!
1218 \c      %define %$name andy
1219 \c      %error "hello(%$name)"
1221     Same happened with \c{%include} directive.
1223 \b Now all directives that expect an identifier will try to expand and
1224     concatenate everything without whitespaces in between before usage.
1225     For example, with "unfixed" nasm the commands
1227 \c      %define %$abc hello
1228 \c      %define __%$abc goodbye
1229 \c      __%$abc
1231     would produce "incorrect" output: last line will expand to
1233 \c      hello goodbyehello
1235     Not quite what you expected, eh? :-) The answer is that preprocessor
1236     treats the \c{%define} construct as if it would be
1238 \c      %define __ %$abc goodbye
1240     (note the white space between __ and %$abc). After my "fix" it
1241     will "correctly" expand into
1243 \c      goodbye
1245     as expected. Note that I use quotes around words "correct", "incorrect"
1246     etc because this is rather a feature not a bug; however current behaviour
1247     is more logical (and allows more advanced macro usage :-).
1249     Same change was applied to:
1250         \c{%push},\c{%macro},\c{%imacro},\c{%define},\c{%idefine},\c{%xdefine},\c{%ixdefine},
1251         \c{%assign},\c{%iassign},\c{%undef}
1253 \b A new directive [WARNING {+|-}warning-id] have been added. It works only
1254     if the assembly phase is enabled (i.e. it doesn't work with nasm -e).
1256 \b A new warning type: macro-selfref. By default this warning is disabled;
1257     when enabled NASM warns when a macro self-references itself; for example
1258     the following source:
1260 \c        [WARNING macro-selfref]
1262 \c        %macro          push    1-*
1263 \c                %rep    %0
1264 \c                        push    %1
1265 \c                        %rotate 1
1266 \c                %endrep
1267 \c        %endmacro
1269 \c                        push    eax,ebx,ecx
1271     will produce a warning, but if we remove the first line we won't see it
1272     anymore (which is The Right Thing To Do {tm} IMHO since C preprocessor
1273     eats such constructs without warnings at all).
1275 \b Added a "error" routine to preprocessor which always will set ERR_PASS1
1276     bit in severity_code. This removes annoying repeated errors on first
1277     and second passes from preprocessor.
1279 \b Added the %+ operator in single-line macros for concatenating two
1280     identifiers. Usage example:
1282 \c        %define _myfunc _otherfunc
1283 \c        %define cextern(x) _ %+ x
1284 \c        cextern (myfunc)
1286     After first expansion, third line will become "_myfunc". After this
1287     expansion is performed again so it becomes "_otherunc".
1289 \b Now if preprocessor is in a non-emitting state, no warning or error
1290     will be emitted. Example:
1292 \c        %if 1
1293 \c                mov     eax,ebx
1294 \c        %else
1295 \c                put anything you want between these two brackets,
1296 \c                even macro-parameter references %1 or local
1297 \c                labels %$zz or macro-local labels %%zz - no
1298 \c                warning will be emitted.
1299 \c        %endif
1301 \b Context-local variables on expansion as a last resort are looked up
1302     in outer contexts. For example, the following piece:
1304 \c        %push   outer
1305 \c        %define %$a [esp]
1307 \c                %push   inner
1308 \c                %$a
1309 \c                %pop
1310 \c        %pop
1312     will expand correctly the fourth line to [esp]; if we'll define another
1313     %$a inside the "inner" context, it will take precedence over outer
1314     definition. However, this modification has been applied only to
1315     expand_smacro and not to smacro_define: as a consequence expansion
1316     looks in outer contexts, but \c{%ifdef} won't look in outer contexts.
1318     This behaviour is needed because we don't want nested contexts to
1319     act on already defined local macros. Example:
1321 \c        %define %$arg1  [esp+4]
1322 \c        test    eax,eax
1323 \c        if      nz
1324 \c                mov     eax,%$arg1
1325 \c        endif
1327     In this example the "if" mmacro enters into the "if" context, so %$arg1
1328     is not valid anymore inside "if". Of course it could be worked around
1329     by using explicitely %$$arg1 but this is ugly IMHO.
1331 \b Fixed memory leak in \c{%undef}. The origline wasn't freed before
1332     exiting on success.
1334 \b Fixed trap in preprocessor when line expanded to empty set of tokens.
1335     This happens, for example, in the following case:
1337 \c        #define SOMETHING
1338 \c        SOMETHING
1341 \S{cl-0.98} Version 0.98
1343 All changes since NASM 0.98p3 have been produced by H. Peter Anvin <hpa@zytor.com>.
1345 \b The documentation comment delimiter is \# not #.
1347 \b Allow EQU definitions to refer to external labels; reported by
1348   Pedro Gimeno.
1350 \b Re-enable support for RDOFF v1; reported by Pedro Gimeno.
1352 \b Updated License file per OK from Simon and Julian.
1355 \S{cl-0.98p9} Version 0.98p9
1357 \b Update documentation (although the instruction set reference will
1358   have to wait; I don't want to hold up the 0.98 release for it.)
1360 \b Verified that the NASM implementation of the PEXTRW and PMOVMSKB
1361   instructions is correct.  The encoding differs from what the Intel
1362   manuals document, but the Pentium III behaviour matches NASM, not
1363   the Intel manuals.
1365 \b Fix handling of implicit sizes in PSHUFW and PINSRW, reported by
1366   Stefan Hoffmeister.
1368 \b Resurrect the -s option, which was removed when changing the
1369   diagnostic output to stdout.
1372 \S{cl-0.98p8} Version 0.98p8
1374 \b Fix for "DB" when NASM is running on a bigendian machine.
1376 \b Invoke insns.pl once for each output script, making Makefile.in
1377   legal for "make -j".
1379 \b Improve the Unix configure-based makefiles to make package
1380   creation easier.
1382 \b Included an RPM .spec file for building RPM (RedHat Package Manager)
1383   packages on Linux or Unix systems.
1385 \b Fix Makefile dependency problems.
1387 \b Change src/rdsrc.pl to include sectioning information in info
1388   output; required for install-info to work.
1390 \b Updated the RDOFF distribution to version 2 from Jules; minor
1391   massaging to make it compile in my environment.
1393 \b Split doc files that can be built by anyone with a Perl interpreter off
1394   into a separate archive.
1396 \b "Dress rehearsal" release!
1399 \S{cl-0.98p7} Version 0.98p7
1401 \b Fixed opcodes with a third byte-sized immediate argument to not
1402   complain if given "byte" on the immediate.
1404 \b Allow \c{%undef} to remove single-line macros with arguments.  This
1405   matches the behaviour of #undef in the C preprocessor.
1407 \b Allow -d, -u, -i and -p to be specified as -D, -U, -I and -P for
1408   compatibility with most C compilers and preprocessors.  This allows
1409   Makefile options to be shared between cc and nasm, for example.
1411 \b Minor cleanups.
1413 \b Went through the list of Katmai instructions and hopefully fixed the
1414   (rather few) mistakes in it.
1416 \b (Hopefully) fixed a number of disassembler bugs related to ambiguous
1417   instructions (disambiguated by -p) and SSE instructions with REP.
1419 \b Fix for bug reported by Mark Junger: "call dword 0x12345678" should
1420   work and may add an OSP (affected CALL, JMP, Jcc).
1422 \b Fix for environments when "stderr" isn't a compile-time constant.
1425 \S{cl-0.98p6} Version 0.98p6
1428 \b Took officially over coordination of the 0.98 release; so drop
1429   the p3.x notation. Skipped p4 and p5 to avoid confusion with John
1430   Fine's J4 and J5 releases.
1432 \b Update the documentation; however, it still doesn't include
1433   documentation for the various new instructions.  I somehow wonder if
1434   it makes sense to have an instruction set reference in the assembler
1435   manual when Intel et al have PDF versions of their manuals online.
1437 \b Recognize "idt" or "centaur" for the -p option to ndisasm.
1439 \b Changed error messages back to stderr where they belong, but add an
1440   -E option to redirect them elsewhere (the DOS shell cannot redirect
1441   stderr.)
1443 \b -M option to generate Makefile dependencies (based on code from Alex
1444   Verstak.)
1446 \b \c{%undef} preprocessor directive, and -u option, that undefines a
1447   single-line macro.
1449 \b OS/2 Makefile (Mkfiles/Makefile.os2) for Borland under OS/2; from
1450   Chuck Crayne.
1452 \b Various minor bugfixes (reported by):
1453   - Dangling \c{%s} in preproc.c (Martin Junker)
1455 \b THERE ARE KNOWN BUGS IN SSE AND THE OTHER KATMAI INSTRUCTIONS.  I am
1456   on a trip and didn't bring the Katmai instruction reference, so I
1457   can't work on them right now.
1459 \b Updated the License file per agreement with Simon and Jules to
1460   include a GPL distribution clause.
1463 \S{cl-0.98p3.7} Version 0.98p3.7
1465 \b (Hopefully) fixed the canned Makefiles to include the outrdf2 and
1466   zoutieee modules.
1468 \b Renamed changes.asm to changed.asm.
1471 \S{cl-0.98p3.6} Version 0.98p3.6
1473 \b Fixed a bunch of instructions that were added in 0.98p3.5 which had
1474   memory operands, and the address-size prefix was missing from the
1475   instruction pattern.
1478 \S{cl-0.98p3.5} Version 0.98p3.5
1480 \b Merged in changes from John S. Fine's 0.98-J5 release.  John's based
1481   0.98-J5 on my 0.98p3.3 release; this merges the changes.
1483 \b Expanded the instructions flag field to a long so we can fit more
1484   flags; mark SSE (KNI) and AMD or Katmai-specific instructions as
1485   such.
1487 \b Fix the "PRIV" flag on a bunch of instructions, and create new
1488   "PROT" flag for protected-mode-only instructions (orthogonal to if
1489   the instruction is privileged!) and new "SMM" flag for SMM-only
1490   instructions.
1492 \b Added AMD-only SYSCALL and SYSRET instructions.
1494 \b Make SSE actually work, and add new Katmai MMX instructions.
1496 \b Added a -p (preferred vendor) option to ndisasm so that it can
1497   distinguish e.g. Cyrix opcodes also used in SSE.  For example:
1499 \c      ndisasm -p cyrix aliased.bin
1500 \c      00000000  670F514310        paddsiw mm0,[ebx+0x10]
1501 \c      00000005  670F514320        paddsiw mm0,[ebx+0x20]
1502 \c      ndisasm -p intel aliased.bin
1503 \c      00000000  670F514310        sqrtps xmm0,[ebx+0x10]
1504 \c      00000005  670F514320        sqrtps xmm0,[ebx+0x20]
1506 \b Added a bunch of Cyrix-specific instructions.
1509 \S{cl-0.98p3.4} Version 0.98p3.4
1511 \b Made at least an attempt to modify all the additional Makefiles (in
1512   the Mkfiles directory).  I can't test it, but this was the best I
1513   could do.
1515 \b DOS DJGPP+"Opus Make" Makefile from John S. Fine.
1517 \b changes.asm changes from John S. Fine.
1520 \S{cl-0.98p3.3} Version 0.98p3.3
1522 \b Patch from Conan Brink to allow nesting of \c{%rep} directives.
1524 \b If we're going to allow INT01 as an alias for INT1/ICEBP (one of
1525   Jules 0.98p3 changes), then we should allow INT03 as an alias for INT3
1526   as well.
1528 \b Updated changes.asm to include the latest changes.
1530 \b Tried to clean up the <CR>s that had snuck in from a DOS/Windows
1531   environment into my Unix environment, and try to make sure than
1532   DOS/Windows users get them back.
1534 \b We would silently generate broken tools if insns.dat wasn't sorted
1535   properly.  Change insns.pl so that the order doesn't matter.
1537 \b Fix bug in insns.pl (introduced by me) which would cause conditional
1538   instructions to have an extra "cc" in disassembly, e.g. "jnz"
1539   disassembled as "jccnz".
1542 \S{cl-0.98p3.2} Version 0.98p3.2
1544 \b Merged in John S. Fine's changes from his 0.98-J4 prerelease; see
1545   http://www.csoft.net/cz/johnfine/
1547 \b Changed previous "spotless" Makefile target (appropriate for distribution)
1548   to "distclean", and added "cleaner" target which is same as "clean"
1549   except deletes files generated by Perl scripts; "spotless" is union.
1551 \b Removed BASIC programs from distribution.  Get a Perl interpreter
1552   instead (see below.)
1554 \b Calling this "pre-release 3.2" rather than "p3-hpa2" because of
1555   John's contributions.
1557 \b Actually link in the IEEE output format (zoutieee.c); fix a bunch of
1558   compiler warnings in that file.  Note I don't know what IEEE output
1559   is supposed to look like, so these changes were made "blind".
1562 \S{cl-0.98p3-hpa} Version 0.98p3-hpa
1564 \b Merged nasm098p3.zip with nasm-0.97.tar.gz to create a fully
1565   buildable version for Unix systems (Makefile.in updates, etc.)
1567 \b Changed insns.pl to create the instruction tables in nasm.h and
1568   names.c, so that a new instruction can be added by adding it *only*
1569   to insns.dat.
1571 \b Added the following new instructions: SYSENTER, SYSEXIT, FXSAVE,
1572   FXRSTOR, UD1, UD2 (the latter two are two opcodes that Intel
1573   guarantee will never be used; one of them is documented as UD2 in
1574   Intel documentation, the other one just as "Undefined Opcode" --
1575   calling it UD1 seemed to make sense.)
1577 \b MAX_SYMBOL was defined to be 9, but LOADALL286 and LOADALL386 are 10
1578   characters long.  Now MAX_SYMBOL is derived from insns.dat.
1580 \b A note on the BASIC programs included: forget them.  insns.bas is
1581   already out of date.  Get yourself a Perl interpreter for your
1582   platform of choice at
1583   \W{http://www.cpan.org/ports/index.html}{http://www.cpan.org/ports/index.html}.
1586 \S{cl-0.98p3} Version 0.98 pre-release 3
1588 \b added response file support, improved command line handling, new layout
1589 help screen
1591 \b fixed limit checking bug, 'OUT byte nn, reg' bug, and a couple of rdoff
1592 related bugs, updated Wishlist; 0.98 Prerelease 3.
1595 \S{cl-0.98p2} Version 0.98 pre-release 2
1597 \b fixed bug in outcoff.c to do with truncating section names longer
1598 than 8 characters, referencing beyond end of string; 0.98 pre-release 2
1601 \S{cl-0.98p1} Version 0.98 pre-release 1
1603 \b Fixed a bug whereby STRUC didn't work at all in RDF.
1605 \b Fixed a problem with group specification in PUBDEFs in OBJ.
1607 \b Improved ease of adding new output formats. Contribution due to
1608 Fox Cutter.
1610 \b Fixed a bug in relocations in the `bin' format: was showing up when
1611 a relocatable reference crossed an 8192-byte boundary in any output
1612 section.
1614 \b Fixed a bug in local labels: local-label lookups were inconsistent
1615 between passes one and two if an EQU occurred between the definition
1616 of a global label and the subsequent use of a local label local to
1617 that global.
1619 \b Fixed a seg-fault in the preprocessor (again) which happened when
1620 you use a blank line as the first line of a multi-line macro
1621 definition and then defined a label on the same line as a call to
1622 that macro.
1624 \b Fixed a stale-pointer bug in the handling of the NASM environment
1625 variable. Thanks to Thomas McWilliams.
1627 \b ELF had a hard limit on the number of sections which caused
1628 segfaults when transgressed. Fixed.
1630 \b Added ability for ndisasm to read from stdin by using `-' as the
1631 filename.
1633 \b ndisasm wasn't outputting the TO keyword. Fixed.
1635 \b Fixed error cascade on bogus expression in \c{%if} - an error in
1636 evaluation was causing the entire \c{%if} to be discarded, thus creating
1637 trouble later when the \c{%else} or \c{%endif} was encountered.
1639 \b Forward reference tracking was instruction-granular not operand-
1640 granular, which was causing 286-specific code to be generated
1641 needlessly on code of the form `shr word [forwardref],1'. Thanks to
1642 Jim Hague for sending a patch.
1644 \b All messages now appear on stdout, as sending them to stderr serves
1645 no useful purpose other than to make redirection difficult.
1647 \b Fixed the problem with EQUs pointing to an external symbol - this
1648 now generates an error message.
1650 \b Allowed multiple size prefixes to an operand, of which only the first
1651 is taken into account.
1653 \b Incorporated John Fine's changes, including fixes of a large number
1654 of preprocessor bugs, some small problems in OBJ, and a reworking of
1655 label handling to define labels before their line is assembled, rather
1656 than after.
1658 \b Reformatted a lot of the source code to be more readable. Included
1659 'coding.txt' as a guideline for how to format code for contributors.
1661 \b Stopped nested \c{%reps} causing a panic - they now cause a slightly more
1662 friendly error message instead.
1664 \b Fixed floating point constant problems (patch by Pedro Gimeno)
1666 \b Fixed the return value of insn_size() not being checked for -1, indicating
1667 an error.
1669 \b Incorporated 3Dnow! instructions.
1671 \b Fixed the 'mov eax, eax + ebx' bug.
1673 \b Fixed the GLOBAL EQU bug in ELF. Released developers release 3.
1675 \b Incorporated John Fine's command line parsing changes
1677 \b Incorporated David Lindauer's OMF debug support
1679 \b Made changes for LCC 4.0 support (\c{__NASM_CDecl__}, removed register size
1680 specification warning when sizes agree).
1683 \H{cl-0.9x} NASM 0.9 Series
1685 Revisions before 0.98.
1688 \S{cl-0.97} Version 0.97 released December 1997
1690 \b This was entirely a bug-fix release to 0.96, which seems to have got
1691 cursed. Silly me.
1693 \b Fixed stupid mistake in OBJ which caused `MOV EAX,<constant>' to
1694 fail. Caused by an error in the `MOV EAX,<segment>' support.
1696 \b ndisasm hung at EOF when compiled with lcc on Linux because lcc on
1697 Linux somehow breaks feof(). ndisasm now does not rely on feof().
1699 \b A heading in the documentation was missing due to a markup error in
1700 the indexing. Fixed.
1702 \b Fixed failure to update all pointers on realloc() within extended-
1703 operand code in parser.c. Was causing wrong behaviour and seg faults
1704 on lines such as `dd 0.0,0.0,0.0,0.0,...'
1706 \b Fixed a subtle preprocessor bug whereby invoking one multi-line
1707 macro on the first line of the expansion of another, when the second
1708 had been invoked with a label defined before it, didn't expand the
1709 inner macro. 
1711 \b Added internal.doc back in to the distribution archives - it was
1712 missing in 0.96 *blush*
1714 \b Fixed bug causing 0.96 to be unable to assemble its own test files,
1715 specifically objtest.asm. *blush again*
1717 \b Fixed seg-faults and bogus error messages caused by mismatching
1718 \c{%rep} and \c{%endrep} within multi-line macro definitions.
1720 \b Fixed a problem with buffer overrun in OBJ, which was causing
1721 corruption at ends of long PUBDEF records.
1723 \b Separated DOS archives into main-program and documentation to reduce
1724 download size.
1727 \S{cl-0.96} Version 0.96 released November 1997
1729 \b Fixed a bug whereby, if `nasm sourcefile' would cause a filename
1730 collision warning and put output into `nasm.out', then `nasm
1731 sourcefile -o outputfile' still gave the warning even though the
1732 `-o' was honoured.
1733 Fixed name pollution under Digital UNIX: one of its header files
1734 defined R_SP, which broke the enum in nasm.h.
1736 \b Fixed minor instruction table problems: FUCOM and FUCOMP didn't have
1737 two-operand forms; NDISASM didn't recognise the longer register
1738 forms of PUSH and POP (eg FF F3 for PUSH BX); TEST mem,imm32 was
1739 flagged as undocumented; the 32-bit forms of CMOV had 16-bit operand
1740 size prefixes; `AAD imm' and `AAM imm' are no longer flagged as
1741 undocumented because the Intel Architecture reference documents
1742 them.
1744 \b Fixed a problem with the local-label mechanism, whereby strange
1745 types of symbol (EQUs, auto-defined OBJ segment base symbols)
1746 interfered with the `previous global label' value and screwed up
1747 local labels.
1749 \b Fixed a bug whereby the stub preprocessor didn't communicate with
1750 the listing file generator, so that the -a and -l options in
1751 conjunction would produce a useless listing file.
1753 \b Merged `os2' object file format back into `obj', after discovering
1754 that `obj' _also_ shouldn't have a link pass separator in a module
1755 containing a non-trivial MODEND. Flat segments are now declared
1756 using the FLAT attribute. `os2' is no longer a valid object format
1757 name: use `obj'.
1759 \b Removed the fixed-size temporary storage in the evaluator. Very very
1760 long expressions (like `mov ax,1+1+1+1+...' for two hundred 1s or
1761 so) should now no longer crash NASM.
1763 \b Fixed a bug involving segfaults on disassembly of MMX instructions,
1764 by changing the meaning of one of the operand-type flags in nasm.h.
1765 This may cause other apparently unrelated MMX problems; it needs to
1766 be tested thoroughly.
1768 \b Fixed some buffer overrun problems with large OBJ output files.
1769 Thanks to DJ Delorie for the bug report and fix.
1771 \b Made preprocess-only mode actually listen to the \c{%line} markers as it
1772 prints them, so that it can report errors more sanely.
1774 \b Re-designed the evaluator to keep more sensible track of expressions
1775 involving forward references: can now cope with previously-nightmare
1776 situations such as:
1778 \c   mov ax,foo | bar
1779 \c   foo equ 1
1780 \c   bar equ 2
1782 \b Added the ALIGN and ALIGNB standard macros.
1784 \b Added PIC support in ELF: use of WRT to obtain the four extra
1785 relocation types needed.
1787 \b Added the ability for output file formats to define their own
1788 extensions to the GLOBAL, COMMON and EXTERN directives.
1790 \b Implemented common-variable alignment, and global-symbol type and
1791 size declarations, in ELF.
1793 \b Implemented NEAR and FAR keywords for common variables, plus
1794 far-common element size specification, in OBJ.
1796 \b Added a feature whereby EXTERNs and COMMONs in OBJ can be given a
1797 default WRT specification (either a segment or a group).
1799 \b Transformed the Unix NASM archive into an auto-configuring package.
1801 \b Added a sanity-check for people applying SEG to things which are
1802 already segment bases: this previously went unnoticed by the SEG
1803 processing and caused OBJ-driver panics later.
1805 \b Added the ability, in OBJ format, to deal with `MOV EAX,<segment>'
1806 type references: OBJ doesn't directly support dword-size segment
1807 base fixups, but as long as the low two bytes of the constant term
1808 are zero, a word-size fixup can be generated instead and it will
1809 work.
1811 \b Added the ability to specify sections' alignment requirements in
1812 Win32 object files and pure binary files.
1814 \b Added preprocess-time expression evaluation: the \c{%assign} (and
1815 \c{%iassign}) directive and the bare \c{%if} (and \c{%elif}) conditional. Added
1816 relational operators to the evaluator, for use only in \c{%if}
1817 constructs: the standard relationals = < > <= >= <> (and C-like
1818 synonyms == and !=) plus low-precedence logical operators &&, ^^ and
1821 \b Added a preprocessor repeat construct: \c{%rep} / \c{%exitrep} / \c{%endrep}.
1823 \b Added the __FILE__ and __LINE__ standard macros.
1825 \b Added a sanity check for number constants being greater than
1826 0xFFFFFFFF. The warning can be disabled.
1828 \b Added the %0 token whereby a variadic multi-line macro can tell how
1829 many parameters it's been given in a specific invocation.
1831 \b Added \c{%rotate}, allowing multi-line macro parameters to be cycled.
1833 \b Added the `*' option for the maximum parameter count on multi-line
1834 macros, allowing them to take arbitrarily many parameters.
1836 \b Added the ability for the user-level forms of EXTERN, GLOBAL and
1837 COMMON to take more than one argument.
1839 \b Added the IMPORT and EXPORT directives in OBJ format, to deal with
1840 Windows DLLs.
1842 \b Added some more preprocessor \c{%if} constructs: \c{%ifidn} / \c{%ifidni} (exact
1843 textual identity), and \c{%ifid} / \c{%ifnum} / \c{%ifstr} (token type testing).
1845 \b Added the ability to distinguish SHL AX,1 (the 8086 version) from
1846 SHL AX,BYTE 1 (the 286-and-upwards version whose constant happens to
1847 be 1).
1849 \b Added NetBSD/FreeBSD/OpenBSD's variant of a.out format, complete
1850 with PIC shared library features.
1852 \b Changed NASM's idiosyncratic handling of FCLEX, FDISI, FENI, FINIT,
1853 FSAVE, FSTCW, FSTENV, and FSTSW to bring it into line with the
1854 otherwise accepted standard. The previous behaviour, though it was a
1855 deliberate feature, was a deliberate feature based on a
1856 misunderstanding. Apologies for the inconvenience.
1858 \b Improved the flexibility of ABSOLUTE: you can now give it an
1859 expression rather than being restricted to a constant, and it can
1860 take relocatable arguments as well.
1862 \b Added the ability for a variable to be declared as EXTERN multiple
1863 times, and the subsequent definitions are just ignored.
1865 \b We now allow instruction prefixes (CS, DS, LOCK, REPZ etc) to be
1866 alone on a line (without a following instruction).
1868 \b Improved sanity checks on whether the arguments to EXTERN, GLOBAL
1869 and COMMON are valid identifiers.
1871 \b Added misc/exebin.mac to allow direct generation of .EXE files by
1872 hacking up an EXE header using DB and DW; also added test/binexe.asm
1873 to demonstrate the use of this. Thanks to Yann Guidon for
1874 contributing the EXE header code.
1876 \b ndisasm forgot to check whether the input file had been successfully
1877 opened. Now it does. Doh!
1879 \b Added the Cyrix extensions to the MMX instruction set.
1881 \b Added a hinting mechanism to allow [EAX+EBX] and [EBX+EAX] to be
1882 assembled differently. This is important since [ESI+EBP] and
1883 [EBP+ESI] have different default base segment registers.
1885 \b Added support for the PharLap OMF extension for 4096-byte segment
1886 alignment.
1889 \S{cl-0.95 released July 1997} Version 0.95 released July 1997
1891 \b Fixed yet another ELF bug. This one manifested if the user relied on
1892 the default segment, and attempted to define global symbols without
1893 first explicitly declaring the target segment.
1895 \b Added makefiles (for NASM and the RDF tools) to build Win32 console
1896 apps under Symantec C++. Donated by Mark Junker.
1898 \b Added `macros.bas' and `insns.bas', QBasic versions of the Perl
1899 scripts that convert `standard.mac' to `macros.c' and convert
1900 `insns.dat' to `insnsa.c' and `insnsd.c'. Also thanks to Mark
1901 Junker.
1903 \b Changed the diassembled forms of the conditional instructions so
1904 that JB is now emitted as JC, and other similar changes. Suggested
1905 list by Ulrich Doewich.
1907 \b Added `@' to the list of valid characters to begin an identifier
1908 with.
1910 \b Documentary changes, notably the addition of the `Common Problems'
1911 section in nasm.doc.
1913 \b Fixed a bug relating to 32-bit PC-relative fixups in OBJ.
1915 \b Fixed a bug in perm_copy() in labels.c which was causing exceptions
1916 in cleanup_labels() on some systems.
1918 \b Positivity sanity check in TIMES argument changed from a warning to
1919 an error following a further complaint.
1921 \b Changed the acceptable limits on byte and word operands to allow
1922 things like `~10111001b' to work.
1924 \b Fixed a major problem in the preprocessor which caused seg-faults if
1925 macro definitions contained blank lines or comment-only lines.
1927 \b Fixed inadequate error checking on the commas separating the
1928 arguments to `db', `dw' etc.
1930 \b Fixed a crippling bug in the handling of macros with operand counts
1931 defined with a `+' modifier.
1933 \b Fixed a bug whereby object file formats which stored the input file
1934 name in the output file (such as OBJ and COFF) weren't doing so
1935 correctly when the output file name was specified on the command
1936 line.
1938 \b Removed [INC] and [INCLUDE] support for good, since they were
1939 obsolete anyway.
1941 \b Fixed a bug in OBJ which caused all fixups to be output in 16-bit
1942 (old-format) FIXUPP records, rather than putting the 32-bit ones in
1943 FIXUPP32 (new-format) records.
1945 \b Added, tentatively, OS/2 object file support (as a minor variant on
1946 OBJ).
1948 \b Updates to Fox Cutter's Borland C makefile, Makefile.bc2.
1950 \b Removed a spurious second fclose() on the output file.
1952 \b Added the `-s' command line option to redirect all messages which
1953 would go to stderr (errors, help text) to stdout instead.
1955 \b Added the `-w' command line option to selectively suppress some
1956 classes of assembly warning messages.
1958 \b Added the `-p' pre-include and `-d' pre-define command-line options.
1960 \b Added an include file search path: the `-i' command line option.
1962 \b Fixed a silly little preprocessor bug whereby starting a line with a
1963 `%!' environment-variable reference caused an `unknown directive'
1964 error.
1966 \b Added the long-awaited listing file support: the `-l' command line
1967 option.
1969 \b Fixed a problem with OBJ format whereby, in the absence of any
1970 explicit segment definition, non-global symbols declared in the
1971 implicit default segment generated spurious EXTDEF records in the
1972 output.
1974 \b Added the NASM environment variable.
1976 \b From this version forward, Win32 console-mode binaries will be
1977 included in the DOS distribution in addition to the 16-bit binaries.
1978 Added Makefile.vc for this purpose.
1980 \b Added `return 0;' to test/objlink.c to prevent compiler warnings.
1982 \b Added the __NASM_MAJOR__ and __NASM_MINOR__ standard defines.
1984 \b Added an alternative memory-reference syntax in which prefixing an
1985 operand with `&' is equivalent to enclosing it in square brackets,
1986 at the request of Fox Cutter.
1988 \b Errors in pass two now cause the program to return a non-zero error
1989 code, which they didn't before.
1991 \b Fixed the single-line macro cycle detection, which didn't work at
1992 all on macros with no parameters (caused an infinite loop). Also
1993 changed the behaviour of single-line macro cycle detection to work
1994 like cpp, so that macros like `extrn' as given in the documentation
1995 can be implemented.
1997 \b Fixed the implementation of WRT, which was too restrictive in that
1998 you couldn't do `mov ax,[di+abc wrt dgroup]' because (di+abc) wasn't
1999 a relocatable reference.
2002 \S{cl-0.94 released April 1997} Version 0.94 released April 1997
2005 \b Major item: added the macro processor.
2007 \b Added undocumented instructions SMI, IBTS, XBTS and LOADALL286. Also
2008 reorganised CMPXCHG instruction into early-486 and Pentium forms.
2009 Thanks to Thobias Jones for the information.
2011 \b Fixed two more stupid bugs in ELF, which were causing `ld' to
2012 continue to seg-fault in a lot of non-trivial cases.
2014 \b Fixed a seg-fault in the label manager.
2016 \b Stopped FBLD and FBSTP from _requiring_ the TWORD keyword, which is
2017 the only option for BCD loads/stores in any case.
2019 \b Ensured FLDCW, FSTCW and FSTSW can cope with the WORD keyword, if
2020 anyone bothers to provide it. Previously they complained unless no
2021 keyword at all was present.
2023 \b Some forms of FDIV/FDIVR and FSUB/FSUBR were still inverted: a
2024 vestige of a bug that I thought had been fixed in 0.92. This was
2025 fixed, hopefully for good this time...
2027 \b Another minor phase error (insofar as a phase error can _ever_ be
2028 minor) fixed, this one occurring in code of the form
2030 \c   rol ax,forward_reference
2031 \c   forward_reference equ 1
2033 \b The number supplied to TIMES is now sanity-checked for positivity,
2034 and also may be greater than 64K (which previously didn't work on
2035 16-bit systems).
2037 \b Added Watcom C makefiles, and misc/pmw.bat, donated by Dominik Behr.
2039 \b Added the INCBIN pseudo-opcode.
2041 \b Due to the advent of the preprocessor, the [INCLUDE] and [INC]
2042 directives have become obsolete. They are still supported in this
2043 version, with a warning, but won't be in the next.
2045 \b Fixed a bug in OBJ format, which caused incorrect object records to
2046 be output when absolute labels were made global.
2048 \b Updates to RDOFF subdirectory, and changes to outrdf.c.
2051 \S{cl-0.93 released January 1997} Version 0.93 released January 1997
2053 This release went out in a great hurry after semi-crippling bugs
2054 were found in 0.92.
2056 \b Really \e{did} fix the stack overflows this time. *blush*
2058 \b Had problems with EA instruction sizes changing between passes, when
2059 an offset contained a forward reference and so 4 bytes were
2060 allocated for the offset in pass one; by pass two the symbol had
2061 been defined and happened to be a small absolute value, so only 1
2062 byte got allocated, causing instruction size mismatch between passes
2063 and hence incorrect address calculations. Fixed.
2065 \b Stupid bug in the revised ELF section generation fixed (associated
2066 string-table section for .symtab was hard-coded as 7, even when this
2067 didn't fit with the real section table). Was causing `ld' to
2068 seg-fault under Linux.
2070 \b Included a new Borland C makefile, Makefile.bc2, donated by Fox
2071 Cutter <lmb@comtch.iea.com>.
2074 \S{cl-0.92 released January 1997} Version 0.92 released January 1997
2076 \b The FDIVP/FDIVRP and FSUBP/FSUBRP pairs had been inverted: this was
2077 fixed. This also affected the LCC driver.
2079 \b Fixed a bug regarding 32-bit effective addresses of the form
2080 \c{[other_register+ESP]}.
2082 \b Documentary changes, notably documentation of the fact that Borland
2083 Win32 compilers use `obj' rather than `win32' object format.
2085 \b Fixed the COMENT record in OBJ files, which was formatted
2086 incorrectly.
2088 \b Fixed a bug causing segfaults in large RDF files.
2090 \b OBJ format now strips initial periods from segment and group
2091 definitions, in order to avoid complications with the local label
2092 syntax.
2094 \b Fixed a bug in disassembling far calls and jumps in NDISASM.
2096 \b Added support for user-defined sections in COFF and ELF files.
2098 \b Compiled the DOS binaries with a sensible amount of stack, to
2099 prevent stack overflows on any arithmetic expression containing
2100 parentheses.
2102 \b Fixed a bug in handling of files that do not terminate in a newline.
2105 \S{cl-0.91 released November 1996} Version 0.91 released November 1996
2107 \b Loads of bug fixes.
2109 \b Support for RDF added.
2111 \b Support for DBG debugging format added.
2113 \b Support for 32-bit extensions to Microsoft OBJ format added.
2115 \b Revised for Borland C: some variable names changed, makefile added.
2117 \b LCC support revised to actually work.
2119 \b JMP/CALL NEAR/FAR notation added.
2121 \b `a16', `o16', `a32' and `o32' prefixes added.
2123 \b Range checking on short jumps implemented.
2125 \b MMX instruction support added.
2127 \b Negative floating point constant support added.
2129 \b Memory handling improved to bypass 64K barrier under DOS.
2131 \b \c{$} prefix to force treatment of reserved words as identifiers added.
2133 \b Default-size mechanism for object formats added.
2135 \b Compile-time configurability added.
2137 \b \c{#}, \c{@}, \c{~} and c\{?} are now valid characters in labels.
2139 \b \c{-e} and \c{-k} options in NDISASM added.
2142 \S{cl-0.90 released October 1996} Version 0.90 released October 1996
2144 First release version. First support for object file output. Other
2145 changes from previous version (0.3x) too numerous to document.