changes: document fixed crash on invalid UTF-8 sequences
[platform/upstream/nasm.git] / doc / changes.src
1 \#
2 \# NASM revision history in nasmdoc format
3 \#
4
5 \H{cl-2.xx} NASM 2 Series
6
7 The NASM 2 series support x86-64, and is the production version of NASM
8 since 2007.
9
10
11 \S{cl-2.07} Version 2.07
12
13 \b NASM is now under the 2-clause BSD license.  See \k{legal}.
14
15 \b Fix the section type for the \c{.strtab} section in the \c{elf64}
16   output format.
17
18 \b Fix the handling of \c{COMMON} directives in the \c{obj} output format.
19
20 \b New \c{ith} and \c{srec} output formats; these are variants of the
21   \c{bin} output format which output Intel hex and Motorola S-records,
22   respectively.  See \k{ithfmt} and \k{srecfmt}.
23
24 \b \c{rdf2ihx} replaced with an enhanced \c{rdf2bin}, which can output
25   binary, COM, Intel hex or Motorola S-records.
26
27 \b The Windows installer now puts the NASM directory first in the
28   \c{PATH} of the "NASM Shell".
29
30 \b Revert the early expansion behavior of \c{%+} to pre-2.06 behavior:
31   \c{%+} is only expanded late.
32
33 \b Yet another Mach-O alignment fix.
34
35 \b Don't delete the list file on errors.  Also, include error and
36   warning information in the list file.
37
38 \b Support for 64-bit Mach-O output, see \k{machofmt}.
39
40 \b Fix assert failure on certain operations that involve high-bit
41   characters that don't form valid UTF-8 sequences.
42
43
44 \S{cl-2.06} Version 2.06
45
46 \b This release is dedicated to the memory of Charles A. Crayne, long
47   time NASM developer as well as moderator of \c{comp.lang.asm.x86} and
48   author of the book \e{Serious Assembler}.  We miss you, Chuck.
49
50 \b Support for indirect macro expansion (\c{%[...]}).  See \k{indmacro}.
51
52 \b \c{%pop} can now take an argument, see \k{pushpop}.
53
54 \b The argument to \c{%use} is no longer macro-expanded.  Use
55   \c{%[...]} if macro expansion is desired.
56
57 \b Support for thread-local storage in ELF32 and ELF64.  See \k{elftls}.
58
59 \b Fix crash on \c{%ifmacro} without an argument.
60
61 \b Correct the arguments to the \c{POPCNT} instruction.
62
63 \b Fix section alignment in the Mach-O format.
64
65 \b Update AVX support to version 5 of the Intel specification.
66
67 \b Fix the handling of accesses to context-local macros from higher
68   levels in the context stack.
69
70 \b Treat \c{WAIT} as a prefix rather than as an instruction, thereby
71   allowing constructs like \c{O16 FSAVE} to work correctly.
72
73 \b Support for structures with a non-zero base offset. See \k{struc}.
74
75 \b Correctly handle preprocessor token concatenation (see \k{concat})
76    involving floating-point numbers.
77
78 \b The \c{PINSR} series of instructions have been corrected and
79    rationalized.
80
81 \b Removed AMD SSE5, replaced with the new XOP/FMA4/CVT16 (rev 3.03)
82    spec.
83
84 \b The ELF backends no longer automatically generate a \c{.comment} section.
85
86 \b Add additional "well-known" ELF sections with default attributes.  See
87    \k{elfsect}.
88
89
90 \S{cl-2.05.01} Version 2.05.01
91
92 \b Fix the \c{-w}/\c{-W} option parsing, which was broken in NASM 2.05.
93
94
95 \S{cl-2.05} Version 2.05
96
97 \b Fix redundant REX.W prefix on \c{JMP reg64}.
98
99 \b Make the behaviour of \c{-O0} match NASM 0.98 legacy behavior.
100   See \k{opt-O}.
101
102 \b \c{-w-user} can be used to suppress the output of \c{%warning} directives.
103   See \k{opt-w}.
104
105 \b Fix bug where \c{ALIGN} would issue a full alignment datum instead of
106   zero bytes.
107
108 \b Fix offsets in list files.
109
110 \b Fix \c{%include} inside multi-line macros or loops.
111
112 \b Fix error where NASM would generate a spurious warning on valid
113   optimizations of immediate values.
114
115 \b Fix arguments to a number of the \c{CVT} SSE instructions.
116
117 \b Fix RIP-relative offsets when the instruction carries an immediate.
118
119 \b Massive overhaul of the ELF64 backend for spec compliance.
120
121 \b Fix the Geode \c{PFRCPV} and \c{PFRSQRTV} instruction.
122
123 \b Fix the SSE 4.2 \c{CRC32} instruction.
124
125
126 \S{cl-2.04} Version 2.04
127
128 \b Sanitize macro handing in the \c{%error} directive.
129
130 \b New \c{%warning} directive to issue user-controlled warnings.
131
132 \b \c{%error} directives are now deferred to the final assembly phase.
133
134 \b New \c{%fatal} directive to immediately terminate assembly.
135
136 \b New \c{%strcat} directive to join quoted strings together.
137
138 \b New \c{%use} macro directive to support standard macro directives.  See
139   \k{use}.
140
141 \b Excess default parameters to \c{%macro} now issues a warning by default.
142   See \k{mlmacro}.
143
144 \b Fix \c{%ifn} and \c{%elifn}.
145
146 \b Fix nested \c{%else} clauses.
147
148 \b Correct the handling of nested \c{%rep}s.
149
150 \b New \c{%unmacro} directive to undeclare a multi-line macro.
151   See \k{unmacro}.
152
153 \b Builtin macro \c{__PASS__} which expands to the current assembly pass.
154   See \k{pass_macro}.
155
156 \b \c{__utf16__} and \c{__utf32__} operators to generate UTF-16 and UTF-32
157   strings.  See \k{unicode}.
158
159 \b Fix bug in case-insensitive matching when compiled on platforms that
160   don't use the \c{configure} script.  Of the official release binaries,
161   that only affected the OS/2 binary.
162
163 \b Support for x87 packed BCD constants.  See \k{bcdconst}.
164
165 \b Correct the \c{LTR} and \c{SLDT} instructions in 64-bit mode.
166
167 \b Fix unnecessary REX.W prefix on indirect jumps in 64-bit mode.
168
169 \b Add AVX versions of the AES instructions (\c{VAES}...).
170
171 \b Fix the 256-bit FMA instructions.
172
173 \b Add 256-bit AVX stores per the latest AVX spec.
174
175 \b VIA XCRYPT instructions can now be written either with or without
176   \c{REP}, apparently different versions of the VIA spec wrote them
177   differently.
178
179 \b Add missing 64-bit \c{MOVNTI} instruction.
180
181 \b Fix the operand size of \c{VMREAD} and \c{VMWRITE}.
182
183 \b Numerous bug fixes, especially to the AES, AVX and VTX instructions.
184
185 \b The optimizer now always runs until it converges.  It also runs even
186   when disabled, but doesn't optimize.  This allows most forward references
187   to be resolved properly.
188
189 \b \c{%push} no longer needs a context identifier; omitting the context
190   identifier results in an anonymous context.
191
192
193 \S{cl-2.03.01} Version 2.03.01
194
195 \b Fix buffer overflow in the listing module.
196
197 \b Fix the handling of hexadecimal escape codes in `...` strings.
198
199 \b The Postscript/PDF documentation has been reformatted.
200
201 \b The \c{-F} option now implies \c{-g}.
202
203
204 \S{cl-2.03} Version 2.03
205
206 \b Add support for Intel AVX, CLMUL and FMA instructions,
207 including YMM registers.
208
209 \b \c{dy}, \c{resy} and \c{yword} for 32-byte operands.
210
211 \b Fix some SSE5 instructions.
212
213 \b Intel \c{INVEPT}, \c{INVVPID} and \c{MOVBE} instructions.
214
215 \b Fix checking for critical expressions when the optimizer is enabled.
216
217 \b Support the DWARF debugging format for ELF targets.
218
219 \b Fix optimizations of signed bytes.
220
221 \b Fix operation on bigendian machines.
222
223 \b Fix buffer overflow in the preprocessor.
224
225 \b \c{SAFESEH} support for Win32, \c{IMAGEREL} for Win64 (SEH).
226
227 \b \c{%?} and \c{%??} to refer to the name of a macro itself.  In particular,
228 \c{%idefine keyword $%?} can be used to make a keyword "disappear".
229
230 \b New options for dependency generation: \c{-MD}, \c{-MF},
231 \c{-MP}, \c{-MT}, \c{-MQ}.
232
233 \b New preprocessor directives \c{%pathsearch} and \c{%depend}; INCBIN
234 reimplemented as a macro.
235
236 \b \c{%include} now resolves macros in a sane manner.
237
238 \b \c{%substr} can now be used to get other than one-character substrings.
239
240 \b New type of character/string constants, using backquotes (\c{`...`}),
241 which support C-style escape sequences.
242
243 \b \c{%defstr} and \c{%idefstr} to stringize macro definitions before
244 creation.
245
246 \b Fix forward references used in \c{EQU} statements.
247
248
249 \S{cl-2.02} Version 2.02
250
251 \b Additional fixes for MMX operands with explicit \c{qword}, as well as
252   (hopefully) SSE operands with \c{oword}.
253
254 \b Fix handling of truncated strings with \c{DO}.
255
256 \b Fix segfaults due to memory overwrites when floating-point constants
257   were used.
258
259 \b Fix segfaults due to missing include files.
260
261 \b Fix OpenWatcom Makefiles for DOS and OS/2.
262
263 \b Add autogenerated instruction list back into the documentation.
264
265 \b ELF: Fix segfault when generating stabs, and no symbols have been
266   defined.
267
268 \b ELF: Experimental support for DWARF debugging information.
269
270 \b New compile date and time standard macros.
271
272 \b \c{%ifnum} now returns true for negative numbers.
273
274 \b New \c{%iftoken} test for a single token.
275
276 \b New \c{%ifempty} test for empty expansion.
277
278 \b Add support for the \c{XSAVE} instruction group.
279
280 \b Makefile for Netware/gcc.
281
282 \b Fix issue with some warnings getting emitted way too many times.
283
284 \b Autogenerated instruction list added to the documentation.
285
286
287 \S{cl-2.01} Version 2.01
288
289 \b Fix the handling of MMX registers with explicit \c{qword} tags on
290   memory (broken in 2.00 due to 64-bit changes.)
291
292 \b Fix the PREFETCH instructions.
293
294 \b Fix the documentation.
295
296 \b Fix debugging info when using \c{-f elf}
297 (backwards compatibility alias for \c{-f elf32}).
298
299 \b Man pages for rdoff tools (from the Debian project.)
300
301 \b ELF: handle large numbers of sections.
302
303 \b Fix corrupt output when the optimizer runs out of passes.
304
305
306 \S{cl-2.00} Version 2.00
307
308 \b Added c99 data-type compliance.
309
310 \b Added general x86-64 support.
311
312 \b Added win64 (x86-64 COFF) output format.
313
314 \b Added \c{__BITS__} standard macro.
315
316 \b Renamed the \c{elf} output format to \c{elf32} for clarity.
317
318 \b Added \c{elf64} and \c{macho} (MacOS X) output formats.
319
320 \b Added Numeric constants in \c{dq} directive.
321
322 \b Added \c{oword}, \c{do} and \c{reso} pseudo operands.
323
324 \b Allow underscores in numbers.
325
326 \b Added 8-, 16- and 128-bit floating-point formats.
327
328 \b Added binary, octal and hexadecimal floating-point.
329
330 \b Correct the generation of floating-point constants.
331
332 \b Added floating-point option control.
333
334 \b Added Infinity and NaN floating point support.
335
336 \b Added ELF Symbol Visibility support.
337
338 \b Added setting OSABI value in ELF header directive.
339
340 \b Added Generate Makefile Dependencies option.
341
342 \b Added Unlimited Optimization Passes option.
343
344 \b Added \c{%IFN} and \c{%ELIFN} support.
345
346 \b Added Logical Negation Operator.
347
348 \b Enhanced Stack Relative Preprocessor Directives.
349
350 \b Enhanced ELF Debug Formats.
351
352 \b Enhanced Send Errors to a File option.
353
354 \b Added SSSE3, SSE4.1, SSE4.2, SSE5 support.
355
356 \b Added a large number of additional instructions.
357
358 \b Significant performance improvements.
359
360 \b \c{-w+warning} and \c{-w-warning} can now be written as -Wwarning and
361  -Wno-warning, respectively.  See \k{opt-w}.
362
363 \b Add \c{-w+error} to treat warnings as errors.  See \k{opt-w}.
364
365 \b Add \c{-w+all} and \c{-w-all} to enable or disable all suppressible
366  warnings.  See \k{opt-w}.
367
368
369 \H{cl-0.98.xx} NASM 0.98 Series
370
371 The 0.98 series was the production versions of NASM from 1999 to 2007.
372
373
374 \S{cl-0.98.39} Version 0.98.39
375
376 \b fix buffer overflow
377
378 \b fix outas86's \c{.bss} handling
379
380 \b "make spotless" no longer deletes config.h.in.
381
382 \b \c{%(el)if(n)idn} insensitivity to string quotes difference (#809300).
383
384 \b (nasm.c)\c{__OUTPUT_FORMAT__} changed to string value instead of symbol.
385
386 \S{cl-0.98.38} Version 0.98.38
387
388
389 \b Add Makefile for 16-bit DOS binaries under OpenWatcom, and modify
390   \c{mkdep.pl} to be able to generate completely pathless dependencies, as
391   required by OpenWatcom wmake (it supports path searches, but not
392   explicit paths.)
393
394 \b Fix the \c{STR} instruction.
395
396 \b Fix the ELF output format, which was broken under certain
397   circumstances due to the addition of stabs support.
398
399 \b Quick-fix Borland format debug-info for \c{-f obj}
400
401 \b Fix for \c{%rep} with no arguments (#560568)
402
403 \b Fix concatenation of preprocessor function call (#794686)
404
405 \b Fix long label causes coredump (#677841)
406
407 \b Use autoheader as well as autoconf to keep configure from generating
408   ridiculously long command lines.
409
410 \b Make sure that all of the formats which support debugging output
411   actually will suppress debugging output when \c{-g} not specified.
412
413 \S{cl-0.98.37} Version 0.98.37
414
415
416 \b Paths given in \c{-I} switch searched for \c{incbin}-ed as
417   well as \c{%include}-ed files.
418
419 \b Added stabs debugging for the ELF output format, patch from
420   Martin Wawro.
421
422 \b Fix \c{output/outbin.c} to allow origin > 80000000h.
423
424 \b Make \c{-U} switch work.
425
426 \b Fix the use of relative offsets with explicit prefixes, e.g.
427 \c{a32 loop foo}.
428
429 \b Remove \c{backslash()}.
430
431 \b Fix the \c{SMSW} and \c{SLDT} instructions.
432
433 \b \c{-O2} and \c{-O3} are no longer aliases for \c{-O10} and \c{-O15}.
434 If you mean the latter, please say so! :)
435
436 \S{cl-0.98.36} Version 0.98.36
437
438
439 \b Update rdoff - librarian/archiver - common rec - docs!
440
441 \b Fix signed/unsigned problems.
442
443 \b Fix \c{JMP FAR label} and \c{CALL FAR label}.
444
445 \b Add new multisection support - map files - fix align bug
446
447 \b Fix sysexit, movhps/movlps reg,reg bugs in insns.dat
448
449 \b \c{Q} or \c{O} suffixes indicate octal
450
451 \b Support Prescott new instructions (PNI).
452
453 \b Cyrix \c{XSTORE} instruction.
454
455
456 \S{cl-0.98.35} Version 0.98.35
457
458 \b Fix build failure on 16-bit DOS (Makefile.bc3 workaround for compiler bug.)
459
460 \b Fix dependencies and compiler warnings.
461
462 \b Add "const" in a number of places.
463
464 \b Add -X option to specify error reporting format (use -Xvc to
465   integrate with Microsoft Visual Studio.)
466
467 \b Minor changes for code legibility.
468
469 \b Drop use of tmpnam() in rdoff (security fix.)
470
471
472 \S{cl-0.98.34} Version 0.98.34
473
474 \b Correct additional address-size vs. operand-size confusions.
475
476 \b Generate dependencies for all Makefiles automatically.
477
478 \b Add support for unimplemented (but theoretically available)
479   registers such as tr0 and cr5.  Segment registers 6 and 7 are called
480   segr6 and segr7 for the operations which they can be represented.
481
482 \b Correct some disassembler bugs related to redundant address-size prefixes.
483   Some work still remains in this area.
484
485 \b Correctly generate an error for things like "SEG eax".
486
487 \b Add the JMPE instruction, enabled by "CPU IA64".
488
489 \b Correct compilation on newer gcc/glibc platforms.
490
491 \b Issue an error on things like "jmp far eax".
492
493
494 \S{cl-0.98.33} Version 0.98.33
495
496 \b New __NASM_PATCHLEVEL__ and __NASM_VERSION_ID__ standard macros to
497   round out the version-query macros.  version.pl now understands
498   X.YYplWW or X.YY.ZZplWW as a version number, equivalent to
499   X.YY.ZZ.WW (or X.YY.0.WW, as appropriate).
500
501 \b New keyword "strict" to disable the optimization of specific
502   operands.
503
504 \b Fix the handing of size overrides with JMP instructions
505   (instructions such as "jmp dword foo".)
506
507 \b Fix the handling of "ABSOLUTE label", where "label" points into a
508   relocatable segment.
509
510 \b Fix OBJ output format with lots of externs.
511
512 \b More documentation updates.
513
514 \b Add -Ov option to get verbose information about optimizations.
515
516 \b Undo a braindead change which broke \c{%elif} directives.
517
518 \b Makefile updates.
519
520
521 \S{cl-0.98.32} Version 0.98.32
522
523 \b Fix NASM crashing when \c{%macro} directives were left unterminated.
524
525 \b Lots of documentation updates.
526
527 \b Complete rewrite of the PostScript/PDF documentation generator.
528
529 \b The MS Visual C++ Makefile was updated and corrected.
530
531 \b Recognize .rodata as a standard section name in ELF.
532
533 \b Fix some obsolete Perl4-isms in Perl scripts.
534
535 \b Fix configure.in to work with autoconf 2.5x.
536
537 \b Fix a couple of "make cleaner" misses.
538
539 \b Make the normal "./configure && make" work with Cygwin.
540
541
542 \S{cl-0.98.31} Version 0.98.31
543
544 \b Correctly build in a separate object directory again.
545
546 \b Derive all references to the version number from the version file.
547
548 \b New standard macros __NASM_SUBMINOR__ and __NASM_VER__ macros.
549
550 \b Lots of Makefile updates and bug fixes.
551
552 \b New \c{%ifmacro} directive to test for multiline macros.
553
554 \b Documentation updates.
555
556 \b Fixes for 16-bit OBJ format output.
557
558 \b Changed the NASM environment variable to NASMENV.
559
560
561 \S{cl-0.98.30} Version 0.98.30
562
563 \b Changed doc files a lot: completely removed old READMExx and
564   Wishlist files, incorporating all information in CHANGES and TODO.
565
566 \b I waited a long time to rename zoutieee.c to (original) outieee.c
567
568 \b moved all output modules to output/ subdirectory.
569
570 \b Added 'make strip' target to strip debug info from nasm & ndisasm.
571
572 \b Added INSTALL file with installation instructions.
573
574 \b Added -v option description to nasm man.
575
576 \b Added dist makefile target to produce source distributions.
577
578 \b 16-bit support for ELF output format (GNU extension, but useful.)
579
580
581 \S{cl-0.98.28} Version 0.98.28
582
583 \b Fastcooked this for Debian's Woody release:
584 Frank applied the INCBIN bug patch to 0.98.25alt and called
585 it 0.98.28 to not confuse poor little apt-get.
586
587
588 \S{cl-0.98.26} Version 0.98.26
589
590 \b Reorganised files even better from 0.98.25alt
591
592
593 \S{cl-0.98.25alt} Version 0.98.25alt
594
595 \b Prettified the source tree. Moved files to more reasonable places.
596
597 \b Added findleak.pl script to misc/ directory.
598
599 \b Attempted to fix doc.
600
601
602 \S{cl-0.98.25} Version 0.98.25
603
604 \b Line continuation character \c{\\}.
605
606 \b Docs inadvertantly reverted - "dos packaging".
607
608
609 \S{cl-0.98.24p1} Version 0.98.24p1
610
611 \b FIXME: Someone, document this please.
612
613
614 \S{cl-0.98.24} Version 0.98.24
615
616 \b Documentation - Ndisasm doc added to Nasm.doc.
617
618
619 \S{cl-0.98.23} Version 0.98.23
620
621 \b Attempted to remove rdoff version1
622
623 \b Lino Mastrodomenico's patches to preproc.c (%$$ bug?).
624
625
626 \S{cl-0.98.22} Version 0.98.22
627
628 \b Update rdoff2 - attempt to remove v1.
629
630
631 \S{cl-0.98.21} Version 0.98.21
632
633 \b Optimization fixes.
634
635
636 \S{cl-0.98.20} Version 0.98.20
637
638 \b Optimization fixes.
639
640
641 \S{cl-0.98.19} Version 0.98.19
642
643 \b H. J. Lu's patch back out.
644
645
646 \S{cl-0.98.18} Version 0.98.18
647
648 \b Added ".rdata" to "-f win32".
649
650
651 \S{cl-0.98.17} Version 0.98.17
652
653 \b H. J. Lu's "bogus elf" patch. (Red Hat problem?)
654
655
656 \S{cl-0.98.16} Version 0.98.16
657
658 \b Fix whitespace before "[section ..." bug.
659
660
661 \S{cl-0.98.15} Version 0.98.15
662
663 \b Rdoff changes (?).
664
665 \b Fix fixes to memory leaks.
666
667
668 \S{cl-0.98.14} Version 0.98.14
669
670 \b Fix memory leaks.
671
672
673 \S{cl-0.98.13} Version 0.98.13
674
675 \b There was no 0.98.13
676
677
678 \S{cl-0.98.12} Version 0.98.12
679
680 \b Update optimization (new function of "-O1")
681
682 \b Changes to test/bintest.asm (?).
683
684
685 \S{cl-0.98.11} Version 0.98.11
686
687 \b Optimization changes.
688
689 \b Ndisasm fixed.
690
691
692 \S{cl-0.98.10} Version 0.98.10
693
694 \b There was no 0.98.10
695
696
697 \S{cl-0.98.09} Version 0.98.09
698
699 \b Add multiple sections support to "-f bin".
700
701 \b Changed GLOBAL_TEMP_BASE in outelf.c from 6 to 15.
702
703 \b Add "-v" as an alias to the "-r" switch.
704
705 \b Remove "#ifdef" from Tasm compatibility options.
706
707 \b Remove redundant size-overrides on "mov ds, ex", etc.
708
709 \b Fixes to SSE2, other insns.dat (?).
710
711 \b Enable uppercase "I" and "P" switches.
712
713 \b Case insinsitive "seg" and "wrt".
714
715 \b Update install.sh (?).
716
717 \b Allocate tokens in blocks.
718
719 \b Improve "invalid effective address" messages.
720
721
722 \S{cl-0.98.08} Version 0.98.08
723
724 \b Add "\c{%strlen}" and "\c{%substr}" macro operators
725
726 \b Fixed broken c16.mac.
727
728 \b Unterminated string error reported.
729
730 \b Fixed bugs as per 0.98bf
731
732
733 \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
734
735 Changes from 0.98.07 release to 98.09b as of 28-Oct-2001
736
737 \b More closely compatible with 0.98 when -O0 is implied
738 or specified.  Not strictly identical, since backward 
739 branches in range of short offsets are recognized, and signed
740 byte values with no explicit size specification will be
741 assembled as a single byte.
742
743 \b More forgiving with the PUSH instruction.  0.98 requires
744 a size to be specified always.  0.98.09b will imply the size
745 from the current BITS setting (16 or 32).
746
747 \b Changed definition of the optimization flag:
748
749         -O0     strict two-pass assembly, JMP and Jcc are
750                 handled more like 0.98, except that back-
751                 ward JMPs are short, if possible.
752
753         -O1     strict two-pass assembly, but forward
754                 branches are assembled with code guaranteed
755                 to reach; may produce larger code than
756                 -O0, but will produce successful assembly
757                 more often if branch offset sizes are not
758                 specified.
759
760         -O2     multi-pass optimization, minimize branch
761                 offsets; also will minimize signed immed-
762                 iate bytes, overriding size specification.
763
764         -O3     like -O2, but more passes taken, if needed
765
766
767 \S{cl-0.98.07 released 01/28/01} Version 0.98.07 released 01/28/01
768
769 \b       Added Stepane Denis' SSE2 instructions to a *working*
770         version of the code - some earlier versions were based on
771         broken code - sorry 'bout that. version "0.98.07"
772
773
774 01/28/01
775
776
777 \b       Cosmetic modifications to nasm.c, nasm.h,
778         AUTHORS, MODIFIED
779
780
781 \S{cl-0.98.06f released 01/18/01} Version 0.98.06f released 01/18/01
782
783
784 \b       - Add "metalbrain"s jecxz bug fix in insns.dat
785         - alter nasmdoc.src to match - version "0.98.06f"
786
787
788 \S{cl-0.98.06e released 01/09/01} Version 0.98.06e released 01/09/01
789
790
791 \b       Removed the "outforms.h" file - it appears to be
792         someone's old backup of "outform.h". version "0.98.06e" 
793
794 01/09/01
795
796 \b fbk - finally added the fix for the "multiple %includes bug",
797         known since 7/27/99 - reported originally (?) and sent to
798         us by Austin Lunnen - he reports that John Fine had a fix
799         within the day. Here it is...
800
801 \b Nelson Rush resigns from the group. Big thanks to Nelson for
802   his leadership and enthusiasm in getting these changes
803   incorporated into Nasm!
804
805 \b fbk - [list +], [list -] directives - ineptly implemented, should
806         be re-written or removed, perhaps.
807
808 \b Brian Raiter / fbk - "elfso bug" fix - applied to aoutb format
809                        as well - testing might be desirable...
810
811 08/07/00
812
813 \b James Seter - -postfix, -prefix command line switches.
814
815 \b Yuri Zaporogets - rdoff utility changes.
816
817
818 \S{cl-0.98p1} Version 0.98p1
819
820 \b GAS-like palign (Panos Minos)
821
822 \b FIXME: Someone, fill this in with details
823
824
825 \S{cl-0.98bf (bug-fixed)} Version 0.98bf (bug-fixed)
826
827 \b Fixed - elf and aoutb bug - shared libraries
828         - multiple "%include" bug in "-f obj"   
829         - jcxz, jecxz bug
830         - unrecognized option bug in ndisasm 
831
832 \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
833
834 \b Added signed byte optimizations for the 0x81/0x83 class
835 of instructions: ADC, ADD, AND, CMP, OR, SBB, SUB, XOR:
836 when used as 'ADD reg16,imm' or 'ADD reg32,imm.'  Also
837 optimization of signed byte form of 'PUSH imm' and 'IMUL
838 reg,imm'/'IMUL reg,reg,imm.'  No size specification is needed.
839
840 \b Added multi-pass JMP and Jcc offset optimization.  Offsets
841 on forward references will preferentially use the short form,
842 without the need to code a specific size (short or near) for
843 the branch.  Added instructions for 'Jcc label' to use the
844 form 'Jnotcc $+3/JMP label', in cases where a short offset
845 is out of bounds.  If compiling for a 386 or higher CPU, then
846 the 386 form of Jcc will be used instead.
847
848 This feature is controlled by a new command-line switch: "O",
849 (upper case letter O).  "-O0" reverts the assembler to no
850 extra optimization passes, "-O1" allows up to 5 extra passes,
851 and "-O2"(default), allows up to 10 extra optimization passes.
852
853 \b Added a new directive:  'cpu XXX', where XXX is any of: 
854 8086, 186, 286, 386, 486, 586, pentium, 686, PPro, P2, P3 or
855 Katmai.  All are case insensitive.  All instructions will
856 be selected only if they apply to the selected cpu or lower.
857 Corrected a couple of bugs in cpu-dependence in 'insns.dat'.
858
859 \b Added to 'standard.mac', the "use16" and "use32" forms of
860 the "bits 16/32" directive. This is nothing new, just conforms
861 to a lot of other assemblers. (minor)
862
863 \b Changed label allocation from 320/32 (10000 labels @ 200K+) 
864 to 32/37 (1000 labels); makes running under DOS much easier.
865 Since additional label space is allocated dynamically, this
866 should have no effect on large programs with lots of labels.
867 The 37 is a prime, believed to be better for hashing. (minor)
868
869
870 \S{cl-0.98.03} Version 0.98.03
871
872 "Integrated patchfile 0.98-0.98.01.  I call this version 0.98.03 for
873 historical reasons: 0.98.02 was trashed." --John Coffman
874 <johninsd@san.rr.com>, 27-Jul-2000
875
876 \b Kendall Bennett's SciTech MGL changes
877
878 \b Note that you must define "TASM_COMPAT" at compile-time
879 to get the Tasm Ideal Mode compatibility.
880
881 \b All changes can be compiled in and out using the TASM_COMPAT macros,
882 and when compiled without TASM_COMPAT defined we get the exact same
883 binary as the unmodified 0.98 sources.
884
885 \b standard.mac, macros.c: Added macros to ignore TASM directives before
886 first include
887
888 \b nasm.h: Added extern declaration for tasm_compatible_mode
889
890 \b nasm.c: Added global variable tasm_compatible_mode
891
892 \b Added command line switch for TASM compatible mode (-t)
893
894 \b Changed version command line to reflect when compiled with TASM additions
895
896 \b Added response file processing to allow all arguments on a single
897 line (response file is @resp rather than -@resp for NASM format).
898
899 \b labels.c: Changes islocal() macro to support TASM style @@local labels.
900
901 \b Added islocalchar() macro to support TASM style @@local labels.
902
903 \b parser.c: Added support for TASM style memory references (ie: mov
904 [DWORD eax],10 rather than the NASM style mov DWORD [eax],10).
905
906 \b preproc.c: Added new directives, \c{%arg}, \c{%local}, \c{%stacksize} to directives
907 table
908
909 \b Added support for TASM style directives without a leading % symbol.
910
911 \b Integrated a block of changes from Andrew Zabolotny <bit@eltech.ru>:
912
913 \b A new keyword \c{%xdefine} and its case-insensitive counterpart \c{%ixdefine}.
914 They work almost the same way as \c{%define} and \c{%idefine} but expand
915 the definition immediately, not on the invocation. Something like a cross
916 between \c{%define} and \c{%assign}. The "x" suffix stands for "eXpand", so
917 "xdefine" can be deciphered as "expand-and-define". Thus you can do
918 things like this:
919
920 \c      %assign ofs     0
921 \c
922 \c      %macro  arg     1
923 \c              %xdefine %1 dword [esp+ofs]
924 \c              %assign ofs ofs+4
925 \c      %endmacro
926
927 \b Changed the place where the expansion of %$name macros are expanded.
928 Now they are converted into ..@ctxnum.name form when detokenizing, so
929 there are no quirks as before when using %$name arguments to macros,
930 in macros etc. For example:
931
932 \c      %macro  abc     1
933 \c              %define %1 hello
934 \c      %endm
935 \c
936 \c      abc     %$here
937 \c      %$here
938
939     Now last line will be expanded into "hello" as expected. This also allows
940     for lots of goodies, a good example are extended "proc" macros included
941     in this archive.
942
943 \b Added a check for "cstk" in smacro_defined() before calling get_ctx() -
944     this allows for things like:
945
946 \c      %ifdef %$abc
947 \c      %endif
948
949     to work without warnings even in no context.
950
951 \b Added a check for "cstk" in %if*ctx and %elif*ctx directives -
952     this allows to use \c{%ifctx} without excessive warnings. If there is
953     no active context, \c{%ifctx} goes through "false" branch.
954
955 \b Removed "user error: " prefix with \c{%error} directive: it just clobbers the
956     output and has absolutely no functionality. Besides, this allows to write
957     macros that does not differ from built-in functions in any way.
958
959 \b Added expansion of string that is output by \c{%error} directive. Now you
960     can do things like:
961
962 \c      %define hello(x) Hello, x!
963 \c
964 \c      %define %$name andy
965 \c      %error "hello(%$name)"
966
967     Same happened with \c{%include} directive.
968
969 \b Now all directives that expect an identifier will try to expand and
970     concatenate everything without whitespaces in between before usage.
971     For example, with "unfixed" nasm the commands
972
973 \c      %define %$abc hello
974 \c      %define __%$abc goodbye
975 \c      __%$abc
976
977     would produce "incorrect" output: last line will expand to
978
979 \c      hello goodbyehello
980
981     Not quite what you expected, eh? :-) The answer is that preprocessor
982     treats the \c{%define} construct as if it would be
983
984 \c      %define __ %$abc goodbye
985
986     (note the white space between __ and %$abc). After my "fix" it
987     will "correctly" expand into
988
989 \c      goodbye
990
991     as expected. Note that I use quotes around words "correct", "incorrect"
992     etc because this is rather a feature not a bug; however current behaviour
993     is more logical (and allows more advanced macro usage :-).
994
995     Same change was applied to:
996         \c{%push},\c{%macro},\c{%imacro},\c{%define},\c{%idefine},\c{%xdefine},\c{%ixdefine},
997         \c{%assign},\c{%iassign},\c{%undef}
998
999 \b A new directive [WARNING {+|-}warning-id] have been added. It works only
1000     if the assembly phase is enabled (i.e. it doesn't work with nasm -e).
1001
1002 \b A new warning type: macro-selfref. By default this warning is disabled;
1003     when enabled NASM warns when a macro self-references itself; for example
1004     the following source:
1005
1006 \c        [WARNING macro-selfref]
1007 \c
1008 \c        %macro          push    1-*
1009 \c                %rep    %0
1010 \c                        push    %1
1011 \c                        %rotate 1
1012 \c                %endrep
1013 \c        %endmacro
1014 \c
1015 \c                        push    eax,ebx,ecx
1016
1017     will produce a warning, but if we remove the first line we won't see it
1018     anymore (which is The Right Thing To Do {tm} IMHO since C preprocessor
1019     eats such constructs without warnings at all).
1020
1021 \b Added a "error" routine to preprocessor which always will set ERR_PASS1
1022     bit in severity_code. This removes annoying repeated errors on first
1023     and second passes from preprocessor.
1024
1025 \b Added the %+ operator in single-line macros for concatenating two
1026     identifiers. Usage example:
1027
1028 \c        %define _myfunc _otherfunc
1029 \c        %define cextern(x) _ %+ x
1030 \c        cextern (myfunc)
1031
1032     After first expansion, third line will become "_myfunc". After this
1033     expansion is performed again so it becomes "_otherunc".
1034
1035 \b Now if preprocessor is in a non-emitting state, no warning or error
1036     will be emitted. Example:
1037
1038 \c        %if 1
1039 \c                mov     eax,ebx
1040 \c        %else
1041 \c                put anything you want between these two brackets,
1042 \c                even macro-parameter references %1 or local
1043 \c                labels %$zz or macro-local labels %%zz - no
1044 \c                warning will be emitted.
1045 \c        %endif
1046
1047 \b Context-local variables on expansion as a last resort are looked up
1048     in outer contexts. For example, the following piece:
1049
1050 \c        %push   outer
1051 \c        %define %$a [esp]
1052 \c
1053 \c                %push   inner
1054 \c                %$a
1055 \c                %pop
1056 \c        %pop
1057
1058     will expand correctly the fourth line to [esp]; if we'll define another
1059     %$a inside the "inner" context, it will take precedence over outer
1060     definition. However, this modification has been applied only to
1061     expand_smacro and not to smacro_define: as a consequence expansion
1062     looks in outer contexts, but \c{%ifdef} won't look in outer contexts.
1063
1064     This behaviour is needed because we don't want nested contexts to
1065     act on already defined local macros. Example:
1066
1067 \c        %define %$arg1  [esp+4]
1068 \c        test    eax,eax
1069 \c        if      nz
1070 \c                mov     eax,%$arg1
1071 \c        endif
1072
1073     In this example the "if" mmacro enters into the "if" context, so %$arg1
1074     is not valid anymore inside "if". Of course it could be worked around
1075     by using explicitely %$$arg1 but this is ugly IMHO.
1076
1077 \b Fixed memory leak in \c{%undef}. The origline wasn't freed before
1078     exiting on success.
1079
1080 \b Fixed trap in preprocessor when line expanded to empty set of tokens.
1081     This happens, for example, in the following case:
1082
1083 \c        #define SOMETHING
1084 \c        SOMETHING
1085
1086
1087 \S{cl-0.98} Version 0.98
1088
1089 All changes since NASM 0.98p3 have been produced by H. Peter Anvin <hpa@zytor.com>.
1090
1091 \b The documentation comment delimiter is \# not #.
1092
1093 \b Allow EQU definitions to refer to external labels; reported by
1094   Pedro Gimeno.
1095
1096 \b Re-enable support for RDOFF v1; reported by Pedro Gimeno.
1097
1098 \b Updated License file per OK from Simon and Julian.
1099
1100
1101 \S{cl-0.98p9} Version 0.98p9
1102
1103 \b Update documentation (although the instruction set reference will
1104   have to wait; I don't want to hold up the 0.98 release for it.)
1105
1106 \b Verified that the NASM implementation of the PEXTRW and PMOVMSKB
1107   instructions is correct.  The encoding differs from what the Intel
1108   manuals document, but the Pentium III behaviour matches NASM, not
1109   the Intel manuals.
1110
1111 \b Fix handling of implicit sizes in PSHUFW and PINSRW, reported by
1112   Stefan Hoffmeister.
1113
1114 \b Resurrect the -s option, which was removed when changing the
1115   diagnostic output to stdout.
1116
1117
1118 \S{cl-0.98p8} Version 0.98p8
1119
1120 \b Fix for "DB" when NASM is running on a bigendian machine.
1121
1122 \b Invoke insns.pl once for each output script, making Makefile.in
1123   legal for "make -j".
1124
1125 \b Improve the Unix configure-based makefiles to make package
1126   creation easier.
1127
1128 \b Included an RPM .spec file for building RPM (RedHat Package Manager)
1129   packages on Linux or Unix systems.
1130
1131 \b Fix Makefile dependency problems.
1132
1133 \b Change src/rdsrc.pl to include sectioning information in info
1134   output; required for install-info to work.
1135
1136 \b Updated the RDOFF distribution to version 2 from Jules; minor
1137   massaging to make it compile in my environment.
1138
1139 \b Split doc files that can be built by anyone with a Perl interpreter off
1140   into a separate archive.
1141
1142 \b "Dress rehearsal" release!
1143
1144
1145 \S{cl-0.98p7} Version 0.98p7
1146
1147 \b Fixed opcodes with a third byte-sized immediate argument to not
1148   complain if given "byte" on the immediate.
1149
1150 \b Allow \c{%undef} to remove single-line macros with arguments.  This
1151   matches the behaviour of #undef in the C preprocessor.
1152
1153 \b Allow -d, -u, -i and -p to be specified as -D, -U, -I and -P for
1154   compatibility with most C compilers and preprocessors.  This allows
1155   Makefile options to be shared between cc and nasm, for example.
1156
1157 \b Minor cleanups.
1158
1159 \b Went through the list of Katmai instructions and hopefully fixed the
1160   (rather few) mistakes in it.
1161
1162 \b (Hopefully) fixed a number of disassembler bugs related to ambiguous
1163   instructions (disambiguated by -p) and SSE instructions with REP.
1164
1165 \b Fix for bug reported by Mark Junger: "call dword 0x12345678" should
1166   work and may add an OSP (affected CALL, JMP, Jcc).
1167
1168 \b Fix for environments when "stderr" isn't a compile-time constant.
1169
1170
1171 \S{cl-0.98p6} Version 0.98p6
1172
1173
1174 \b Took officially over coordination of the 0.98 release; so drop
1175   the p3.x notation. Skipped p4 and p5 to avoid confusion with John
1176   Fine's J4 and J5 releases.
1177
1178 \b Update the documentation; however, it still doesn't include
1179   documentation for the various new instructions.  I somehow wonder if
1180   it makes sense to have an instruction set reference in the assembler
1181   manual when Intel et al have PDF versions of their manuals online.
1182
1183 \b Recognize "idt" or "centaur" for the -p option to ndisasm.
1184
1185 \b Changed error messages back to stderr where they belong, but add an
1186   -E option to redirect them elsewhere (the DOS shell cannot redirect
1187   stderr.)
1188
1189 \b -M option to generate Makefile dependencies (based on code from Alex
1190   Verstak.)
1191
1192 \b \c{%undef} preprocessor directive, and -u option, that undefines a
1193   single-line macro.
1194
1195 \b OS/2 Makefile (Mkfiles/Makefile.os2) for Borland under OS/2; from
1196   Chuck Crayne.
1197
1198 \b Various minor bugfixes (reported by):
1199   - Dangling \c{%s} in preproc.c (Martin Junker)
1200
1201 \b THERE ARE KNOWN BUGS IN SSE AND THE OTHER KATMAI INSTRUCTIONS.  I am
1202   on a trip and didn't bring the Katmai instruction reference, so I
1203   can't work on them right now.
1204
1205 \b Updated the License file per agreement with Simon and Jules to
1206   include a GPL distribution clause.
1207
1208
1209 \S{cl-0.98p3.7} Version 0.98p3.7
1210
1211 \b (Hopefully) fixed the canned Makefiles to include the outrdf2 and
1212   zoutieee modules.
1213
1214 \b Renamed changes.asm to changed.asm.
1215
1216
1217 \S{cl-0.98p3.6} Version 0.98p3.6
1218
1219 \b Fixed a bunch of instructions that were added in 0.98p3.5 which had
1220   memory operands, and the address-size prefix was missing from the
1221   instruction pattern.
1222
1223
1224 \S{cl-0.98p3.5} Version 0.98p3.5
1225
1226 \b Merged in changes from John S. Fine's 0.98-J5 release.  John's based
1227   0.98-J5 on my 0.98p3.3 release; this merges the changes.
1228
1229 \b Expanded the instructions flag field to a long so we can fit more
1230   flags; mark SSE (KNI) and AMD or Katmai-specific instructions as
1231   such.
1232
1233 \b Fix the "PRIV" flag on a bunch of instructions, and create new
1234   "PROT" flag for protected-mode-only instructions (orthogonal to if
1235   the instruction is privileged!) and new "SMM" flag for SMM-only
1236   instructions.
1237
1238 \b Added AMD-only SYSCALL and SYSRET instructions.
1239
1240 \b Make SSE actually work, and add new Katmai MMX instructions.
1241
1242 \b Added a -p (preferred vendor) option to ndisasm so that it can
1243   distinguish e.g. Cyrix opcodes also used in SSE.  For example:
1244
1245 \c      ndisasm -p cyrix aliased.bin
1246 \c      00000000  670F514310        paddsiw mm0,[ebx+0x10]
1247 \c      00000005  670F514320        paddsiw mm0,[ebx+0x20]
1248 \c      ndisasm -p intel aliased.bin
1249 \c      00000000  670F514310        sqrtps xmm0,[ebx+0x10]
1250 \c      00000005  670F514320        sqrtps xmm0,[ebx+0x20]
1251
1252 \b Added a bunch of Cyrix-specific instructions.
1253
1254
1255 \S{cl-0.98p3.4} Version 0.98p3.4
1256
1257 \b Made at least an attempt to modify all the additional Makefiles (in
1258   the Mkfiles directory).  I can't test it, but this was the best I
1259   could do.
1260
1261 \b DOS DJGPP+"Opus Make" Makefile from John S. Fine.
1262
1263 \b changes.asm changes from John S. Fine.
1264
1265
1266 \S{cl-0.98p3.3} Version 0.98p3.3
1267
1268 \b Patch from Conan Brink to allow nesting of \c{%rep} directives.
1269
1270 \b If we're going to allow INT01 as an alias for INT1/ICEBP (one of
1271   Jules 0.98p3 changes), then we should allow INT03 as an alias for INT3
1272   as well.
1273
1274 \b Updated changes.asm to include the latest changes.
1275
1276 \b Tried to clean up the <CR>s that had snuck in from a DOS/Windows
1277   environment into my Unix environment, and try to make sure than
1278   DOS/Windows users get them back.
1279
1280 \b We would silently generate broken tools if insns.dat wasn't sorted
1281   properly.  Change insns.pl so that the order doesn't matter.
1282
1283 \b Fix bug in insns.pl (introduced by me) which would cause conditional
1284   instructions to have an extra "cc" in disassembly, e.g. "jnz"
1285   disassembled as "jccnz".
1286
1287
1288 \S{cl-0.98p3.2} Version 0.98p3.2
1289
1290 \b Merged in John S. Fine's changes from his 0.98-J4 prerelease; see
1291   http://www.csoft.net/cz/johnfine/
1292
1293 \b Changed previous "spotless" Makefile target (appropriate for distribution)
1294   to "distclean", and added "cleaner" target which is same as "clean"
1295   except deletes files generated by Perl scripts; "spotless" is union.
1296
1297 \b Removed BASIC programs from distribution.  Get a Perl interpreter
1298   instead (see below.)
1299
1300 \b Calling this "pre-release 3.2" rather than "p3-hpa2" because of
1301   John's contributions.
1302
1303 \b Actually link in the IEEE output format (zoutieee.c); fix a bunch of
1304   compiler warnings in that file.  Note I don't know what IEEE output
1305   is supposed to look like, so these changes were made "blind".
1306
1307
1308 \S{cl-0.98p3-hpa} Version 0.98p3-hpa
1309
1310 \b Merged nasm098p3.zip with nasm-0.97.tar.gz to create a fully
1311   buildable version for Unix systems (Makefile.in updates, etc.)
1312
1313 \b Changed insns.pl to create the instruction tables in nasm.h and
1314   names.c, so that a new instruction can be added by adding it *only*
1315   to insns.dat.
1316
1317 \b Added the following new instructions: SYSENTER, SYSEXIT, FXSAVE,
1318   FXRSTOR, UD1, UD2 (the latter two are two opcodes that Intel
1319   guarantee will never be used; one of them is documented as UD2 in
1320   Intel documentation, the other one just as "Undefined Opcode" --
1321   calling it UD1 seemed to make sense.)
1322
1323 \b MAX_SYMBOL was defined to be 9, but LOADALL286 and LOADALL386 are 10
1324   characters long.  Now MAX_SYMBOL is derived from insns.dat.
1325
1326 \b A note on the BASIC programs included: forget them.  insns.bas is
1327   already out of date.  Get yourself a Perl interpreter for your
1328   platform of choice at
1329   \W{http://www.cpan.org/ports/index.html}{http://www.cpan.org/ports/index.html}.
1330
1331
1332 \S{cl-0.98p3} Version 0.98 pre-release 3
1333
1334 \b added response file support, improved command line handling, new layout
1335 help screen
1336
1337 \b fixed limit checking bug, 'OUT byte nn, reg' bug, and a couple of rdoff
1338 related bugs, updated Wishlist; 0.98 Prerelease 3.
1339
1340
1341 \S{cl-0.98p2} Version 0.98 pre-release 2
1342
1343 \b fixed bug in outcoff.c to do with truncating section names longer
1344 than 8 characters, referencing beyond end of string; 0.98 pre-release 2
1345
1346
1347 \S{cl-0.98p1} Version 0.98 pre-release 1
1348
1349 \b Fixed a bug whereby STRUC didn't work at all in RDF.
1350
1351 \b Fixed a problem with group specification in PUBDEFs in OBJ.
1352
1353 \b Improved ease of adding new output formats. Contribution due to
1354 Fox Cutter.
1355
1356 \b Fixed a bug in relocations in the `bin' format: was showing up when
1357 a relocatable reference crossed an 8192-byte boundary in any output
1358 section.
1359
1360 \b Fixed a bug in local labels: local-label lookups were inconsistent
1361 between passes one and two if an EQU occurred between the definition
1362 of a global label and the subsequent use of a local label local to
1363 that global.
1364
1365 \b Fixed a seg-fault in the preprocessor (again) which happened when
1366 you use a blank line as the first line of a multi-line macro
1367 definition and then defined a label on the same line as a call to
1368 that macro.
1369
1370 \b Fixed a stale-pointer bug in the handling of the NASM environment
1371 variable. Thanks to Thomas McWilliams.
1372
1373 \b ELF had a hard limit on the number of sections which caused
1374 segfaults when transgressed. Fixed.
1375
1376 \b Added ability for ndisasm to read from stdin by using `-' as the
1377 filename.
1378
1379 \b ndisasm wasn't outputting the TO keyword. Fixed.
1380
1381 \b Fixed error cascade on bogus expression in \c{%if} - an error in
1382 evaluation was causing the entire \c{%if} to be discarded, thus creating
1383 trouble later when the \c{%else} or \c{%endif} was encountered.
1384
1385 \b Forward reference tracking was instruction-granular not operand-
1386 granular, which was causing 286-specific code to be generated
1387 needlessly on code of the form `shr word [forwardref],1'. Thanks to
1388 Jim Hague for sending a patch.
1389
1390 \b All messages now appear on stdout, as sending them to stderr serves
1391 no useful purpose other than to make redirection difficult.
1392
1393 \b Fixed the problem with EQUs pointing to an external symbol - this
1394 now generates an error message.
1395
1396 \b Allowed multiple size prefixes to an operand, of which only the first
1397 is taken into account.
1398
1399 \b Incorporated John Fine's changes, including fixes of a large number
1400 of preprocessor bugs, some small problems in OBJ, and a reworking of
1401 label handling to define labels before their line is assembled, rather
1402 than after.
1403
1404 \b Reformatted a lot of the source code to be more readable. Included
1405 'coding.txt' as a guideline for how to format code for contributors.
1406
1407 \b Stopped nested \c{%reps} causing a panic - they now cause a slightly more
1408 friendly error message instead.
1409
1410 \b Fixed floating point constant problems (patch by Pedro Gimeno)
1411
1412 \b Fixed the return value of insn_size() not being checked for -1, indicating
1413 an error.
1414
1415 \b Incorporated 3Dnow! instructions.
1416
1417 \b Fixed the 'mov eax, eax + ebx' bug.
1418
1419 \b Fixed the GLOBAL EQU bug in ELF. Released developers release 3.
1420
1421 \b Incorporated John Fine's command line parsing changes
1422
1423 \b Incorporated David Lindauer's OMF debug support
1424
1425 \b Made changes for LCC 4.0 support (\c{__NASM_CDecl__}, removed register size
1426 specification warning when sizes agree).
1427
1428
1429 \H{cl-0.9x} NASM 0.9 Series
1430
1431 Revisions before 0.98.
1432
1433
1434 \S{cl-0.97} Version 0.97 released December 1997
1435
1436 \b This was entirely a bug-fix release to 0.96, which seems to have got
1437 cursed. Silly me.
1438
1439 \b Fixed stupid mistake in OBJ which caused `MOV EAX,<constant>' to
1440 fail. Caused by an error in the `MOV EAX,<segment>' support.
1441
1442 \b ndisasm hung at EOF when compiled with lcc on Linux because lcc on
1443 Linux somehow breaks feof(). ndisasm now does not rely on feof().
1444
1445 \b A heading in the documentation was missing due to a markup error in
1446 the indexing. Fixed.
1447
1448 \b Fixed failure to update all pointers on realloc() within extended-
1449 operand code in parser.c. Was causing wrong behaviour and seg faults
1450 on lines such as `dd 0.0,0.0,0.0,0.0,...'
1451
1452 \b Fixed a subtle preprocessor bug whereby invoking one multi-line
1453 macro on the first line of the expansion of another, when the second
1454 had been invoked with a label defined before it, didn't expand the
1455 inner macro. 
1456
1457 \b Added internal.doc back in to the distribution archives - it was
1458 missing in 0.96 *blush*
1459
1460 \b Fixed bug causing 0.96 to be unable to assemble its own test files,
1461 specifically objtest.asm. *blush again*
1462
1463 \b Fixed seg-faults and bogus error messages caused by mismatching
1464 \c{%rep} and \c{%endrep} within multi-line macro definitions.
1465
1466 \b Fixed a problem with buffer overrun in OBJ, which was causing
1467 corruption at ends of long PUBDEF records.
1468
1469 \b Separated DOS archives into main-program and documentation to reduce
1470 download size.
1471
1472
1473 \S{cl-0.96} Version 0.96 released November 1997
1474
1475 \b Fixed a bug whereby, if `nasm sourcefile' would cause a filename
1476 collision warning and put output into `nasm.out', then `nasm
1477 sourcefile -o outputfile' still gave the warning even though the
1478 `-o' was honoured.
1479 Fixed name pollution under Digital UNIX: one of its header files
1480 defined R_SP, which broke the enum in nasm.h.
1481
1482 \b Fixed minor instruction table problems: FUCOM and FUCOMP didn't have
1483 two-operand forms; NDISASM didn't recognise the longer register
1484 forms of PUSH and POP (eg FF F3 for PUSH BX); TEST mem,imm32 was
1485 flagged as undocumented; the 32-bit forms of CMOV had 16-bit operand
1486 size prefixes; `AAD imm' and `AAM imm' are no longer flagged as
1487 undocumented because the Intel Architecture reference documents
1488 them.
1489
1490 \b Fixed a problem with the local-label mechanism, whereby strange
1491 types of symbol (EQUs, auto-defined OBJ segment base symbols)
1492 interfered with the `previous global label' value and screwed up
1493 local labels.
1494
1495 \b Fixed a bug whereby the stub preprocessor didn't communicate with
1496 the listing file generator, so that the -a and -l options in
1497 conjunction would produce a useless listing file.
1498
1499 \b Merged `os2' object file format back into `obj', after discovering
1500 that `obj' _also_ shouldn't have a link pass separator in a module
1501 containing a non-trivial MODEND. Flat segments are now declared
1502 using the FLAT attribute. `os2' is no longer a valid object format
1503 name: use `obj'.
1504
1505 \b Removed the fixed-size temporary storage in the evaluator. Very very
1506 long expressions (like `mov ax,1+1+1+1+...' for two hundred 1s or
1507 so) should now no longer crash NASM.
1508
1509 \b Fixed a bug involving segfaults on disassembly of MMX instructions,
1510 by changing the meaning of one of the operand-type flags in nasm.h.
1511 This may cause other apparently unrelated MMX problems; it needs to
1512 be tested thoroughly.
1513
1514 \b Fixed some buffer overrun problems with large OBJ output files.
1515 Thanks to DJ Delorie for the bug report and fix.
1516
1517 \b Made preprocess-only mode actually listen to the \c{%line} markers as it
1518 prints them, so that it can report errors more sanely.
1519
1520 \b Re-designed the evaluator to keep more sensible track of expressions
1521 involving forward references: can now cope with previously-nightmare
1522 situations such as:
1523
1524 \c   mov ax,foo | bar
1525 \c   foo equ 1
1526 \c   bar equ 2
1527
1528 \b Added the ALIGN and ALIGNB standard macros.
1529
1530 \b Added PIC support in ELF: use of WRT to obtain the four extra
1531 relocation types needed.
1532
1533 \b Added the ability for output file formats to define their own
1534 extensions to the GLOBAL, COMMON and EXTERN directives.
1535
1536 \b Implemented common-variable alignment, and global-symbol type and
1537 size declarations, in ELF.
1538
1539 \b Implemented NEAR and FAR keywords for common variables, plus
1540 far-common element size specification, in OBJ.
1541
1542 \b Added a feature whereby EXTERNs and COMMONs in OBJ can be given a
1543 default WRT specification (either a segment or a group).
1544
1545 \b Transformed the Unix NASM archive into an auto-configuring package.
1546
1547 \b Added a sanity-check for people applying SEG to things which are
1548 already segment bases: this previously went unnoticed by the SEG
1549 processing and caused OBJ-driver panics later.
1550
1551 \b Added the ability, in OBJ format, to deal with `MOV EAX,<segment>'
1552 type references: OBJ doesn't directly support dword-size segment
1553 base fixups, but as long as the low two bytes of the constant term
1554 are zero, a word-size fixup can be generated instead and it will
1555 work.
1556
1557 \b Added the ability to specify sections' alignment requirements in
1558 Win32 object files and pure binary files.
1559
1560 \b Added preprocess-time expression evaluation: the \c{%assign} (and
1561 \c{%iassign}) directive and the bare \c{%if} (and \c{%elif}) conditional. Added
1562 relational operators to the evaluator, for use only in \c{%if}
1563 constructs: the standard relationals = < > <= >= <> (and C-like
1564 synonyms == and !=) plus low-precedence logical operators &&, ^^ and
1565 ||.
1566
1567 \b Added a preprocessor repeat construct: \c{%rep} / \c{%exitrep} / \c{%endrep}.
1568
1569 \b Added the __FILE__ and __LINE__ standard macros.
1570
1571 \b Added a sanity check for number constants being greater than
1572 0xFFFFFFFF. The warning can be disabled.
1573
1574 \b Added the %0 token whereby a variadic multi-line macro can tell how
1575 many parameters it's been given in a specific invocation.
1576
1577 \b Added \c{%rotate}, allowing multi-line macro parameters to be cycled.
1578
1579 \b Added the `*' option for the maximum parameter count on multi-line
1580 macros, allowing them to take arbitrarily many parameters.
1581
1582 \b Added the ability for the user-level forms of EXTERN, GLOBAL and
1583 COMMON to take more than one argument.
1584
1585 \b Added the IMPORT and EXPORT directives in OBJ format, to deal with
1586 Windows DLLs.
1587
1588 \b Added some more preprocessor \c{%if} constructs: \c{%ifidn} / \c{%ifidni} (exact
1589 textual identity), and \c{%ifid} / \c{%ifnum} / \c{%ifstr} (token type testing).
1590
1591 \b Added the ability to distinguish SHL AX,1 (the 8086 version) from
1592 SHL AX,BYTE 1 (the 286-and-upwards version whose constant happens to
1593 be 1).
1594
1595 \b Added NetBSD/FreeBSD/OpenBSD's variant of a.out format, complete
1596 with PIC shared library features.
1597
1598 \b Changed NASM's idiosyncratic handling of FCLEX, FDISI, FENI, FINIT,
1599 FSAVE, FSTCW, FSTENV, and FSTSW to bring it into line with the
1600 otherwise accepted standard. The previous behaviour, though it was a
1601 deliberate feature, was a deliberate feature based on a
1602 misunderstanding. Apologies for the inconvenience.
1603
1604 \b Improved the flexibility of ABSOLUTE: you can now give it an
1605 expression rather than being restricted to a constant, and it can
1606 take relocatable arguments as well.
1607
1608 \b Added the ability for a variable to be declared as EXTERN multiple
1609 times, and the subsequent definitions are just ignored.
1610
1611 \b We now allow instruction prefixes (CS, DS, LOCK, REPZ etc) to be
1612 alone on a line (without a following instruction).
1613
1614 \b Improved sanity checks on whether the arguments to EXTERN, GLOBAL
1615 and COMMON are valid identifiers.
1616
1617 \b Added misc/exebin.mac to allow direct generation of .EXE files by
1618 hacking up an EXE header using DB and DW; also added test/binexe.asm
1619 to demonstrate the use of this. Thanks to Yann Guidon for
1620 contributing the EXE header code.
1621
1622 \b ndisasm forgot to check whether the input file had been successfully
1623 opened. Now it does. Doh!
1624
1625 \b Added the Cyrix extensions to the MMX instruction set.
1626
1627 \b Added a hinting mechanism to allow [EAX+EBX] and [EBX+EAX] to be
1628 assembled differently. This is important since [ESI+EBP] and
1629 [EBP+ESI] have different default base segment registers.
1630
1631 \b Added support for the PharLap OMF extension for 4096-byte segment
1632 alignment.
1633
1634
1635 \S{cl-0.95 released July 1997} Version 0.95 released July 1997
1636
1637 \b Fixed yet another ELF bug. This one manifested if the user relied on
1638 the default segment, and attempted to define global symbols without
1639 first explicitly declaring the target segment.
1640
1641 \b Added makefiles (for NASM and the RDF tools) to build Win32 console
1642 apps under Symantec C++. Donated by Mark Junker.
1643
1644 \b Added `macros.bas' and `insns.bas', QBasic versions of the Perl
1645 scripts that convert `standard.mac' to `macros.c' and convert
1646 `insns.dat' to `insnsa.c' and `insnsd.c'. Also thanks to Mark
1647 Junker.
1648
1649 \b Changed the diassembled forms of the conditional instructions so
1650 that JB is now emitted as JC, and other similar changes. Suggested
1651 list by Ulrich Doewich.
1652
1653 \b Added `@' to the list of valid characters to begin an identifier
1654 with.
1655
1656 \b Documentary changes, notably the addition of the `Common Problems'
1657 section in nasm.doc.
1658
1659 \b Fixed a bug relating to 32-bit PC-relative fixups in OBJ.
1660
1661 \b Fixed a bug in perm_copy() in labels.c which was causing exceptions
1662 in cleanup_labels() on some systems.
1663
1664 \b Positivity sanity check in TIMES argument changed from a warning to
1665 an error following a further complaint.
1666
1667 \b Changed the acceptable limits on byte and word operands to allow
1668 things like `~10111001b' to work.
1669
1670 \b Fixed a major problem in the preprocessor which caused seg-faults if
1671 macro definitions contained blank lines or comment-only lines.
1672
1673 \b Fixed inadequate error checking on the commas separating the
1674 arguments to `db', `dw' etc.
1675
1676 \b Fixed a crippling bug in the handling of macros with operand counts
1677 defined with a `+' modifier.
1678
1679 \b Fixed a bug whereby object file formats which stored the input file
1680 name in the output file (such as OBJ and COFF) weren't doing so
1681 correctly when the output file name was specified on the command
1682 line.
1683
1684 \b Removed [INC] and [INCLUDE] support for good, since they were
1685 obsolete anyway.
1686
1687 \b Fixed a bug in OBJ which caused all fixups to be output in 16-bit
1688 (old-format) FIXUPP records, rather than putting the 32-bit ones in
1689 FIXUPP32 (new-format) records.
1690
1691 \b Added, tentatively, OS/2 object file support (as a minor variant on
1692 OBJ).
1693
1694 \b Updates to Fox Cutter's Borland C makefile, Makefile.bc2.
1695
1696 \b Removed a spurious second fclose() on the output file.
1697
1698 \b Added the `-s' command line option to redirect all messages which
1699 would go to stderr (errors, help text) to stdout instead.
1700
1701 \b Added the `-w' command line option to selectively suppress some
1702 classes of assembly warning messages.
1703
1704 \b Added the `-p' pre-include and `-d' pre-define command-line options.
1705
1706 \b Added an include file search path: the `-i' command line option.
1707
1708 \b Fixed a silly little preprocessor bug whereby starting a line with a
1709 `%!' environment-variable reference caused an `unknown directive'
1710 error.
1711
1712 \b Added the long-awaited listing file support: the `-l' command line
1713 option.
1714
1715 \b Fixed a problem with OBJ format whereby, in the absence of any
1716 explicit segment definition, non-global symbols declared in the
1717 implicit default segment generated spurious EXTDEF records in the
1718 output.
1719
1720 \b Added the NASM environment variable.
1721
1722 \b From this version forward, Win32 console-mode binaries will be
1723 included in the DOS distribution in addition to the 16-bit binaries.
1724 Added Makefile.vc for this purpose.
1725
1726 \b Added `return 0;' to test/objlink.c to prevent compiler warnings.
1727
1728 \b Added the __NASM_MAJOR__ and __NASM_MINOR__ standard defines.
1729
1730 \b Added an alternative memory-reference syntax in which prefixing an
1731 operand with `&' is equivalent to enclosing it in square brackets,
1732 at the request of Fox Cutter.
1733
1734 \b Errors in pass two now cause the program to return a non-zero error
1735 code, which they didn't before.
1736
1737 \b Fixed the single-line macro cycle detection, which didn't work at
1738 all on macros with no parameters (caused an infinite loop). Also
1739 changed the behaviour of single-line macro cycle detection to work
1740 like cpp, so that macros like `extrn' as given in the documentation
1741 can be implemented.
1742
1743 \b Fixed the implementation of WRT, which was too restrictive in that
1744 you couldn't do `mov ax,[di+abc wrt dgroup]' because (di+abc) wasn't
1745 a relocatable reference.
1746
1747
1748 \S{cl-0.94 released April 1997} Version 0.94 released April 1997
1749
1750
1751 \b Major item: added the macro processor.
1752
1753 \b Added undocumented instructions SMI, IBTS, XBTS and LOADALL286. Also
1754 reorganised CMPXCHG instruction into early-486 and Pentium forms.
1755 Thanks to Thobias Jones for the information.
1756
1757 \b Fixed two more stupid bugs in ELF, which were causing `ld' to
1758 continue to seg-fault in a lot of non-trivial cases.
1759
1760 \b Fixed a seg-fault in the label manager.
1761
1762 \b Stopped FBLD and FBSTP from _requiring_ the TWORD keyword, which is
1763 the only option for BCD loads/stores in any case.
1764
1765 \b Ensured FLDCW, FSTCW and FSTSW can cope with the WORD keyword, if
1766 anyone bothers to provide it. Previously they complained unless no
1767 keyword at all was present.
1768
1769 \b Some forms of FDIV/FDIVR and FSUB/FSUBR were still inverted: a
1770 vestige of a bug that I thought had been fixed in 0.92. This was
1771 fixed, hopefully for good this time...
1772
1773 \b Another minor phase error (insofar as a phase error can _ever_ be
1774 minor) fixed, this one occurring in code of the form
1775
1776 \c   rol ax,forward_reference
1777 \c   forward_reference equ 1
1778
1779 \b The number supplied to TIMES is now sanity-checked for positivity,
1780 and also may be greater than 64K (which previously didn't work on
1781 16-bit systems).
1782
1783 \b Added Watcom C makefiles, and misc/pmw.bat, donated by Dominik Behr.
1784
1785 \b Added the INCBIN pseudo-opcode.
1786
1787 \b Due to the advent of the preprocessor, the [INCLUDE] and [INC]
1788 directives have become obsolete. They are still supported in this
1789 version, with a warning, but won't be in the next.
1790
1791 \b Fixed a bug in OBJ format, which caused incorrect object records to
1792 be output when absolute labels were made global.
1793
1794 \b Updates to RDOFF subdirectory, and changes to outrdf.c.
1795
1796
1797 \S{cl-0.93 released January 1997} Version 0.93 released January 1997
1798
1799 This release went out in a great hurry after semi-crippling bugs
1800 were found in 0.92.
1801
1802 \b Really \e{did} fix the stack overflows this time. *blush*
1803
1804 \b Had problems with EA instruction sizes changing between passes, when
1805 an offset contained a forward reference and so 4 bytes were
1806 allocated for the offset in pass one; by pass two the symbol had
1807 been defined and happened to be a small absolute value, so only 1
1808 byte got allocated, causing instruction size mismatch between passes
1809 and hence incorrect address calculations. Fixed.
1810
1811 \b Stupid bug in the revised ELF section generation fixed (associated
1812 string-table section for .symtab was hard-coded as 7, even when this
1813 didn't fit with the real section table). Was causing `ld' to
1814 seg-fault under Linux.
1815
1816 \b Included a new Borland C makefile, Makefile.bc2, donated by Fox
1817 Cutter <lmb@comtch.iea.com>.
1818
1819
1820 \S{cl-0.92 released January 1997} Version 0.92 released January 1997
1821
1822 \b The FDIVP/FDIVRP and FSUBP/FSUBRP pairs had been inverted: this was
1823 fixed. This also affected the LCC driver.
1824
1825 \b Fixed a bug regarding 32-bit effective addresses of the form
1826 \c{[other_register+ESP]}.
1827
1828 \b Documentary changes, notably documentation of the fact that Borland
1829 Win32 compilers use `obj' rather than `win32' object format.
1830
1831 \b Fixed the COMENT record in OBJ files, which was formatted
1832 incorrectly.
1833
1834 \b Fixed a bug causing segfaults in large RDF files.
1835
1836 \b OBJ format now strips initial periods from segment and group
1837 definitions, in order to avoid complications with the local label
1838 syntax.
1839
1840 \b Fixed a bug in disassembling far calls and jumps in NDISASM.
1841
1842 \b Added support for user-defined sections in COFF and ELF files.
1843
1844 \b Compiled the DOS binaries with a sensible amount of stack, to
1845 prevent stack overflows on any arithmetic expression containing
1846 parentheses.
1847
1848 \b Fixed a bug in handling of files that do not terminate in a newline.
1849
1850
1851 \S{cl-0.91 released November 1996} Version 0.91 released November 1996
1852
1853 \b Loads of bug fixes.
1854
1855 \b Support for RDF added.
1856
1857 \b Support for DBG debugging format added.
1858
1859 \b Support for 32-bit extensions to Microsoft OBJ format added.
1860
1861 \b Revised for Borland C: some variable names changed, makefile added.
1862
1863 \b LCC support revised to actually work.
1864
1865 \b JMP/CALL NEAR/FAR notation added.
1866
1867 \b `a16', `o16', `a32' and `o32' prefixes added.
1868
1869 \b Range checking on short jumps implemented.
1870
1871 \b MMX instruction support added.
1872
1873 \b Negative floating point constant support added.
1874
1875 \b Memory handling improved to bypass 64K barrier under DOS.
1876
1877 \b \c{$} prefix to force treatment of reserved words as identifiers added.
1878
1879 \b Default-size mechanism for object formats added.
1880
1881 \b Compile-time configurability added.
1882
1883 \b \c{#}, \c{@}, \c{~} and c\{?} are now valid characters in labels.
1884
1885 \b \c{-e} and \c{-k} options in NDISASM added.
1886
1887
1888 \S{cl-0.90 released October 1996} Version 0.90 released October 1996
1889
1890 First release version. First support for object file output. Other
1891 changes from previous version (0.3x) too numerous to document.