NASM 0.98.26
[platform/upstream/nasm.git] / doc / Changes
1 Change log for NASM
2 ===================
3
4 This is the Changelog for the official releases; this is a modified
5 version.  For the changes from the official release, see the MODIFIED file.
6
7 0.90 released October 1996
8 --------------------------
9
10 First release version. First support for object file output. Other
11 changes from previous version (0.3x) too numerous to document.
12
13 0.91 released November 1996
14 ---------------------------
15
16 Loads of bug fixes.
17 Support for RDF added.
18 Support for DBG debugging format added.
19 Support for 32-bit extensions to Microsoft OBJ format added.
20 Revised for Borland C: some variable names changed, makefile added.
21 LCC support revised to actually work.
22 JMP/CALL NEAR/FAR notation added.
23 `a16', `o16', `a32' and `o32' prefixes added.
24 Range checking on short jumps implemented.
25 MMX instruction support added.
26 Negative floating point constant support added.
27 Memory handling improved to bypass 64K barrier under DOS.
28 $ prefix to force treatment of reserved words as identifiers added.
29 Default-size mechanism for object formats added.
30 Compile-time configurability added.
31 `#', `@', `~' and `?' are now valid characters in labels.
32 `-e' and `-k' options in NDISASM added.
33
34 0.92 released January 1997
35 --------------------------
36
37 The FDIVP/FDIVRP and FSUBP/FSUBRP pairs had been inverted: this was
38 fixed. This also affected the LCC driver.
39
40 Fixed a bug regarding 32-bit effective addresses of the form
41 [other_register+ESP].
42
43 Documentary changes, notably documentation of the fact that Borland
44 Win32 compilers use `obj' rather than `win32' object format.
45
46 Fixed the COMENT record in OBJ files, which was formatted
47 incorrectly.
48
49 Fixed a bug causing segfaults in large RDF files.
50
51 OBJ format now strips initial periods from segment and group
52 definitions, in order to avoid complications with the local label
53 syntax.
54
55 Fixed a bug in disassembling far calls and jumps in NDISASM.
56
57 Added support for user-defined sections in COFF and ELF files.
58
59 Compiled the DOS binaries with a sensible amount of stack, to
60 prevent stack overflows on any arithmetic expression containing
61 parentheses.
62
63 Fixed a bug in handling of files that do not terminate in a newline.
64
65 0.93 released January 1997
66 --------------------------
67
68 This release went out in a great hurry after semi-crippling bugs
69 were found in 0.92.
70
71 Really _did_ fix the stack overflows this time. *blush*
72
73 Had problems with EA instruction sizes changing between passes, when
74 an offset contained a forward reference and so 4 bytes were
75 allocated for the offset in pass one; by pass two the symbol had
76 been defined and happened to be a small absolute value, so only 1
77 byte got allocated, causing instruction size mismatch between passes
78 and hence incorrect address calculations. Fixed.
79
80 Stupid bug in the revised ELF section generation fixed (associated
81 string-table section for .symtab was hard-coded as 7, even when this
82 didn't fit with the real section table). Was causing `ld' to
83 seg-fault under Linux.
84
85 Included a new Borland C makefile, Makefile.bc2, donated by Fox
86 Cutter <lmb@comtch.iea.com>.
87
88 0.94 released April 1997
89 ------------------------
90
91 Major item: added the macro processor.
92
93 Added undocumented instructions SMI, IBTS, XBTS and LOADALL286. Also
94 reorganised CMPXCHG instruction into early-486 and Pentium forms.
95 Thanks to Thobias Jones for the information.
96
97 Fixed two more stupid bugs in ELF, which were causing `ld' to
98 continue to seg-fault in a lot of non-trivial cases.
99
100 Fixed a seg-fault in the label manager.
101
102 Stopped FBLD and FBSTP from _requiring_ the TWORD keyword, which is
103 the only option for BCD loads/stores in any case.
104
105 Ensured FLDCW, FSTCW and FSTSW can cope with the WORD keyword, if
106 anyone bothers to provide it. Previously they complained unless no
107 keyword at all was present.
108
109 Some forms of FDIV/FDIVR and FSUB/FSUBR were still inverted: a
110 vestige of a bug that I thought had been fixed in 0.92. This was
111 fixed, hopefully for good this time...
112
113 Another minor phase error (insofar as a phase error can _ever_ be
114 minor) fixed, this one occurring in code of the form
115    rol ax,forward_reference
116    forward_reference equ 1
117
118 The number supplied to TIMES is now sanity-checked for positivity,
119 and also may be greater than 64K (which previously didn't work on
120 16-bit systems).
121
122 Added Watcom C makefiles, and misc/pmw.bat, donated by Dominik Behr.
123
124 Added the INCBIN pseudo-opcode.
125
126 Due to the advent of the preprocessor, the [INCLUDE] and [INC]
127 directives have become obsolete. They are still supported in this
128 version, with a warning, but won't be in the next.
129
130 Fixed a bug in OBJ format, which caused incorrect object records to
131 be output when absolute labels were made global.
132
133 Updates to RDOFF subdirectory, and changes to outrdf.c.
134
135 0.95 released July 1997
136 -----------------------
137
138 Fixed yet another ELF bug. This one manifested if the user relied on
139 the default segment, and attempted to define global symbols without
140 first explicitly declaring the target segment.
141
142 Added makefiles (for NASM and the RDF tools) to build Win32 console
143 apps under Symantec C++. Donated by Mark Junker.
144
145 Added `macros.bas' and `insns.bas', QBasic versions of the Perl
146 scripts that convert `standard.mac' to `macros.c' and convert
147 `insns.dat' to `insnsa.c' and `insnsd.c'. Also thanks to Mark
148 Junker.
149
150 Changed the diassembled forms of the conditional instructions so
151 that JB is now emitted as JC, and other similar changes. Suggested
152 list by Ulrich Doewich.
153
154 Added `@' to the list of valid characters to begin an identifier
155 with.
156
157 Documentary changes, notably the addition of the `Common Problems'
158 section in nasm.doc.
159
160 Fixed a bug relating to 32-bit PC-relative fixups in OBJ.
161
162 Fixed a bug in perm_copy() in labels.c which was causing exceptions
163 in cleanup_labels() on some systems.
164
165 Positivity sanity check in TIMES argument changed from a warning to
166 an error following a further complaint.
167
168 Changed the acceptable limits on byte and word operands to allow
169 things like `~10111001b' to work.
170
171 Fixed a major problem in the preprocessor which caused seg-faults if
172 macro definitions contained blank lines or comment-only lines.
173
174 Fixed inadequate error checking on the commas separating the
175 arguments to `db', `dw' etc.
176
177 Fixed a crippling bug in the handling of macros with operand counts
178 defined with a `+' modifier.
179
180 Fixed a bug whereby object file formats which stored the input file
181 name in the output file (such as OBJ and COFF) weren't doing so
182 correctly when the output file name was specified on the command
183 line.
184
185 Removed [INC] and [INCLUDE] support for good, since they were
186 obsolete anyway.
187
188 Fixed a bug in OBJ which caused all fixups to be output in 16-bit
189 (old-format) FIXUPP records, rather than putting the 32-bit ones in
190 FIXUPP32 (new-format) records.
191
192 Added, tentatively, OS/2 object file support (as a minor variant on
193 OBJ).
194
195 Updates to Fox Cutter's Borland C makefile, Makefile.bc2.
196
197 Removed a spurious second fclose() on the output file.
198
199 Added the `-s' command line option to redirect all messages which
200 would go to stderr (errors, help text) to stdout instead.
201
202 Added the `-w' command line option to selectively suppress some
203 classes of assembly warning messages.
204
205 Added the `-p' pre-include and `-d' pre-define command-line options.
206
207 Added an include file search path: the `-i' command line option.
208
209 Fixed a silly little preprocessor bug whereby starting a line with a
210 `%!' environment-variable reference caused an `unknown directive'
211 error.
212
213 Added the long-awaited listing file support: the `-l' command line
214 option.
215
216 Fixed a problem with OBJ format whereby, in the absence of any
217 explicit segment definition, non-global symbols declared in the
218 implicit default segment generated spurious EXTDEF records in the
219 output.
220
221 Added the NASM environment variable.
222
223 From this version forward, Win32 console-mode binaries will be
224 included in the DOS distribution in addition to the 16-bit binaries.
225 Added Makefile.vc for this purpose.
226
227 Added `return 0;' to test/objlink.c to prevent compiler warnings.
228
229 Added the __NASM_MAJOR__ and __NASM_MINOR__ standard defines.
230
231 Added an alternative memory-reference syntax in which prefixing an
232 operand with `&' is equivalent to enclosing it in square brackets,
233 at the request of Fox Cutter.
234
235 Errors in pass two now cause the program to return a non-zero error
236 code, which they didn't before.
237
238 Fixed the single-line macro cycle detection, which didn't work at
239 all on macros with no parameters (caused an infinite loop). Also
240 changed the behaviour of single-line macro cycle detection to work
241 like cpp, so that macros like `extrn' as given in the documentation
242 can be implemented.
243
244 Fixed the implementation of WRT, which was too restrictive in that
245 you couldn't do `mov ax,[di+abc wrt dgroup]' because (di+abc) wasn't
246 a relocatable reference.
247
248 0.96 released November 1997
249 ---------------------------
250
251 Fixed a bug whereby, if `nasm sourcefile' would cause a filename
252 collision warning and put output into `nasm.out', then `nasm
253 sourcefile -o outputfile' still gave the warning even though the
254 `-o' was honoured.
255
256 Fixed name pollution under Digital UNIX: one of its header files
257 defined R_SP, which broke the enum in nasm.h.
258
259 Fixed minor instruction table problems: FUCOM and FUCOMP didn't have
260 two-operand forms; NDISASM didn't recognise the longer register
261 forms of PUSH and POP (eg FF F3 for PUSH BX); TEST mem,imm32 was
262 flagged as undocumented; the 32-bit forms of CMOV had 16-bit operand
263 size prefixes; `AAD imm' and `AAM imm' are no longer flagged as
264 undocumented because the Intel Architecture reference documents
265 them.
266
267 Fixed a problem with the local-label mechanism, whereby strange
268 types of symbol (EQUs, auto-defined OBJ segment base symbols)
269 interfered with the `previous global label' value and screwed up
270 local labels.
271
272 Fixed a bug whereby the stub preprocessor didn't communicate with
273 the listing file generator, so that the -a and -l options in
274 conjunction would produce a useless listing file.
275
276 Merged `os2' object file format back into `obj', after discovering
277 that `obj' _also_ shouldn't have a link pass separator in a module
278 containing a non-trivial MODEND. Flat segments are now declared
279 using the FLAT attribute. `os2' is no longer a valid object format
280 name: use `obj'.
281
282 Removed the fixed-size temporary storage in the evaluator. Very very
283 long expressions (like `mov ax,1+1+1+1+...' for two hundred 1s or
284 so) should now no longer crash NASM.
285
286 Fixed a bug involving segfaults on disassembly of MMX instructions,
287 by changing the meaning of one of the operand-type flags in nasm.h.
288 This may cause other apparently unrelated MMX problems; it needs to
289 be tested thoroughly.
290
291 Fixed some buffer overrun problems with large OBJ output files.
292 Thanks to DJ Delorie for the bug report and fix.
293
294 Made preprocess-only mode actually listen to the %line markers as it
295 prints them, so that it can report errors more sanely.
296
297 Re-designed the evaluator to keep more sensible track of expressions
298 involving forward references: can now cope with previously-nightmare
299 situations such as
300    mov ax,foo | bar
301    foo equ 1
302    bar equ 2
303
304 Added the ALIGN and ALIGNB standard macros.
305
306 Added PIC support in ELF: use of WRT to obtain the four extra
307 relocation types needed.
308
309 Added the ability for output file formats to define their own
310 extensions to the GLOBAL, COMMON and EXTERN directives.
311
312 Implemented common-variable alignment, and global-symbol type and
313 size declarations, in ELF.
314
315 Implemented NEAR and FAR keywords for common variables, plus
316 far-common element size specification, in OBJ.
317
318 Added a feature whereby EXTERNs and COMMONs in OBJ can be given a
319 default WRT specification (either a segment or a group).
320
321 Transformed the Unix NASM archive into an auto-configuring package.
322
323 Added a sanity-check for people applying SEG to things which are
324 already segment bases: this previously went unnoticed by the SEG
325 processing and caused OBJ-driver panics later.
326
327 Added the ability, in OBJ format, to deal with `MOV EAX,<segment>'
328 type references: OBJ doesn't directly support dword-size segment
329 base fixups, but as long as the low two bytes of the constant term
330 are zero, a word-size fixup can be generated instead and it will
331 work.
332
333 Added the ability to specify sections' alignment requirements in
334 Win32 object files and pure binary files.
335
336 Added preprocess-time expression evaluation: the %assign (and
337 %iassign) directive and the bare %if (and %elif) conditional. Added
338 relational operators to the evaluator, for use only in %if
339 constructs: the standard relationals = < > <= >= <> (and C-like
340 synonyms == and !=) plus low-precedence logical operators &&, ^^ and
341 ||.
342
343 Added a preprocessor repeat construct: %rep / %exitrep / %endrep.
344
345 Added the __FILE__ and __LINE__ standard macros.
346
347 Added a sanity check for number constants being greater than
348 0xFFFFFFFF. The warning can be disabled.
349
350 Added the %0 token whereby a variadic multi-line macro can tell how
351 many parameters it's been given in a specific invocation.
352
353 Added %rotate, allowing multi-line macro parameters to be cycled.
354
355 Added the `*' option for the maximum parameter count on multi-line
356 macros, allowing them to take arbitrarily many parameters.
357
358 Added the ability for the user-level forms of EXTERN, GLOBAL and
359 COMMON to take more than one argument.
360
361 Added the IMPORT and EXPORT directives in OBJ format, to deal with
362 Windows DLLs.
363
364 Added some more preprocessor %if constructs: %ifidn / %ifidni (exact
365 textual identity), and %ifid / %ifnum / %ifstr (token type testing).
366
367 Added the ability to distinguish SHL AX,1 (the 8086 version) from
368 SHL AX,BYTE 1 (the 286-and-upwards version whose constant happens to
369 be 1).
370
371 Added NetBSD/FreeBSD/OpenBSD's variant of a.out format, complete
372 with PIC shared library features.
373
374 Changed NASM's idiosyncratic handling of FCLEX, FDISI, FENI, FINIT,
375 FSAVE, FSTCW, FSTENV, and FSTSW to bring it into line with the
376 otherwise accepted standard. The previous behaviour, though it was a
377 deliberate feature, was a deliberate feature based on a
378 misunderstanding. Apologies for the inconvenience.
379
380 Improved the flexibility of ABSOLUTE: you can now give it an
381 expression rather than being restricted to a constant, and it can
382 take relocatable arguments as well.
383
384 Added the ability for a variable to be declared as EXTERN multiple
385 times, and the subsequent definitions are just ignored.
386
387 We now allow instruction prefixes (CS, DS, LOCK, REPZ etc) to be
388 alone on a line (without a following instruction).
389
390 Improved sanity checks on whether the arguments to EXTERN, GLOBAL
391 and COMMON are valid identifiers.
392
393 Added misc/exebin.mac to allow direct generation of .EXE files by
394 hacking up an EXE header using DB and DW; also added test/binexe.asm
395 to demonstrate the use of this. Thanks to Yann Guidon for
396 contributing the EXE header code.
397
398 ndisasm forgot to check whether the input file had been successfully
399 opened. Now it does. Doh!
400
401 Added the Cyrix extensions to the MMX instruction set.
402
403 Added a hinting mechanism to allow [EAX+EBX] and [EBX+EAX] to be
404 assembled differently. This is important since [ESI+EBP] and
405 [EBP+ESI] have different default base segment registers.
406
407 Added support for the PharLap OMF extension for 4096-byte segment
408 alignment.
409
410 0.97 released December 1997
411 ---------------------------
412
413 This was entirely a bug-fix release to 0.96, which seems to have got
414 cursed. Silly me.
415
416 Fixed stupid mistake in OBJ which caused `MOV EAX,<constant>' to
417 fail. Caused by an error in the `MOV EAX,<segment>' support.
418
419 ndisasm hung at EOF when compiled with lcc on Linux because lcc on
420 Linux somehow breaks feof(). ndisasm now does not rely on feof().
421
422 A heading in the documentation was missing due to a markup error in
423 the indexing. Fixed.
424
425 Fixed failure to update all pointers on realloc() within extended-
426 operand code in parser.c. Was causing wrong behaviour and seg faults
427 on lines such as `dd 0.0,0.0,0.0,0.0,...'
428
429 Fixed a subtle preprocessor bug whereby invoking one multi-line
430 macro on the first line of the expansion of another, when the second
431 had been invoked with a label defined before it, didn't expand the
432 inner macro. 
433
434 Added internal.doc back in to the distribution archives - it was
435 missing in 0.96 *blush*
436
437 Fixed bug causing 0.96 to be unable to assemble its own test files,
438 specifically objtest.asm. *blush again*
439
440 Fixed seg-faults and bogus error messages caused by mismatching
441 %rep and %endrep within multi-line macro definitions.
442
443 Fixed a problem with buffer overrun in OBJ, which was causing
444 corruption at ends of long PUBDEF records.
445
446 Separated DOS archives into main-program and documentation to reduce
447 download size.
448
449 0.98 released May 1999
450 ----------------------
451
452 Fixed a bug whereby STRUC didn't work at all in RDF.
453
454 Fixed a problem with group specification in PUBDEFs in OBJ.
455
456 Improved ease of adding new output formats. Contribution due to
457 Fox Cutter.
458
459 Fixed a bug in relocations in the `bin' format: was showing up when
460 a relocatable reference crossed an 8192-byte boundary in any output
461 section.
462
463 Fixed a bug in local labels: local-label lookups were inconsistent
464 between passes one and two if an EQU occurred between the definition
465 of a global label and the subsequent use of a local label local to
466 that global.
467
468 Fixed a seg-fault in the preprocessor (again) which happened when
469 you use a blank line as the first line of a multi-line macro
470 definition and then defined a label on the same line as a call to
471 that macro.
472
473 Fixed a stale-pointer bug in the handling of the NASM environment
474 variable. Thanks to Thomas McWilliams.
475
476 ELF had a hard limit on the number of sections which caused
477 segfaults when transgressed. Fixed.
478
479 Added ability for ndisasm to read from stdin by using `-' as the
480 filename.
481
482 ndisasm wasn't outputting the TO keyword. Fixed.
483
484 Fixed error cascade on bogus expression in %if - an error in
485 evaluation was causing the entire %if to be discarded, thus creating
486 trouble later when the %else or %endif was encountered.
487
488 Forward reference tracking was instruction-granular not operand-
489 granular, which was causing 286-specific code to be generated
490 needlessly on code of the form `shr word [forwardref],1'. Thanks to
491 Jim Hague for sending a patch.
492
493 All messages now appear on stdout, as sending them to stderr serves
494 no useful purpose other than to make redirection difficult.
495
496 Fixed the problem with EQUs pointing to an external symbol - this
497 now generates an error message.
498
499 Allowed multiple size prefixes to an operand, of which only the first
500 is taken into account.
501
502 Incorporated John Fine's changes, including fixes of a large number
503 of preprocessor bugs, some small problems in OBJ, and a reworking of
504 label handling to define labels before their line is assembled, rather
505 than after.
506
507 Reformatted a lot of the source code to be more readable. Included
508 'coding.txt' as a guideline for how to format code for contributors.
509
510 Stopped nested %reps causing a panic - they now cause a slightly more
511 friendly error message instead.
512
513 Fixed floating point constant problems (patch by Pedro Gimeno)
514
515 Fixed the return value of insn_size() not being checked for -1, indicating
516 an error.
517
518 Incorporated 3D now instructions.
519
520 Fixed the 'mov eax, eax + ebx' bug.
521
522 Fixed the GLOBAL EQU bug in ELF. Released developers release 3.
523
524 Incorporated John Fine's command line parsing changes
525
526 Incorporated David Lindauer's OMF debug support
527
528 Made changes for LCC 4.0 support (__NASM_CDecl__, removed register size
529 specification warning when sizes agree).
530
531 Released NASM 0.98 Pre-release 1
532
533 fixed bug in outcoff.c to do with truncating section names longer
534 than 8 characters, referencing beyond end of string; 0.98 pre-release 2
535
536 added response file support, improved command line handling, new layout
537 help screen
538
539 fixed limit checking bug, 'OUT byte nn, reg' bug, and a couple of rdoff
540 related bugs, updated Wishlist; 0.98 Prerelease 3.
541
542 See the file "MODIFIED" for changes after 0.98p3.