00f38e753c490b2f5e55cad5ca97d83807cbb30b
[sbcl.git] / BUGS
1 REPORTING BUGS
2
3 Bugs can be reported on the help mailing list
4   sbcl-help@lists.sourceforge.net
5 or on the development mailing list
6   sbcl-devel@lists.sourceforge.net
7
8 Please include enough information in a bug report that someone reading
9 it can reproduce the problem, i.e. don't write
10      Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
11      PRINT-OBJECT doesn't seem to work with *PRINT-LENGTH*. Is this a bug?
12 but instead
13      Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
14      In sbcl-1.2.3 running under OpenBSD 4.5 on my Alpha box, when
15      I compile and load the file
16        (DEFSTRUCT (FOO (:PRINT-OBJECT (LAMBDA (X Y)
17                                         (LET ((*PRINT-LENGTH* 4))
18                                           (PRINT X Y)))))
19          X Y)
20      then at the command line type
21        (MAKE-FOO)
22      the program loops endlessly instead of printing the object.
23
24
25 NOTES:
26
27 There is also some information on bugs in the manual page and
28 in the TODO file. Eventually more such information may move here.
29
30 The gaps in the number sequence belong to old bug descriptions which
31 have gone away (typically because they were fixed, but sometimes for
32 other reasons, e.g. because they were moved elsewhere).
33
34
35 KNOWN BUGS OF NO SPECIAL CLASS:
36
37 2:
38   DEFSTRUCT almost certainly should overwrite the old LAYOUT information
39   instead of just punting when a contradictory structure definition
40   is loaded. As it is, if you redefine DEFSTRUCTs in a way which 
41   changes their layout, you probably have to rebuild your entire
42   program, even if you know or guess enough about the internals of
43   SBCL to wager that this (undefined in ANSI) operation would be safe.
44
45 3:
46   ANSI specifies that a type mismatch in a structure slot
47   initialization value should not cause a warning.
48 WORKAROUND:
49   This one might not be fixed for a while because while we're big
50   believers in ANSI compatibility and all, (1) there's no obvious
51   simple way to do it (short of disabling all warnings for type
52   mismatches everywhere), and (2) there's a good portable
53   workaround. ANSI justifies this specification by saying 
54     The restriction against issuing a warning for type mismatches
55     between a slot-initform and the corresponding slot's :TYPE
56     option is necessary because a slot-initform must be specified
57     in order to specify slot options; in some cases, no suitable
58     default may exist.
59   In SBCL, as in CMU CL (or, for that matter, any compiler which
60   really understands Common Lisp types) a suitable default does
61   exist, in all cases, because the compiler understands the concept
62   of functions which never return (i.e. has return type NIL, e.g.
63   ERROR). Thus, as a portable workaround, you can use a call to
64   some known-never-to-return function as the default. E.g.
65     (DEFSTRUCT FOO
66       (BAR (ERROR "missing :BAR argument")
67            :TYPE SOME-TYPE-TOO-HAIRY-TO-CONSTRUCT-AN-INSTANCE-OF))
68   or 
69     (DECLAIM (FTYPE () NIL) MISSING-ARG) 
70     (DEFUN REQUIRED-ARG () ; workaround for SBCL non-ANSI slot init typing
71       (ERROR "missing required argument")) 
72     (DEFSTRUCT FOO
73       (BAR (REQUIRED-ARG) :TYPE TRICKY-TYPE-OF-SOME-SORT)
74       (BLETCH (REQUIRED-ARG) :TYPE TRICKY-TYPE-OF-SOME-SORT)
75       (N-REFS-SO-FAR 0 :TYPE (INTEGER 0)))
76   Such code will compile without complaint and work correctly either
77   on SBCL or on a completely compliant Common Lisp system.
78
79 6:
80   bogus warnings about undefined functions for magic functions like
81   SB!C::%%DEFUN and SB!C::%DEFCONSTANT when cross-compiling files
82   like src/code/float.lisp. Fixing this will probably require
83   straightening out enough bootstrap consistency issues that
84   the cross-compiler can run with *TYPE-SYSTEM-INITIALIZED*.
85   Instead, the cross-compiler runs in a slightly flaky state
86   which is sane enough to compile SBCL itself, but which is
87   also unstable in several ways, including its inability
88   to really grok function declarations.
89
90 7:
91   The "byte compiling top-level form:" output ought to be condensed.
92   Perhaps any number of such consecutive lines ought to turn into a
93   single "byte compiling top-level forms:" line.
94
95 10:
96   The way that the compiler munges types with arguments together
97   with types with no arguments (in e.g. TYPE-EXPAND) leads to
98   weirdness visible to the user:
99         (DEFTYPE FOO () 'FIXNUM)
100         (TYPEP 11 'FOO) => T
101         (TYPEP 11 '(FOO)) => T, which seems weird
102         (TYPEP 11 'FIXNUM) => T
103         (TYPEP 11 '(FIXNUM)) signals an error, as it should
104   The situation is complicated by the presence of Common Lisp types
105   like UNSIGNED-BYTE (which can either be used in list form or alone)
106   so I'm not 100% sure that the behavior above is actually illegal.
107   But I'm 90+% sure, and the following related behavior,
108         (TYPEP 11 'AND) => T
109   treating the bare symbol AND as equivalent to '(AND), is specifically
110   forbidden (by the ANSI specification of the AND type).
111
112 11:
113   It would be nice if the
114         caught ERROR:
115           (during macroexpansion)
116   said what macroexpansion was at fault, e.g.
117         caught ERROR:
118           (during macroexpansion of IN-PACKAGE,
119           during macroexpansion of DEFFOO)
120
121 14:
122   The ANSI syntax for non-STANDARD method combination types in CLOS is
123         (DEFGENERIC FOO (X) (:METHOD-COMBINATION PROGN))
124         (DEFMETHOD FOO PROGN ((X BAR)) (PRINT 'NUMBER))
125   If you mess this up, omitting the PROGN qualifier in in DEFMETHOD,
126         (DEFGENERIC FOO (X) (:METHOD-COMBINATION PROGN))
127         (DEFMETHOD FOO ((X BAR)) (PRINT 'NUMBER))
128   the error mesage is not easy to understand:
129            INVALID-METHOD-ERROR was called outside the dynamic scope
130         of a method combination function (inside the body of
131         DEFINE-METHOD-COMBINATION or a method on the generic
132         function COMPUTE-EFFECTIVE-METHOD).
133   It would be better if it were more informative, a la
134            The method combination type for this method (STANDARD) does
135         not match the method combination type for the generic function
136         (PROGN).
137   Also, after you make the mistake of omitting the PROGN qualifier
138   on a DEFMETHOD, doing a new DEFMETHOD with the correct qualifier
139   no longer works:
140         (DEFMETHOD FOO PROGN ((X BAR)) (PRINT 'NUMBER))
141   gives
142            INVALID-METHOD-ERROR was called outside the dynamic scope
143         of a method combination function (inside the body of
144         DEFINE-METHOD-COMBINATION or a method on the generic
145         function COMPUTE-EFFECTIVE-METHOD).
146   This is not very helpful..
147
148 15:
149   (SUBTYPEP '(FUNCTION (T BOOLEAN) NIL)
150             '(FUNCTION (FIXNUM FIXNUM) NIL)) => T, T
151   (Also, when this is fixed, we can enable the code in PROCLAIM which 
152   checks for incompatible FTYPE redeclarations.)
153
154 18:
155   from DTC on the CMU CL mailing list 25 Feb 2000:
156 ;;; Compiler fails when this file is compiled.
157 ;;;
158 ;;; Problem shows up in delete-block within ir1util.lisp. The assertion
159 ;;; (assert (member (functional-kind lambda) '(:let :mv-let :assignment)))
160 ;;; fails within bind node branch.
161 ;;;
162 ;;; Note that if c::*check-consistency* is enabled then an un-reached
163 ;;; entry is also reported.
164 ;;;
165 (defun foo (val)
166   (declare (values nil))
167   nil)
168 (defun bug (val)
169   (multiple-value-call
170       #'(lambda (res)
171           (block nil
172             (tagbody
173              loop
174                (when res
175                  (return nil))
176                (go loop))))
177     (foo val))
178   (catch 'ccc1
179     (throw 'ccc1
180       (block bbbb
181         (tagbody
182
183            (let ((ttt #'(lambda () (go cccc))))
184              (declare (special ttt))
185              (return-from bbbb nil))
186
187          cccc
188            (return-from bbbb nil))))))
189
190 19:
191   (I *think* this is a bug. It certainly seems like strange behavior. But
192   the ANSI spec is scary, dark, and deep..)
193     (FORMAT NIL  "~,1G" 1.4) => "1.    "
194     (FORMAT NIL "~3,1G" 1.4) => "1.    "
195
196 20:
197   from Marco Antoniotti on cmucl-imp mailing list 1 Mar 2000:
198         (defclass ccc () ())
199         (setf (find-class 'ccc1) (find-class 'ccc))
200         (defmethod zut ((c ccc1)) 123)
201   DTC's recommended workaround from the mailing list 3 Mar 2000:
202         (setf (pcl::find-class 'ccc1) (pcl::find-class 'ccc))
203
204 22:
205   The ANSI spec, in section "22.3.5.2 Tilde Less-Than-Sign: Logical Block",
206   says that an error is signalled if ~W, ~_, ~<...~:>, ~I, or ~:T is used
207   inside "~<..~>" (without the colon modifier on the closing syntax).
208   However, SBCL doesn't do this:
209         * (FORMAT T "~<munge~wegnum~>" 12)
210         munge12egnum
211         NIL
212
213 23:
214   When too many files are opened, OPEN will fail with an
215   uninformative error message 
216         error in function OPEN: error opening #P"/tmp/foo.lisp": NIL
217   instead of saying that too many files are open.
218
219 24:
220   Right now, when COMPILE-FILE has a read error, it actually pops
221   you into the debugger before giving up on the file. It should
222   instead handle the error, perhaps issuing (and handling)
223   a secondary error "caught ERROR: unrecoverable error during compilation"
224   and then return with FAILURE-P true,
225
226 26:
227   reported by Sam Steingold on the cmucl-imp mailing list 12 May 2000:
228
229 Also, there is another bug: `array-displacement' should return an array
230 or nil as first value (as per ANSI CL), while CMUCL declares it as
231 returning an array as first value always.
232
233 27:
234   Sometimes (SB-EXT:QUIT) fails with 
235         Argh! maximum interrupt nesting depth (4096) exceeded, exiting
236         Process inferior-lisp exited abnormally with code 1
237   I haven't noticed a repeatable case of this yet.
238
239 29:
240   some sort of bug in inlining and RETURN-FROM in sbcl-0.6.5: Compiling
241     (DEFUN BAR? (X)
242       (OR (NAR? X)
243           (BLOCK USED-BY-SOME-Y?
244             (FLET ((FROB (STK)
245                      (DOLIST (Y STK)
246                        (UNLESS (REJECTED? Y)
247                          (RETURN-FROM USED-BY-SOME-Y? T)))))
248               (DECLARE (INLINE FROB))
249               (FROB (RSTK X))
250               (FROB (MRSTK X)))
251             NIL)))
252   gives
253    error in function SB-KERNEL:ASSERT-ERROR:
254    The assertion (EQ (SB-C::CONTINUATION-KIND SB-C::CONT) :BLOCK-START) failed.
255   This is still present in sbcl-0.6.8.
256
257 31:
258   In some cases the compiler believes type declarations on array
259   elements without checking them, e.g.
260         (DECLAIM (OPTIMIZE (SAFETY 3) (SPEED 1) (SPACE 1)))
261         (DEFSTRUCT FOO A B)
262         (DEFUN BAR (X)
263           (DECLARE (TYPE (SIMPLE-ARRAY CONS 1) X))
264           (WHEN (CONSP (AREF X 0))
265             (PRINT (AREF X 0))))
266         (BAR (VECTOR (MAKE-FOO :A 11 :B 12)))
267   prints
268         #S(FOO :A 11 :B 12) 
269   in SBCL 0.6.5 (and also in CMU CL 18b). This does not happen for
270   all cases, e.g. the type assumption *is* checked if the array
271   elements are declared to be of some structure type instead of CONS.
272
273 32:
274   The printer doesn't report closures very well. This is true in 
275   CMU CL 18b as well:
276     (PRINT #'CLASS-NAME)
277   gives
278     #<Closure Over Function "DEFUN STRUCTURE-SLOT-ACCESSOR" {134D1A1}>
279   It would be nice to make closures have a settable name slot,
280   and make things like DEFSTRUCT and FLET, which create closures,
281   set helpful values into this slot.
282
283 33:
284   And as long as we're wishing, it would be awfully nice if INSPECT could
285   also report on closures, telling about the values of the bound variables.
286
287 35:
288   The compiler assumes that any time a function of declared FTYPE
289   doesn't signal an error, its arguments were of the declared type.
290   E.g. compiling and loading
291     (DECLAIM (OPTIMIZE (SAFETY 3)))
292     (DEFUN FACTORIAL (X) (GAMMA (1+ X)))
293     (DECLAIM (FTYPE (FUNCTION (UNSIGNED-BYTE) FACTORIAL)))
294     (DEFUN FOO (X)
295       (COND ((> (FACTORIAL X) 1.0E6)
296              (FORMAT T "too big~%"))
297             ((INTEGERP X)
298              (FORMAT T "exactly ~S~%" (FACTORIAL X)))
299             (T
300              (FORMAT T "approximately ~S~%" (FACTORIAL X)))))
301   then executing
302     (FOO 1.5)
303   will cause the INTEGERP case to be selected, giving bogus output a la
304     exactly 1.33..
305   This violates the "declarations are assertions" principle.
306   According to the ANSI spec, in the section "System Class FUNCTION",
307   this is a case of "lying to the compiler", but the lying is done
308   by the code which calls FACTORIAL with non-UNSIGNED-BYTE arguments,
309   not by the unexpectedly general definition of FACTORIAL. In any case,
310   "declarations are assertions" means that lying to the compiler should
311   cause an error to be signalled, and should not cause a bogus
312   result to be returned. Thus, the compiler should not assume
313   that arbitrary functions check their argument types. (It might
314   make sense to add another flag (CHECKED?) to DEFKNOWN to 
315   identify functions which *do* check their argument types.)
316
317 38:
318   DEFMETHOD doesn't check the syntax of &REST argument lists properly,
319   accepting &REST even when it's not followed by an argument name:
320         (DEFMETHOD FOO ((X T) &REST) NIL)
321
322 41:
323   TYPEP of VALUES types is sometimes implemented very inefficiently, e.g. in 
324         (DEFTYPE INDEXOID () '(INTEGER 0 1000))
325         (DEFUN FOO (X)
326           (DECLARE (TYPE INDEXOID X))
327           (THE (VALUES INDEXOID)
328             (VALUES X)))
329   where the implementation of the type check in function FOO 
330   includes a full call to %TYPEP. There are also some fundamental problems
331   with the interpretation of VALUES types (inherited from CMU CL, and
332   from the ANSI CL standard) as discussed on the cmucl-imp@cons.org
333   mailing list, e.g. in Robert Maclachlan's post of 21 Jun 2000.
334
335 42:
336   The definitions of SIGCONTEXT-FLOAT-REGISTER and
337   %SET-SIGCONTEXT-FLOAT-REGISTER in x86-vm.lisp say they're not
338   supported on FreeBSD because the floating point state is not saved,
339   but at least as of FreeBSD 4.0, the floating point state *is* saved,
340   so they could be supported after all. Very likely 
341   SIGCONTEXT-FLOATING-POINT-MODES could now be supported, too.
342
343 43:
344   (as discussed by Douglas Crosher on the cmucl-imp mailing list ca. 
345   Aug. 10, 2000): CMUCL currently interprets 'member as '(member); same
346   issue with 'union, 'and, 'or etc. So even though according to the
347   ANSI spec, bare 'MEMBER, 'AND, and 'OR are not legal types, CMUCL
348   (and now SBCL) interpret them as legal types.
349
350 44:
351   ANSI specifies DEFINE-SYMBOL-MACRO, but it's not defined in SBCL.
352   CMU CL added it ca. Aug 13, 2000, after some discussion on the mailing
353   list, and it is probably possible to use substantially the same 
354   patches to add it to SBCL.
355
356 45:
357   a slew of floating-point-related errors reported by Peter Van Eynde
358   on July 25, 2000:
359         a: (fixed in sbcl-0.6.11.25)
360         b: SBCL's value for LEAST-POSITIVE-SHORT-FLOAT is bogus, and 
361            should probably be 1.4012985e-45. In SBCL,
362            (/ LEAST-POSITIVE-SHORT-FLOAT 2) returns a number smaller
363            than LEAST-POSITIVE-SHORT-FLOAT. Similar problems 
364            exist for LEAST-NEGATIVE-SHORT-FLOAT, LEAST-POSITIVE-LONG-FLOAT,
365            and LEAST-NEGATIVE-LONG-FLOAT.
366         c: Many expressions generate floating infinity:
367                 (/ 1 0.0)
368                 (/ 1 0.0d0)
369                 (EXPT 10.0 1000)
370                 (EXPT 10.0d0 1000)
371            PVE's regression tests want them to raise errors. SBCL
372            generates the infinities instead, which may or may not be
373            conforming behavior.
374         d: (in section12.erg) various forms a la 
375                 (FLOAT 1 DOUBLE-FLOAT-EPSILON)
376            don't give the right behavior.
377
378 46:
379   type safety errors reported by Peter Van Eynde July 25, 2000:
380         a: (COERCE (QUOTE (A B C)) (QUOTE (VECTOR * 4)))
381            => #(A B C)
382            In general lengths of array type specifications aren't
383            checked by COERCE, so it fails when the spec is
384            (VECTOR 4), (STRING 2), (SIMPLE-BIT-VECTOR 3), or whatever.
385         b: CONCATENATE has the same problem of not checking the length
386            of specified output array types. MAKE-SEQUENCE and MAP and
387            MERGE also have the same problem.
388         c: (COERCE 'AND 'FUNCTION) returns something related to
389            (MACRO-FUNCTION 'AND), but ANSI says it should raise an error.
390         d: ELT signals SIMPLE-ERROR if its index argument
391            isn't a valid index for its sequence argument, but should 
392            signal TYPE-ERROR instead.
393         e: FILE-LENGTH is supposed to signal a type error when its
394            argument is not a stream associated with a file, but doesn't.
395         f: (FLOAT-RADIX 2/3) should signal an error instead of 
396            returning 2.
397         g: (LOAD "*.lsp") should signal FILE-ERROR.
398         h: (MAKE-CONCATENATED-STREAM (MAKE-STRING-OUTPUT-STREAM))
399            should signal TYPE-ERROR.
400         i: MAKE-TWO-WAY-STREAM doesn't check that its arguments can
401            be used for input and output as needed. It should fail with
402            TYPE-ERROR when handed e.g. the results of
403            MAKE-STRING-INPUT-STREAM or MAKE-STRING-OUTPUT-STREAM in
404            the inappropriate positions, but doesn't.
405         j: (PARSE-NAMESTRING (COERCE (LIST #\f #\o #\o (CODE-CHAR 0) #\4 #\8)
406                             (QUOTE STRING)))
407            should probably signal an error instead of making a pathname with
408            a null byte in it.
409         k: READ-BYTE is supposed to signal TYPE-ERROR when its argument is 
410            not a binary input stream, but instead cheerfully reads from
411            character streams, e.g. (MAKE-STRING-INPUT-STREAM "abc").
412
413 47:
414   DEFCLASS bugs reported by Peter Van Eynde July 25, 2000:
415         a: (DEFCLASS FOO () (A B A)) should signal a PROGRAM-ERROR, and
416            doesn't.
417         b: (DEFCLASS FOO () (A B A) (:DEFAULT-INITARGS X A X B)) should
418            signal a PROGRAM-ERROR, and doesn't.
419         c: (DEFCLASS FOO07 NIL ((A :ALLOCATION :CLASS :ALLOCATION :CLASS))),
420            and other DEFCLASS forms with duplicate specifications in their
421            slots, should signal a PROGRAM-ERROR, and doesn't.
422         d: (DEFGENERIC IF (X)) should signal a PROGRAM-ERROR, but instead
423            causes a COMPILER-ERROR.
424
425 48:
426   SYMBOL-MACROLET bugs reported by Peter Van Eynde July 25, 2000:
427         a: (SYMBOL-MACROLET ((T TRUE)) ..) should probably signal
428            PROGRAM-ERROR, but SBCL accepts it instead.
429         b: SYMBOL-MACROLET should refuse to bind something which is
430            declared as a global variable, signalling PROGRAM-ERROR.
431         c: SYMBOL-MACROLET should signal PROGRAM-ERROR if something
432            it binds is declared SPECIAL inside.
433
434 49:
435   LOOP bugs reported by Peter Van Eynde July 25, 2000:
436         a: (LOOP WITH (A B) DO (PRINT 1)) is a syntax error according to
437            the definition of WITH clauses given in the ANSI spec, but
438            compiles and runs happily in SBCL.
439         b: a messy one involving package iteration:
440 interpreted Form: (LET ((PACKAGE (MAKE-PACKAGE "LOOP-TEST"))) (INTERN "blah" PACKAGE) (LET ((BLAH2 (INTERN "blah2" PACKAGE))) (EXPORT BLAH2 PACKAGE)) (LIST (SORT (LOOP FOR SYM BEING EACH PRESENT-SYMBOL OF PACKAGE FOR SYM-NAME = (SYMBOL-NAME SYM) COLLECT SYM-NAME) (FUNCTION STRING<)) (SORT (LOOP FOR SYM BEING EACH EXTERNAL-SYMBOL OF PACKAGE FOR SYM-NAME = (SYMBOL-NAME SYM) COLLECT SYM-NAME) (FUNCTION STRING<))))
441 Should be: (("blah" "blah2") ("blah2"))
442 SBCL: (("blah") ("blah2"))
443         * (LET ((X 1)) (LOOP FOR I BY (INCF X) FROM X TO 10 COLLECT I))
444           doesn't work -- SBCL's LOOP says BY isn't allowed in a FOR clause.
445
446 50:
447   type system errors reported by Peter Van Eynde July 25, 2000:
448         a: (SUBTYPEP 'BIGNUM 'INTEGER) => NIL, NIL
449            but should be (VALUES T T) instead.
450         b: (SUBTYPEP 'EXTENDED-CHAR 'CHARACTER) => NIL, NIL
451            but should be (VALUES T T) instead.
452         c: (SUBTYPEP '(INTEGER (0) (0)) 'NIL) dies with nested errors.
453         d: In general, the system doesn't like '(INTEGER (0) (0)) -- it
454            blows up at the level of SPECIFIER-TYPE with
455            "Lower bound (0) is greater than upper bound (0)." Probably
456            SPECIFIER-TYPE should return NIL instead.
457         e: (TYPEP 0 '(COMPLEX (EQL 0)) fails with
458            "Component type for Complex is not numeric: (EQL 0)."
459            This might be easy to fix; the type system already knows
460            that (SUBTYPEP '(EQL 0) 'NUMBER) is true.
461         f: The type system doesn't know about the condition system,
462            so that e.g. (TYPEP 'SIMPLE-ERROR 'ERROR)=>NIL.
463         g: The type system isn't all that smart about relationships
464            between hairy types, as shown in the type.erg test results,
465            e.g. (SUBTYPEP 'CONS '(NOT ATOM)) => NIL, NIL.
466
467 51:
468   miscellaneous errors reported by Peter Van Eynde July 25, 2000:
469         a: (PROGN
470             (DEFGENERIC FOO02 (X))
471             (DEFMETHOD FOO02 ((X NUMBER)) T)
472             (LET ((M (FIND-METHOD (FUNCTION FOO02)
473                                   NIL
474                                   (LIST (FIND-CLASS (QUOTE NUMBER))))))
475               (REMOVE-METHOD (FUNCTION FOO02) M)
476               (DEFGENERIC FOO03 (X))
477               (ADD-METHOD (FUNCTION FOO03) M)))
478            should give an error, but SBCL allows it.
479         b: READ should probably return READER-ERROR, not the bare 
480            arithmetic error, when input a la "1/0" or "1e1000" causes
481            an arithmetic error.
482
483 52:
484   It has been reported (e.g. by Peter Van Eynde) that there are 
485   several metaobject protocol "errors". (In order to fix them, we might
486   need to document exactly what metaobject protocol specification
487   we're following -- the current code is just inherited from PCL.)
488
489 53:
490   another error from Peter Van Eynde 5 September 2000:
491   (FORMAT NIL "~F" "FOO") should work, but instead reports an error.
492   PVE submitted a patch to deal with this bug, but it exposes other
493   comparably serious bugs, so I didn't apply it. It looks as though
494   the FORMAT code needs a fair amount of rewriting in order to comply
495   with the various details of the ANSI spec.
496
497 54:
498   The implementation of #'+ returns its single argument without
499   type checking, e.g. (+ "illegal") => "illegal".
500
501 55:
502   In sbcl-0.6.7, there is no doc string for CL:PUSH, probably 
503   because it's defined with the DEFMACRO-MUNDANELY macro and something
504   is wrong with doc string setting in that macro.
505
506 56:
507   Attempting to use COMPILE on something defined by DEFMACRO fails:
508         (DEFMACRO FOO (X) (CONS X X))
509         (COMPILE 'FOO)
510 Error in function C::GET-LAMBDA-TO-COMPILE:
511    #<Closure Over Function "DEFUN (SETF MACRO-FUNCTION)" {480E21B1}> was defined in a non-null environment.
512
513 58:
514   (SUBTYPEP '(AND ZILCH INTEGER) 'ZILCH) => NIL, NIL
515   Note: I looked into fixing this in 0.6.11.15, but gave up. The
516   problem seems to be that there are two relevant type methods for
517   the subtypep operation, HAIRY :COMPLEX-SUBTYPEP-ARG2 and
518   INTERSECTION :COMPLEX-SUBTYPEP-ARG1, and only the first is
519   called. This could be fixed, but type dispatch is messy and
520   confusing enough already, I don't want to complicate it further.
521   Perhaps someday we can make CLOS cross-compiled (instead of compiled
522   after bootstrapping) so that we don't need to have the type system
523   available before CLOS, and then we can rewrite the type methods to
524   CLOS methods, and then expressing the solutions to stuff like this
525   should become much more straightforward. -- WHN 2001-03-14
526
527 59:
528   CL:*DEFAULT-PATHNAME-DEFAULTS* doesn't behave as ANSI suggests (reflecting
529   current working directory). And there's no supported way to update
530   or query the current working directory (a la Unix "chdir" and "pwd"),
531   which is functionality that ILISP needs (and currently gets with low-level
532   hacks).
533
534 60:
535   The debugger LIST-LOCATIONS command doesn't work properly.
536
537 61:
538   Compiling and loading
539     (DEFUN FAIL (X) (THROW 'FAIL-TAG X))
540     (FAIL 12)
541   then requesting a BACKTRACE at the debugger prompt gives no information
542   about where in the user program the problem occurred.
543
544 62:
545   The compiler is supposed to do type inference well enough that 
546   the declaration in
547     (TYPECASE X
548       ((SIMPLE-ARRAY SINGLE-FLOAT)
549        (LOCALLY
550          (DECLARE (TYPE (SIMPLE-ARRAY SINGLE-FLOAT) X))
551          ..))
552       ..)
553   is redundant. However, as reported by Juan Jose Garcia Ripoll for
554   CMU CL, it sometimes doesn't. Adding declarations is a pretty good
555   workaround for the problem for now, but can't be done by the TYPECASE
556   macros themselves, since it's too hard for the macro to detect
557   assignments to the variable within the clause. 
558     Note: The compiler *is* smart enough to do the type inference in
559   many cases. This case, derived from a couple of MACROEXPAND-1
560   calls on Ripoll's original test case,
561     (DEFUN NEGMAT (A)
562       (DECLARE (OPTIMIZE SPEED (SAFETY 0)))
563       (COND ((TYPEP A '(SIMPLE-ARRAY SINGLE-FLOAT)) NIL
564              (LET ((LENGTH (ARRAY-TOTAL-SIZE A)))
565                (LET ((I 0) (G2554 LENGTH))
566                  (DECLARE (TYPE REAL G2554) (TYPE REAL I))
567                  (TAGBODY
568                   SB-LOOP::NEXT-LOOP
569                   (WHEN (>= I G2554) (GO SB-LOOP::END-LOOP))
570                   (SETF (ROW-MAJOR-AREF A I) (- (ROW-MAJOR-AREF A I)))
571                   (GO SB-LOOP::NEXT-LOOP)
572                   SB-LOOP::END-LOOP))))))
573   demonstrates the problem; but the problem goes away if the TAGBODY
574   and GO forms are removed (leaving the SETF in ordinary, non-looping
575   code), or if the TAGBODY and GO forms are retained, but the 
576   assigned value becomes 0.0 instead of (- (ROW-MAJOR-AREF A I)).
577
578 63:
579   Paul Werkowski wrote on cmucl-imp@cons.org 2000-11-15
580     I am looking into this problem that showed up on the cmucl-help
581     list. It seems to me that the "implementation specific environment
582     hacking functions" found in pcl/walker.lisp are completely messed
583     up. The good thing is that they appear to be barely used within
584     PCL and the munged environment object is passed to cmucl only
585     in calls to macroexpand-1, which is probably why this case fails.
586   SBCL uses essentially the same code, so if the environment hacking
587   is screwed up, it affects us too.
588
589 64:
590   Using the pretty-printer from the command prompt gives funny
591   results, apparently because the pretty-printer doesn't know
592   about user's command input, including the user's carriage return
593   that the user, and therefore the pretty-printer thinks that
594   the new output block should start indented 2 or more characters
595   rightward of the correct location.
596
597 65:
598   (probably related to bug #70)
599   As reported by Carl Witty on submit@bugs.debian.org 1999-05-08,
600   compiling this file
601 (in-package "CL-USER")
602 (defun equal-terms (termx termy)
603   (labels
604     ((alpha-equal-bound-term-lists (listx listy)
605        (or (and (null listx) (null listy))
606            (and listx listy
607                 (let ((bindings-x (bindings-of-bound-term (car listx)))
608                       (bindings-y (bindings-of-bound-term (car listy))))
609                   (if (and (null bindings-x) (null bindings-y))
610                       (alpha-equal-terms (term-of-bound-term (car listx))
611                                          (term-of-bound-term (car listy)))
612                       (and (= (length bindings-x) (length bindings-y))
613                            (prog2
614                                (enter-binding-pairs (bindings-of-bound-term (car listx))
615                                                     (bindings-of-bound-term (car listy)))
616                                (alpha-equal-terms (term-of-bound-term (car listx))
617                                                   (term-of-bound-term (car listy)))
618                              (exit-binding-pairs (bindings-of-bound-term (car listx))
619                                                  (bindings-of-bound-term (car listy)))))))
620                 (alpha-equal-bound-term-lists (cdr listx) (cdr listy)))))
621
622      (alpha-equal-terms (termx termy)
623        (if (and (variable-p termx)
624                 (variable-p termy))
625            (equal-bindings (id-of-variable-term termx)
626                            (id-of-variable-term termy))
627            (and (equal-operators-p (operator-of-term termx) (operator-of-term termy))
628                 (alpha-equal-bound-term-lists (bound-terms-of-term termx)
629                                               (bound-terms-of-term termy))))))
630
631     (or (eq termx termy)
632         (and termx termy
633              (with-variable-invocation (alpha-equal-terms termx termy))))))
634   causes an assertion failure
635     The assertion (EQ (C::LAMBDA-TAIL-SET C::CALLER)
636                       (C::LAMBDA-TAIL-SET (C::LAMBDA-HOME C::CALLEE))) failed.
637
638   Bob Rogers reports (1999-07-28 on cmucl-imp@cons.org) a smaller test
639   case with the same problem:
640 (defun parse-fssp-alignment ()
641   ;; Given an FSSP alignment file named by the argument . . .
642   (labels ((get-fssp-char ()
643              (get-fssp-char))
644            (read-fssp-char ()
645              (get-fssp-char)))
646     ;; Stub body, enough to tickle the bug.
647     (list (read-fssp-char)
648           (read-fssp-char))))
649
650 66:
651   ANSI specifies that the RESULT-TYPE argument of CONCATENATE must be
652   a subtype of SEQUENCE, but CONCATENATE doesn't check this properly:
653     (CONCATENATE 'SIMPLE-ARRAY #(1 2) '(3)) => #(1 2 3)
654   This also leads to funny behavior when derived type specifiers
655   are used, as originally reported by Milan Zamazal for CMU CL (on the
656   Debian bugs mailing list (?) 2000-02-27), then reported by Martin
657   Atzmueller for SBCL (2000-10-01 on sbcl-devel@lists.sourceforge.net):
658     (DEFTYPE FOO () 'SIMPLE-ARRAY)
659     (CONCATENATE 'FOO #(1 2) '(3)) 
660       => #<ARRAY-TYPE SIMPLE-ARRAY> is a bad type specifier for
661            sequence functions.
662   The derived type specifier FOO should act the same way as the 
663   built-in type SIMPLE-ARRAY here, but it doesn't. That problem
664   doesn't seem to exist for sequence types:
665     (DEFTYPE BAR () 'SIMPLE-VECTOR)
666     (CONCATENATE 'BAR #(1 2) '(3)) => #(1 2 3)
667
668 67:
669   As reported by Winton Davies on a CMU CL mailing list 2000-01-10,
670   and reported for SBCL by Martin Atzmueller 2000-10-20: (TRACE GETHASH)
671   crashes SBCL. In general tracing anything which is used in the 
672   implementation of TRACE is likely to have the same problem.
673
674 68: 
675   As reported by Daniel Solaz on cmucl-help@cons.org 2000-11-23,
676   SXHASH returns the same value for all non-STRUCTURE-OBJECT instances,
677   notably including all PCL instances. There's a limit to how much
678   SXHASH can do to return unique values for instances, but at least
679   it should probably look at the class name, the way that it does
680   for STRUCTURE-OBJECTs.
681
682 69:
683   As reported by Martin Atzmueller on the sbcl-devel list 2000-11-22,
684   > There remains one issue, that is a bug in SBCL:
685   > According to my interpretation of the spec, the ":" and "@" modifiers
686   > should appear _after_ the comma-seperated arguments.
687   > Well, SBCL (and CMUCL for that matter) accept 
688   > (ASSERT (STRING= (FORMAT NIL "~:8D" 1) "   1"))
689   > where the correct way (IMHO) should be
690   > (ASSERT (STRING= (FORMAT NIL "~8:D" 1) "   1"))
691   Probably SBCL should stop accepting the "~:8D"-style format arguments,
692   or at least issue a warning.
693
694 70:
695   (probably related to bug #65)
696   The compiler doesn't like &OPTIONAL arguments in LABELS and FLET
697   forms. E.g.
698     (DEFUN FIND-BEFORE (ITEM SEQUENCE &KEY (TEST #'EQL))
699       (LABELS ((FIND-ITEM (OBJ SEQ TEST &OPTIONAL (VAL NIL))
700                  (LET ((ITEM (FIRST SEQ)))
701                    (COND ((NULL SEQ)
702                           (VALUES NIL NIL))
703                          ((FUNCALL TEST OBJ ITEM)
704                           (VALUES VAL SEQ))
705                          (T     
706                           (FIND-ITEM OBJ (REST SEQ) TEST (NCONC VAL `(,ITEM))))))))
707       (FIND-ITEM ITEM SEQUENCE TEST)))
708   from David Young's bug report on cmucl-help@cons.org 30 Nov 2000
709   causes sbcl-0.6.9 to fail with
710     error in function SB-KERNEL:ASSERT-ERROR:
711        The assertion (EQ (SB-C::LAMBDA-TAIL-SET SB-C::CALLER)
712                          (SB-C::LAMBDA-TAIL-SET
713                           (SB-C::LAMBDA-HOME SB-C::CALLEE))) failed.
714
715 71: 
716   (DECLAIM (OPTIMIZE ..)) doesn't work. E.g. even after 
717   (DECLAIM (OPTIMIZE (SPEED 3))), things are still optimized with
718   the previous SPEED policy. This bug will probably get fixed in
719   0.6.9.x in a general cleanup of optimization policy.
720
721 72:
722   (DECLAIM (OPTIMIZE ..)) doesn't work properly inside LOCALLY forms.
723
724 74:
725   As noted in the ANSI specification for COERCE, (COERCE 3 'COMPLEX)
726   gives a result which isn't COMPLEX. The result type optimizer
727   for COERCE doesn't know this, perhaps because it was written before
728   ANSI threw this curveball: the optimizer thinks that COERCE always
729   returns a result of the specified type. Thus while the interpreted
730   function
731      (DEFUN TRICKY (X) (TYPEP (COERCE X 'COMPLEX) 'COMPLEX))
732   returns the correct result,
733      (TRICKY 3) => NIL
734   the compiled function
735      (COMPILE 'TRICKY)
736   does not:
737      (TRICKY 3) => T
738
739 75:
740   As reported by Martin Atzmueller on sbcl-devel 26 Dec 2000,
741   ANSI says that WITH-OUTPUT-TO-STRING should have a keyword
742   :ELEMENT-TYPE, but in sbcl-0.6.9 this is not defined for
743   WITH-OUTPUT-TO-STRING.
744
745 78:
746   ANSI says in one place that type declarations can be abbreviated even
747   when the type name is not a symbol, e.g.
748     (DECLAIM ((VECTOR T) *FOOVECTOR*))
749   SBCL doesn't support this. But ANSI says in another place that this
750   isn't allowed. So it's not clear this is a bug after all. (See the
751   e-mail on cmucl-help@cons.org on 2001-01-16 and 2001-01-17 from WHN
752   and Pierre Mai.)
753
754 79:
755   as pointed out by Dan Barlow on sbcl-devel 2000-07-02:
756   The PICK-TEMPORARY-FILE-NAME utility used by LOAD-FOREIGN uses
757   an easily guessable temporary filename in a way which might open
758   applications using LOAD-FOREIGN to hijacking by malicious users
759   on the same machine. Incantations for doing this safely are
760   floating around the net in various "how to write secure programs
761   despite Unix" documents, and it would be good to (1) fix this in 
762   LOAD-FOREIGN, and (2) hunt for any other code which uses temporary
763   files and make it share the same new safe logic.
764
765 80:
766   (fixed early Feb 2001 by MNA)
767
768 81:
769   As reported by wbuss@TELDA.NET (Wolfhard Buss) on cmucl-help
770   2001-02-14, 
771     According to CLHS
772          (loop with (a . b) of-type float = '(0.0 . 1.0)
773            and (c . d) of-type float = '(2.0 . 3.0)
774            return (list a b c d))
775     should evaluate to (0.0 1.0 2.0 3.0). cmucl-18c disagrees and
776     invokes the debugger: "B is not of type list".
777   SBCL does the same thing.
778
779 82: 
780   Functions are assigned names based on the context in which they're
781   defined. This is less than ideal for the functions which are
782   used to implement CLOS methods. E.g. the output of 
783   (DESCRIBE 'PRINT-OBJECT) lists functions like 
784         #<FUNCTION "DEF!STRUCT (TRACE-INFO (:MAKE-LOAD-FORM-FUN SB-KERNEL:JUST-DUMP-IT-NORMALLY) (:PRINT-OBJECT #))" {1020E49}> 
785   and
786         #<FUNCTION "MACROLET ((FORCE-DELAYED-DEF!METHODS NIL #))" {1242871}>
787   It would be better if these functions' names always identified
788   them as methods, and identified their generic functions and
789   specializers.
790
791 83:
792   RANDOM-INTEGER-EXTRA-BITS=10 may not be large enough for the RANDOM
793   RNG to be high quality near RANDOM-FIXNUM-MAX; it looks as though
794   the mean of the distribution can be systematically O(0.1%) wrong.
795   Just increasing R-I-E-B is probably not a good solution, since
796   it would decrease efficiency more than is probably necessary. Perhaps
797   using some sort of accept/reject method would be better.
798
799 84:
800   (SUBTYPEP '(SATISFIES SOME-UNDEFINED-FUN) NIL)=>NIL,T (should be NIL,NIL)
801
802 85:
803   Internally the compiler sometimes evaluates
804     (sb-kernel:type/= (specifier-type '*) (specifier-type t))
805   (I stumbled across this when I added an
806     (assert (not (eq type1 *wild-type*)))
807   in the NAMED :SIMPLE-= type method.) '* isn't really a type, and
808   in a type context should probably be translated to T, and so it's
809   probably to ask whether it's equal to the T type and then (using the
810   EQ type comparison in the NAMED :SIMPLE-= type method) return NIL.
811   (I haven't tried to investigate this bug enough to guess whether
812   there might be any user-level symptoms.)
813
814 90: 
815   a latent cross-compilation/bootstrapping bug: The cross-compilation
816   host's CL:CHAR-CODE-LIMIT is used in target code in readtable.lisp
817   and possibly elsewhere. Instead, we should use the target system's
818   CHAR-CODE-LIMIT. This will probably cause problems if we try to 
819   bootstrap on a system which uses a different value of CHAR-CODE-LIMIT
820   than SBCL does.
821
822 91:
823   (subtypep '(or (integer -1 1)
824                  unsigned-byte)
825             '(or (rational -1 7)
826                  unsigned-byte
827                  (integer -1 1))) => NIL,T
828   An analogous problem with SINGLE-FLOAT and REAL types was fixed in 
829   sbcl-0.6.11.22, but some peculiarites of the RATIO type make it 
830   awkward to generalize the fix to INTEGER and RATIONAL. It's not 
831   clear what's the best fix. (See the "bug in type handling" discussion
832   on cmucl-imp ca. 2001-03-22 and ca. 2001-02-12.)
833
834 93:
835   In sbcl-0.6.11.26, (COMPILE 'IN-HOST-COMPILATION-MODE) in
836   src/cold/shared.lisp doesn't correctly translate the
837   interpreted function
838     (defun in-host-compilation-mode (fn)
839       (let ((*features* (cons :sb-xc-host *features*))
840             ;; the CROSS-FLOAT-INFINITY-KLUDGE, as documented in
841             ;; base-target-features.lisp-expr:
842             (*shebang-features* (set-difference *shebang-features*
843                                                 '(:sb-propagate-float-type
844                                                   :sb-propagate-fun-type))))
845         (with-additional-nickname ("SB-XC" "SB!XC")
846           (funcall fn))))
847   No error is reported by the compiler, but when the function is executed,
848   it causes an error
849     TYPE-ERROR in SB-KERNEL::OBJECT-NOT-TYPE-ERROR-HANDLER:
850       (:LINUX :X86 :IEEE-FLOATING-POINT :SB-CONSTRAIN-FLOAT-TYPE :SB-TEST
851        :SB-INTERPRETER :SB-DOC :UNIX ...) is not of type SYMBOL.
852
853 94a: 
854   Inconsistencies between derived and declared VALUES return types for
855   DEFUN aren't checked very well. E.g. the logic which successfully
856   catches problems like
857     (declaim (ftype (function (fixnum) float) foo))
858     (defun foo (x)
859       (declare (type integer x))
860       (values x)) ; wrong return type, detected, gives warning, good!
861   fails to catch
862     (declaim (ftype (function (t) (values t t)) bar))
863     (defun bar (x)
864       (values x)) ; wrong number of return values, no warning, bad!
865   The cause of this is seems to be that (1) the internal function 
866   VALUES-TYPES-EQUAL-OR-INTERSECT used to make the check handles its
867   arguments symmetrically, and (2) when the type checking code was
868   written back when when SBCL's code was still CMU CL, the intent
869   was that this case
870     (declaim (ftype (function (t) t) bar))
871     (defun bar (x)
872       (values x x)) ; wrong number of return values; should give warning?
873   not be warned for, because a two-valued return value is considered
874   to be compatible with callers who expects a single value to be
875   returned. That intent is probably not appropriate for modern ANSI
876   Common Lisp, but fixing this might be complicated because of other
877   divergences between auld-style and new-style handling of
878   multiple-VALUES types. (Some issues related to this were discussed
879   on cmucl-imp at some length sometime in 2000.)
880
881
882 KNOWN BUGS RELATED TO THE IR1 INTERPRETER
883
884 (Note: At some point, the pure interpreter (actually a semi-pure
885 interpreter aka "the IR1 interpreter") will probably go away, replaced
886 by constructs like
887   (DEFUN EVAL (X) (FUNCALL (COMPILE NIL (LAMBDA ..)))))
888 and at that time these bugs should either go away automatically or
889 become more tractable to fix. Until then, they'll probably remain,
890 since some of them aren't considered urgent, and the rest are too hard
891 to fix as long as so many special cases remain. After the IR1
892 interpreter goes away is also the preferred time to start
893 systematically exterminating cases where debugging functionality
894 (backtrace, breakpoint, etc.) breaks down, since getting rid of the
895 IR1 interpreter will reduce the number of special cases we need to
896 support.)
897
898 IR1-1:
899   The FUNCTION special operator doesn't check properly whether its
900   argument is a function name. E.g. (FUNCTION (X Y)) returns a value
901   instead of failing with an error. (Later attempting to funcall the
902   value does cause an error.) 
903
904 IR1-2:
905   COMPILED-FUNCTION-P bogusly reports T for interpreted functions:
906         * (DEFUN FOO (X) (- 12 X))
907         FOO
908         * (COMPILED-FUNCTION-P #'FOO)
909         T
910
911 IR1-3:
912   Executing 
913     (DEFVAR *SUPPRESS-P* T)
914     (EVAL '(UNLESS *SUPPRESS-P*
915              (EVAL-WHEN (:COMPILE-TOPLEVEL :LOAD-TOPLEVEL :EXECUTE)
916                (FORMAT T "surprise!"))))
917   prints "surprise!". Probably the entire EVAL-WHEN mechanism ought to be
918   rewritten from scratch to conform to the ANSI definition, abandoning
919   the *ALREADY-EVALED-THIS* hack which is used in sbcl-0.6.8.9 (and
920   in the original CMU CL source, too). This should be easier to do --
921   though still nontrivial -- once the various IR1 interpreter special
922   cases are gone.
923
924 IR1-3a:
925   EVAL-WHEN's idea of what's a toplevel form is even more screwed up 
926   than the example in IR1-3 would suggest, since COMPILE-FILE and
927   COMPILE both print both "right now!" messages when compiling the
928   following code,
929     (LAMBDA (X)
930       (COND (X
931              (EVAL-WHEN (:COMPILE-TOPLEVEL :LOAD-TOPLEVEL :EXECUTE)
932                (PRINT "yes! right now!"))
933              "yes!")
934             (T
935              (EVAL-WHEN (:COMPILE-TOPLEVEL :LOAD-TOPLEVEL :EXECUTE)
936                (PRINT "no! right now!"))
937              "no!")))
938   and while EVAL doesn't print the "right now!" messages, the first
939   FUNCALL on the value returned by EVAL causes both of them to be printed.
940
941 IR1-4:
942   The system accepts DECLAIM in most places where DECLARE would be 
943   accepted, without even issuing a warning. ANSI allows this, but since
944   it's fairly easy to mistype DECLAIM instead of DECLARE, and the
945   meaning is rather different, and it's unlikely that the user
946   has a good reason for doing DECLAIM not at top level, it would be 
947   good to issue a STYLE-WARNING when this happens. A possible
948   fix would be to issue STYLE-WARNINGs for DECLAIMs not at top level,
949   or perhaps to issue STYLE-WARNINGs for any EVAL-WHEN not at top level.
950   [This is considered an IR1-interpreter-related bug because until
951   EVAL-WHEN is rewritten, which won't happen until after the IR1
952   interpreter is gone, the system's notion of what's a top-level form
953   and what's not will remain too confused to fix this problem.]