0.8.2.55:
[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: "type checking of structure slots"
46   a:
47   ANSI specifies that a type mismatch in a structure slot
48   initialization value should not cause a warning.
49 WORKAROUND:
50   This one might not be fixed for a while because while we're big
51   believers in ANSI compatibility and all, (1) there's no obvious
52   simple way to do it (short of disabling all warnings for type
53   mismatches everywhere), and (2) there's a good portable
54   workaround, and (3) by their own reasoning, it looks as though
55   ANSI may have gotten it wrong. ANSI justifies this specification
56   by saying 
57     The restriction against issuing a warning for type mismatches
58     between a slot-initform and the corresponding slot's :TYPE
59     option is necessary because a slot-initform must be specified
60     in order to specify slot options; in some cases, no suitable
61     default may exist.
62   However, in SBCL (as in CMU CL or, for that matter, any compiler
63   which really understands Common Lisp types) a suitable default
64   does exist, in all cases, because the compiler understands the
65   concept of functions which never return (i.e. has return type NIL).
66   Thus, as a portable workaround, you can use a call to some
67   known-never-to-return function as the default. E.g.
68     (DEFSTRUCT FOO
69       (BAR (ERROR "missing :BAR argument")
70            :TYPE SOME-TYPE-TOO-HAIRY-TO-CONSTRUCT-AN-INSTANCE-OF))
71   or 
72     (DECLAIM (FTYPE (FUNCTION () NIL) MISSING-ARG))
73     (DEFUN REQUIRED-ARG () ; workaround for SBCL non-ANSI slot init typing
74       (ERROR "missing required argument")) 
75     (DEFSTRUCT FOO
76       (BAR (REQUIRED-ARG) :TYPE TRICKY-TYPE-OF-SOME-SORT)
77       (BLETCH (REQUIRED-ARG) :TYPE TRICKY-TYPE-OF-SOME-SORT)
78       (N-REFS-SO-FAR 0 :TYPE (INTEGER 0)))
79   Such code should compile without complaint and work correctly either
80   on SBCL or on any other completely compliant Common Lisp system.
81
82   b: &AUX argument in a boa-constructor without a default value means
83      "do not initilize this slot" and does not cause type error. But
84      an error may be signalled at read time and it would be good if
85      SBCL did it.
86
87   d: (fixed in 0.8.1.5)
88
89 7:
90   The "compiling top-level form:" output ought to be condensed.
91   Perhaps any number of such consecutive lines ought to turn into a
92   single "compiling top-level forms:" line.
93
94 11:
95   It would be nice if the
96         caught ERROR:
97           (during macroexpansion)
98   said what macroexpansion was at fault, e.g.
99         caught ERROR:
100           (during macroexpansion of IN-PACKAGE,
101           during macroexpansion of DEFFOO)
102
103 19:
104   (I *think* this is a bug. It certainly seems like strange behavior. But
105   the ANSI spec is scary, dark, and deep.. -- WHN)
106     (FORMAT NIL  "~,1G" 1.4) => "1.    "
107     (FORMAT NIL "~3,1G" 1.4) => "1.    "
108
109 27:
110   Sometimes (SB-EXT:QUIT) fails with 
111         Argh! maximum interrupt nesting depth (4096) exceeded, exiting
112         Process inferior-lisp exited abnormally with code 1
113   I haven't noticed a repeatable case of this yet.
114
115 32:
116   The printer doesn't report closures very well. This is true in 
117   CMU CL 18b as well:
118     (PRINT #'CLASS-NAME)
119   gives
120     #<Closure Over Function "DEFUN STRUCTURE-SLOT-ACCESSOR" {134D1A1}>
121   It would be nice to make closures have a settable name slot,
122   and make things like DEFSTRUCT and FLET, which create closures,
123   set helpful values into this slot.
124
125 33:
126   And as long as we're wishing, it would be awfully nice if INSPECT could
127   also report on closures, telling about the values of the bound variables.
128
129 35:
130   The compiler assumes that any time a function of declared FTYPE
131   doesn't signal an error, its arguments were of the declared type.
132   E.g. compiling and loading
133     (DECLAIM (OPTIMIZE (SAFETY 3)))
134     (DEFUN FACTORIAL (X) (GAMMA (1+ X)))
135     (DEFUN GAMMA (X) X)
136     (DECLAIM (FTYPE (FUNCTION (UNSIGNED-BYTE)) FACTORIAL))
137     (DEFUN FOO (X)
138       (COND ((> (FACTORIAL X) 1.0E6)
139              (FORMAT T "too big~%"))
140             ((INTEGERP X)
141              (FORMAT T "exactly ~S~%" (FACTORIAL X)))
142             (T
143              (FORMAT T "approximately ~S~%" (FACTORIAL X)))))
144   then executing
145     (FOO 1.5)
146   will cause the INTEGERP case to be selected, giving bogus output a la
147     exactly 2.5
148   This violates the "declarations are assertions" principle.
149   According to the ANSI spec, in the section "System Class FUNCTION",
150   this is a case of "lying to the compiler", but the lying is done
151   by the code which calls FACTORIAL with non-UNSIGNED-BYTE arguments,
152   not by the unexpectedly general definition of FACTORIAL. In any case,
153   "declarations are assertions" means that lying to the compiler should
154   cause an error to be signalled, and should not cause a bogus
155   result to be returned. Thus, the compiler should not assume
156   that arbitrary functions check their argument types. (It might
157   make sense to add another flag (CHECKED?) to DEFKNOWN to 
158   identify functions which *do* check their argument types.)
159   (Also, verify that the compiler handles declared function
160   return types as assertions.)
161
162 42:
163   The definitions of SIGCONTEXT-FLOAT-REGISTER and
164   %SET-SIGCONTEXT-FLOAT-REGISTER in x86-vm.lisp say they're not
165   supported on FreeBSD because the floating point state is not saved,
166   but at least as of FreeBSD 4.0, the floating point state *is* saved,
167   so they could be supported after all. Very likely 
168   SIGCONTEXT-FLOATING-POINT-MODES could now be supported, too.
169
170 45:
171   a slew of floating-point-related errors reported by Peter Van Eynde
172   on July 25, 2000:
173         c: Many expressions generate floating infinity on x86/Linux:
174                 (/ 1 0.0)
175                 (/ 1 0.0d0)
176                 (EXPT 10.0 1000)
177                 (EXPT 10.0d0 1000)
178            PVE's regression tests want them to raise errors. sbcl-0.7.0.5
179            on x86/Linux generates the infinities instead. That might or
180            might not be conforming behavior, but it's also inconsistent,
181            which is almost certainly wrong. (Inconsistency: (/ 1 0.0)
182            should give the same result as (/ 1.0 0.0), but instead (/ 1 0.0)
183            generates SINGLE-FLOAT-POSITIVE-INFINITY and (/ 1.0 0.0)
184            signals an error.
185         d: (in section12.erg) various forms a la 
186                 (FLOAT 1 DOUBLE-FLOAT-EPSILON)
187            don't give the right behavior.
188
189 46:
190   type safety errors reported by Peter Van Eynde July 25, 2000:
191         k: READ-BYTE is supposed to signal TYPE-ERROR when its argument is 
192            not a binary input stream, but instead cheerfully reads from
193            character streams, e.g. (MAKE-STRING-INPUT-STREAM "abc").
194
195 60:
196   The debugger LIST-LOCATIONS command doesn't work properly.
197   (How should it work properly?)
198
199 61:
200   Compiling and loading
201     (DEFUN FAIL (X) (THROW 'FAIL-TAG X))
202     (FAIL 12)
203   then requesting a BACKTRACE at the debugger prompt gives no information
204   about where in the user program the problem occurred.
205
206 64:
207   Using the pretty-printer from the command prompt gives funny
208   results, apparently because the pretty-printer doesn't know
209   about user's command input, including the user's carriage return
210   that the user, and therefore the pretty-printer thinks that
211   the new output block should start indented 2 or more characters
212   rightward of the correct location.
213
214 67:
215   As reported by Winton Davies on a CMU CL mailing list 2000-01-10,
216   and reported for SBCL by Martin Atzmueller 2000-10-20: (TRACE GETHASH)
217   crashes SBCL. In general tracing anything which is used in the 
218   implementation of TRACE is likely to have the same problem.
219
220 78:
221   ANSI says in one place that type declarations can be abbreviated even
222   when the type name is not a symbol, e.g.
223     (DECLAIM ((VECTOR T) *FOOVECTOR*))
224   SBCL doesn't support this. But ANSI says in another place that this
225   isn't allowed. So it's not clear this is a bug after all. (See the
226   e-mail on cmucl-help@cons.org on 2001-01-16 and 2001-01-17 from WHN
227   and Pierre Mai.)
228
229 79:
230   as pointed out by Dan Barlow on sbcl-devel 2000-07-02:
231   The PICK-TEMPORARY-FILE-NAME utility used by LOAD-FOREIGN uses
232   an easily guessable temporary filename in a way which might open
233   applications using LOAD-FOREIGN to hijacking by malicious users
234   on the same machine. Incantations for doing this safely are
235   floating around the net in various "how to write secure programs
236   despite Unix" documents, and it would be good to (1) fix this in 
237   LOAD-FOREIGN, and (2) hunt for any other code which uses temporary
238   files and make it share the same new safe logic.
239
240   (partially alleviated in sbcl-0.7.9.32 by a fix by Matthew Danish to
241    make the temporary filename less easily guessable)
242
243 83:
244   RANDOM-INTEGER-EXTRA-BITS=10 may not be large enough for the RANDOM
245   RNG to be high quality near RANDOM-FIXNUM-MAX; it looks as though
246   the mean of the distribution can be systematically O(0.1%) wrong.
247   Just increasing R-I-E-B is probably not a good solution, since
248   it would decrease efficiency more than is probably necessary. Perhaps
249   using some sort of accept/reject method would be better.
250
251 85:
252   Internally the compiler sometimes evaluates
253     (sb-kernel:type/= (specifier-type '*) (specifier-type t))
254   (I stumbled across this when I added an
255     (assert (not (eq type1 *wild-type*)))
256   in the NAMED :SIMPLE-= type method.) '* isn't really a type, and
257   in a type context should probably be translated to T, and so it's
258   probably wrong to ask whether it's equal to the T type and then (using
259   the EQ type comparison in the NAMED :SIMPLE-= type method) return NIL.
260   (I haven't tried to investigate this bug enough to guess whether
261   there might be any user-level symptoms.)
262
263   In fact, the type system is likely to depend on this inequality not
264   holding... * is not equivalent to T in many cases, such as 
265     (VECTOR *) /= (VECTOR T).
266
267 95:
268   The facility for dumping a running Lisp image to disk gets confused
269   when run without the PURIFY option, and creates an unnecessarily large
270   core file (apparently representing memory usage up to the previous
271   high-water mark). Moreover, when the file is loaded, it confuses the
272   GC, so that thereafter memory usage can never be reduced below that
273   level.
274
275 98:
276   In sbcl-0.6.11.41 (and in all earlier SBCL, and in CMU
277   CL), out-of-line structure slot setters are horribly inefficient
278   whenever the type of the slot is declared, because out-of-line
279   structure slot setters are implemented as closures to save space,
280   so the compiler doesn't compile the type test into code, but
281   instead just saves the type in a lexical closure and interprets it
282   at runtime.
283     To exercise the problem, compile and load
284       (cl:in-package :cl-user)
285       (defstruct foo
286         (bar (error "missing") :type bar))
287       (defvar *foo*)
288       (defun wastrel1 (x)
289         (loop (setf (foo-bar *foo*) x)))
290       (defstruct bar)
291       (defvar *bar* (make-bar))
292       (defvar *foo* (make-foo :bar *bar*))
293       (defvar *setf-foo-bar* #'(setf foo-bar))
294       (defun wastrel2 (x)
295         (loop (funcall *setf-foo-bar* x *foo*)))
296   then run (WASTREL1 *BAR*) or (WASTREL2 *BAR*), hit Ctrl-C, and
297   use BACKTRACE, to see it's spending all essentially all its time
298   in %TYPEP and VALUES-SPECIFIER-TYPE and so forth.
299     One possible solution would be simply to give up on 
300   representing structure slot accessors as functions, and represent
301   them as macroexpansions instead. This can be inconvenient for users,
302   but it's not clear that it's worse than trying to help by expanding
303   into a horribly inefficient implementation.
304     As a workaround for the problem, #'(SETF FOO) expressions
305   can be replaced with (EFFICIENT-SETF-FUNCTION FOO), where
306 (defmacro efficient-setf-function (place-function-name)
307   (or #+sbcl (and (sb-int:info :function :accessor-for place-function-name)
308                   ;; a workaround for the problem, encouraging the
309                   ;; inline expansion of the structure accessor, so
310                   ;; that the compiler can optimize its type test
311                   (let ((new-value (gensym "NEW-VALUE-"))
312                         (structure-value (gensym "STRUCTURE-VALUE-")))
313                     `(lambda (,new-value ,structure-value)
314                        (setf (,place-function-name ,structure-value)
315                              ,new-value))))
316       ;; no problem, can just use the ordinary expansion
317       `(function (setf ,place-function-name))))
318
319 100:
320   There's apparently a bug in CEILING optimization which caused 
321   Douglas Crosher to patch the CMU CL version. Martin Atzmueller
322   applied the patches to SBCL and they didn't seem to cause problems
323   (as reported sbcl-devel 2001-05-04). However, since the patches
324   modify nontrivial code which was apparently written incorrectly
325   the first time around, until regression tests are written I'm not 
326   comfortable merging the patches in the CVS version of SBCL.
327
328 108:
329   (TIME (ROOM T)) reports more than 200 Mbytes consed even for
330   a clean, just-started SBCL system. And it seems to be right:
331   (ROOM T) can bring a small computer to its knees for a *long*
332   time trying to GC afterwards. Surely there's some more economical
333   way to implement (ROOM T).
334
335 117:
336   When the compiler inline expands functions, it may be that different
337   kinds of return values are generated from different code branches.
338   E.g. an inline expansion of POSITION generates integer results 
339   from one branch, and NIL results from another. When that inline
340   expansion is used in a context where only one of those results
341   is acceptable, e.g.
342     (defun foo (x)
343       (aref *a1* (position x *a2*)))
344   and the compiler can't prove that the unacceptable branch is 
345   never taken, then bogus type mismatch warnings can be generated.
346   If you need to suppress the type mismatch warnings, you can
347   suppress the inline expansion,
348     (defun foo (x)
349       #+sbcl (declare (notinline position)) ; to suppress bug 117 bogowarnings
350       (aref *a1* (position x *a2*)))
351   or, sometimes, suppress them by declaring the result to be of an
352   appropriate type,
353     (defun foo (x)
354       (aref *a1* (the integer (position x *a2*))))
355
356   This is not a new compiler problem in 0.7.0, but the new compiler
357   transforms for FIND, POSITION, FIND-IF, and POSITION-IF make it 
358   more conspicuous. If you don't need performance from these functions,
359   and the bogus warnings are a nuisance for you, you can return to
360   your pre-0.7.0 state of grace with
361     #+sbcl (declaim (notinline find position find-if position-if)) ; bug 117..
362
363 118:
364    as reported by Eric Marsden on cmucl-imp@cons.org 2001-08-14:
365      (= (FLOAT 1 DOUBLE-FLOAT-EPSILON)
366         (+ (FLOAT 1 DOUBLE-FLOAT-EPSILON) DOUBLE-FLOAT-EPSILON)) => T
367    when of course it should be NIL. (He says it only fails for X86,
368    not SPARC; dunno about Alpha.)
369
370    Also, "the same problem exists for LONG-FLOAT-EPSILON,
371    DOUBLE-FLOAT-NEGATIVE-EPSILON, LONG-FLOAT-NEGATIVE-EPSILON (though
372    for the -negative- the + is replaced by a - in the test)."
373
374    Raymond Toy comments that this is tricky on the X86 since its FPU
375    uses 80-bit precision internally.
376
377 120b:
378    Even in sbcl-0.pre7.x, which is supposed to be free of the old
379    non-ANSI behavior of treating the function return type inferred
380    from the current function definition as a declaration of the
381    return type from any function of that name, the return type of NIL
382    is attached to FOO in 120a above, and used to optimize code which
383    calls FOO. 
384
385 124:
386    As of version 0.pre7.14, SBCL's implementation of MACROLET makes
387    the entire lexical environment at the point of MACROLET available
388    in the bodies of the macroexpander functions. In particular, it
389    allows the function bodies (which run at compile time) to try to
390    access lexical variables (which are only defined at runtime).
391    It doesn't even issue a warning, which is bad.
392
393    The SBCL behavior arguably conforms to the ANSI spec (since the
394    spec says that the behavior is undefined, ergo anything conforms).
395    However, it would be better to issue a compile-time error.
396    Unfortunately I (WHN) don't see any simple way to detect this
397    condition in order to issue such an error, so for the meantime
398    SBCL just does this weird broken "conforming" thing.
399
400    The ANSI standard says, in the definition of the special operator
401    MACROLET,
402        The macro-expansion functions defined by MACROLET are defined
403        in the lexical environment in which the MACROLET form appears.
404        Declarations and MACROLET and SYMBOL-MACROLET definitions affect
405        the local macro definitions in a MACROLET, but the consequences
406        are undefined if the local macro definitions reference any
407        local variable or function bindings that are visible in that
408        lexical environment.
409    Then it seems to contradict itself by giving the example
410         (defun foo (x flag)
411            (macrolet ((fudge (z)
412                          ;The parameters x and flag are not accessible
413                          ; at this point; a reference to flag would be to
414                          ; the global variable of that name.
415                          ` (if flag (* ,z ,z) ,z)))
416             ;The parameters x and flag are accessible here.
417              (+ x
418                 (fudge x)
419                 (fudge (+ x 1)))))
420    The comment "a reference to flag would be to the global variable
421    of the same name" sounds like good behavior for the system to have.
422    but actual specification quoted above says that the actual behavior
423    is undefined.
424
425    (Since 0.7.8.23 macroexpanders are defined in a restricted version
426    of the lexical environment, containing no lexical variables and
427    functions, which seems to conform to ANSI and CLtL2, but signalling
428    a STYLE-WARNING for references to variables similar to locals might
429    be a good thing.)
430
431 125:
432    (as reported by Gabe Garza on cmucl-help 2001-09-21)
433         (defvar *tmp* 3)
434         (defun test-pred (x y)
435           (eq x y))
436         (defun test-case ()
437           (let* ((x *tmp*)
438                  (func (lambda () x)))
439             (print (eq func func))
440             (print (test-pred func func))
441             (delete func (list func))))
442    Now calling (TEST-CASE) gives output
443      NIL
444      NIL
445      (#<FUNCTION {500A9EF9}>)
446    Evidently Python thinks of the lambda as a code transformation so
447    much that it forgets that it's also an object.
448
449 135:
450   Ideally, uninterning a symbol would allow it, and its associated
451   FDEFINITION and PROCLAIM data, to be reclaimed by the GC. However,
452   at least as of sbcl-0.7.0, this isn't the case. Information about
453   FDEFINITIONs and PROCLAIMed properties is stored in globaldb.lisp
454   essentially in ordinary (non-weak) hash tables keyed by symbols.
455   Thus, once a system has an entry in this system, it tends to live
456   forever, even when it is uninterned and all other references to it
457   are lost.
458
459 141: "pretty printing and backquote"
460   a.
461     * '``(FOO ,@',@S)
462     ``(FOO SB-IMPL::BACKQ-COMMA-AT S)
463
464   b.
465     * (write '`(, .ala.) :readably t :pretty t)
466     `(,.ALA.)
467
468   (note the space between the comma and the point)
469
470 143:
471   (reported by Jesse Bouwman 2001-10-24 through the unfortunately
472   prominent SourceForge web/db bug tracking system, which is 
473   unfortunately not a reliable way to get a timely response from
474   the SBCL maintainers)
475       In the course of trying to build a test case for an 
476     application error, I encountered this behavior: 
477       If you start up sbcl, and then lay on CTRL-C for a 
478     minute or two, the lisp process will eventually say: 
479          %PRIMITIVE HALT called; the party is over. 
480     and throw you into the monitor. If I start up lisp, 
481     attach to the process with strace, and then do the same 
482     (abusive) thing, I get instead: 
483          access failure in heap page not marked as write-protected 
484     and the monitor again. I don't know enough to have the 
485     faintest idea of what is going on here. 
486       This is with sbcl 6.12, uname -a reports: 
487          Linux prep 2.2.19 #4 SMP Tue Apr 24 13:59:52 CDT 2001 i686 unknown 
488   I (WHN) have verified that the same thing occurs on sbcl-0.pre7.141
489   under OpenBSD 2.9 on my X86 laptop. Do be patient when you try it:
490   it took more than two minutes (but less than five) for me.
491
492 145:
493   a.
494   ANSI allows types `(COMPLEX ,FOO) to use very hairy values for
495   FOO, e.g. (COMPLEX (AND REAL (SATISFIES ODDP))). The old CMU CL
496   COMPLEX implementation didn't deal with this, and hasn't been
497   upgraded to do so. (This doesn't seem to be a high priority
498   conformance problem, since seems hard to construct useful code
499   where it matters.)
500
501   b.
502   * (defun foo (x)
503       (declare (type (double-float -0d0) x))
504       (declare (optimize speed))
505       (+ x (sqrt (log (random 1d0)))))
506   debugger invoked on condition of type SIMPLE-ERROR:
507     bad thing to be a type specifier: ((COMPLEX
508                                         (DOUBLE-FLOAT 0.0d0
509                                                       #.SB-EXT:DOUBLE-FLOAT-POSITIVE-INFINITY))
510                                        #C(0.0d0 #.SB-EXT:DOUBLE-FLOAT-POSITIVE-INFINITY)
511                                        #C(0.0d0 #.SB-EXT:DOUBLE-FLOAT-POSITIVE-INFINITY))
512
513 146:
514   Floating point errors are reported poorly. E.g. on x86 OpenBSD
515   with sbcl-0.7.1, 
516         * (expt 2.0 12777)
517         debugger invoked on condition of type SB-KERNEL:FLOATING-POINT-EXCEPTION:
518           An arithmetic error SB-KERNEL:FLOATING-POINT-EXCEPTION was signalled.
519         No traps are enabled? How can this be?
520   It should be possible to be much more specific (overflow, division
521   by zero, etc.) and of course the "How can this be?" should be fixable.
522
523   See also bugs #45.c and #183
524
525 162:
526   (reported by Robert E. Brown 2002-04-16) 
527   When a function is called with too few arguments, causing the
528   debugger to be entered, the uninitialized slots in the bad call frame 
529   seem to cause GCish problems, being interpreted as tagged data even
530   though they're not. In particular, executing ROOM in the
531   debugger at that point causes AVER failures:
532     * (machine-type)
533     "X86"
534     * (lisp-implementation-version)
535     "0.7.2.12"
536     * (typep 10)
537     ...
538     0] (room)
539     ...
540     failed AVER: "(SAP= CURRENT END)"
541   (Christophe Rhodes reports that this doesn't occur on the SPARC, which
542   isn't too surprising since there are many differences in stack
543   implementation and GC conservatism between the X86 and other ports.)
544
545 167:
546   In sbcl-0.7.3.11, compiling the (illegal) code 
547     (in-package :cl-user)
548     (defmethod prove ((uustk uustk))
549       (zap ((frob () nil))
550         (frob)))
551   gives the (not terribly clear) error message
552     ; caught ERROR:
553     ;   (during macroexpansion of (DEFMETHOD PROVE ...))
554     ; can't get template for (FROB NIL NIL)
555   The problem seems to be that the code walker used by the DEFMETHOD
556   macro is unhappy with the illegal syntax in the method body, and
557   is giving an unclear error message.
558
559 173:
560   The compiler sometimes tries to constant-fold expressions before
561   it checks to see whether they can be reached. This can lead to 
562   bogus warnings about errors in the constant folding, e.g. in code
563   like 
564     (WHEN X
565       (WRITE-STRING (> X 0) "+" "0"))
566   compiled in a context where the compiler can prove that X is NIL,
567   and the compiler complains that (> X 0) causes a type error because
568   NIL isn't a valid argument to #'>. Until sbcl-0.7.4.10 or so this
569   caused a full WARNING, which made the bug really annoying because then 
570   COMPILE and COMPILE-FILE returned FAILURE-P=T for perfectly legal
571   code. Since then the warning has been downgraded to STYLE-WARNING, 
572   so it's still a bug but at least it's a little less annoying.
573
574 183: "IEEE floating point issues"
575   Even where floating point handling is being dealt with relatively
576   well (as of sbcl-0.7.5, on sparc/sunos and alpha; see bug #146), the
577   accrued-exceptions and current-exceptions part of the fp control
578   word don't seem to bear much relation to reality. E.g. on
579   SPARC/SunOS:
580   * (/ 1.0 0.0)
581
582   debugger invoked on condition of type DIVISION-BY-ZERO:
583     arithmetic error DIVISION-BY-ZERO signalled
584   0] (sb-vm::get-floating-point-modes)
585
586   (:TRAPS (:OVERFLOW :INVALID :DIVIDE-BY-ZERO)
587           :ROUNDING-MODE :NEAREST
588           :CURRENT-EXCEPTIONS NIL
589           :ACCRUED-EXCEPTIONS (:INEXACT)
590           :FAST-MODE NIL)
591   0] abort
592   * (sb-vm::get-floating-point-modes)
593   (:TRAPS (:OVERFLOW :INVALID :DIVIDE-BY-ZERO)
594           :ROUNDING-MODE :NEAREST
595           :CURRENT-EXCEPTIONS (:INEXACT)
596           :ACCRUED-EXCEPTIONS (:INEXACT)
597           :FAST-MODE NIL)
598
599 188: "compiler performance fiasco involving type inference and UNION-TYPE"
600     (time (compile
601            nil
602            '(lambda ()
603              (declare (optimize (safety 3)))
604              (declare (optimize (compilation-speed 2)))
605              (declare (optimize (speed 1) (debug 1) (space 1)))
606              (let ((start 4))
607                (declare (type (integer 0) start))
608                (print (incf start 22))
609                (print (incf start 26))
610                (print (incf start 28)))
611              (let ((start 6))
612                (declare (type (integer 0) start))
613                (print (incf start 22))
614                (print (incf start 26)))
615              (let ((start 10))
616                (declare (type (integer 0) start))
617                (print (incf start 22))
618                (print (incf start 26))))))
619
620   This example could be solved with clever enough constraint
621   propagation or with SSA, but consider
622
623     (let ((x 0))
624       (loop (incf x 2)))
625
626   The careful type of X is {2k} :-(. Is it really important to be
627   able to work with unions of many intervals?
628
629 190: "PPC/Linux pipe? buffer? bug"
630   In sbcl-0.7.6, the run-program.test.sh test script sometimes hangs
631   on the PPC/Linux platform, waiting for a zombie env process.  This
632   is a classic symptom of buffer filling and deadlock, but it seems
633   only sporadically reproducible.
634
635 191: "Miscellaneous PCL deficiencies"
636   (reported by Alexey Dejneka sbcl-devel 2002-08-04)
637   a. DEFCLASS does not inform the compiler about generated
638      functions. Compiling a file with
639        (DEFCLASS A-CLASS ()
640          ((A-CLASS-X)))
641        (DEFUN A-CLASS-X (A)
642          (WITH-SLOTS (A-CLASS-X) A
643            A-CLASS-X))
644      results in a STYLE-WARNING:
645        undefined-function 
646          SB-SLOT-ACCESSOR-NAME::|COMMON-LISP-USER A-CLASS-X slot READER|
647
648      APD's fix for this was checked in to sbcl-0.7.6.20, but Pierre
649      Mai points out that the declamation of functions is in fact
650      incorrect in some cases (most notably for structure
651      classes).  This means that at present erroneous attempts to use
652      WITH-SLOTS and the like on classes with metaclass STRUCTURE-CLASS
653      won't get the corresponding STYLE-WARNING.
654   c. the examples in CLHS 7.6.5.1 (regarding generic function lambda
655      lists and &KEY arguments) do not signal errors when they should.
656
657 201: "Incautious type inference from compound types"
658   a. (reported by APD sbcl-devel 2002-09-17)
659     (DEFUN FOO (X)
660       (LET ((Y (CAR (THE (CONS INTEGER *) X))))
661         (SETF (CAR X) NIL)
662         (FORMAT NIL "~S IS ~S, Y = ~S"
663                 (CAR X)
664                 (TYPECASE (CAR X)
665                   (INTEGER 'INTEGER)
666                   (T '(NOT INTEGER)))
667                 Y)))
668
669     (FOO ' (1 . 2)) => "NIL IS INTEGER, Y = 1"
670
671   b.
672     * (defun foo (x)
673         (declare (type (array * (4 4)) x))
674         (let ((y x))
675           (setq x (make-array '(4 4)))
676           (adjust-array y '(3 5))
677           (= (array-dimension y 0) (eval `(array-dimension ,y 0)))))
678     FOO
679     * (foo (make-array '(4 4) :adjustable t))
680     NIL
681
682 205: "environment issues in cross compiler"
683   (These bugs have no impact on user code, but should be fixed or
684   documented.)
685   a. Macroexpanders introduced with MACROLET are defined in the null
686      lexical environment.
687   b. The body of (EVAL-WHEN (:COMPILE-TOPLEVEL) ...) is evaluated in
688      the null lexical environment.
689   c. The cross-compiler cannot inline functions defined in a non-null
690      lexical environment.
691
692 206: ":SB-FLUID feature broken"
693   (reported by Antonio Martinez-Shotton sbcl-devel 2002-10-07)
694   Enabling :SB-FLUID in the target-features list in sbcl-0.7.8 breaks
695   the build.
696
697 207: "poorly distributed SXHASH results for compound data"
698   SBCL's SXHASH could probably try a little harder. ANSI: "the
699   intent is that an implementation should make a good-faith
700   effort to produce hash-codes that are well distributed
701   within the range of non-negative fixnums". But
702         (let ((hits (make-hash-table)))
703           (dotimes (i 16)
704             (dotimes (j 16)
705               (let* ((ij (cons i j))
706                      (newlist (push ij (gethash (sxhash ij) hits))))
707                 (when (cdr newlist)
708                   (format t "~&collision: ~S~%" newlist))))))
709   reports lots of collisions in sbcl-0.7.8. A stronger MIX function
710   would be an obvious way of fix. Maybe it would be acceptably efficient
711   to redo MIX using a lookup into a 256-entry s-box containing
712   29-bit pseudorandom numbers?
713
714 211: "keywords processing"
715   a. :ALLOW-OTHER-KEYS T should allow a function to receive an odd
716      number of keyword arguments.
717   e. Compiling
718
719       (flet ((foo (&key y) (list y)))
720         (list (foo :y 1 :y 2)))
721
722      issues confusing message
723
724        ; in: LAMBDA NIL
725        ;     (FOO :Y 1 :Y 2)
726        ;
727        ; caught STYLE-WARNING:
728        ;   The variable #:G15 is defined but never used.
729
730 212: "Sequence functions and circular arguments"
731   COERCE, MERGE and CONCATENATE go into an infinite loop when given
732   circular arguments; it would be good for the user if they could be
733   given an error instead (ANSI 17.1.1 allows this behaviour on the part
734   of the implementation, as conforming code cannot give non-proper
735   sequences to these functions.  MAP also has this problem (and
736   solution), though arguably the convenience of being able to do
737     (MAP 'LIST '+ FOO '#1=(1 . #1#))
738   might be classed as more important (though signalling an error when
739   all of the arguments are circular is probably desireable).
740
741 213: "Sequence functions and type checking"
742   a. MAKE-SEQUENCE, COERCE, MERGE and CONCATENATE cannot deal with
743      various complicated, though recognizeable, CONS types [e.g.
744        (CONS * (CONS * NULL))
745      which according to ANSI should be recognized] (and, in SAFETY 3
746      code, should return a list of LENGTH 2 or signal an error)
747   b. MAP, when given a type argument that is SUBTYPEP LIST, does not
748      check that it will return a sequence of the given type.  Fixing
749      it along the same lines as the others (cf. work done around
750      sbcl-0.7.8.45) is possible, but doing so efficiently didn't look
751      entirely straightforward.
752   c. All of these functions will silently accept a type of the form
753        (CONS INTEGER *)
754      whether or not the return value is of this type.  This is
755      probably permitted by ANSI (see "Exceptional Situations" under
756      ANSI MAKE-SEQUENCE), but the DERIVE-TYPE mechanism does not
757      know about this escape clause, so code of the form
758        (INTEGERP (CAR (MAKE-SEQUENCE '(CONS INTEGER *) 2)))
759      can erroneously return T.
760
761 214:
762   SBCL 0.6.12.43 fails to compile
763
764   (locally
765       (declare (optimize (inhibit-warnings 0) (compilation-speed 2)))
766     (flet ((foo (&key (x :vx x-p)) (list x x-p)))
767       (foo 1 2)))
768
769   or a more simple example:
770
771   (locally
772       (declare (optimize (inhibit-warnings 0) (compilation-speed 2)))
773     (lambda (x) (declare (fixnum x)) (if (< x 0) 0 (1- x))))
774
775 215: ":TEST-NOT handling by functions"
776   a. FIND and POSITION currently signal errors when given non-NIL for
777      both their :TEST and (deprecated) :TEST-NOT arguments, but by
778      ANSI 17.2 "the consequences are unspecified", which by ANSI 1.4.2
779      means that the effect is "unpredictable but harmless".  It's not
780      clear what that actually means; it may preclude conforming
781      implementations from signalling errors.
782   b. COUNT, REMOVE and the like give priority to a :TEST-NOT argument
783      when conflict occurs.  As a quality of implementation issue, it
784      might be preferable to treat :TEST and :TEST-NOT as being in some
785      sense the same &KEY, and effectively take the first test function in
786      the argument list.
787   c. Again, a quality of implementation issue: it would be good to issue a
788      STYLE-WARNING at compile-time for calls with :TEST-NOT, and a
789      WARNING for calls with both :TEST and :TEST-NOT; possibly this
790      latter should be WARNed about at execute-time too.
791
792 216: "debugger confused by frames with invalid number of arguments"
793   In sbcl-0.7.8.51, executing e.g. (VECTOR-PUSH-EXTEND T), BACKTRACE, Q
794   leaves the system confused, enough so that (QUIT) no longer works.
795   It's as though the process of working with the uninitialized slot in
796   the bad VECTOR-PUSH-EXTEND frame causes GC problems, though that may
797   not be the actual problem. (CMU CL 18c doesn't have problems with this.)
798
799 217: "Bad type operations with FUNCTION types"
800   In sbcl.0.7.7:
801
802     * (values-type-union (specifier-type '(function (base-char)))
803                          (specifier-type '(function (integer))))
804
805     #<FUN-TYPE (FUNCTION (BASE-CHAR) *)>
806
807   It causes insertion of wrong type assertions into generated
808   code. E.g.
809
810     (defun foo (x s)
811       (let ((f (etypecase x
812                  (character #'write-char)
813                  (integer #'write-byte))))
814         (funcall f x s)
815         (etypecase x
816           (character (write-char x s))
817           (integer (write-byte x s)))))
818
819    Then (FOO #\1 *STANDARD-OUTPUT*) signals type error.
820
821   (In 0.7.9.1 the result type is (FUNCTION * *), so Python does not
822   produce invalid code, but type checking is not accurate.)
823
824 233: bugs in constraint propagation
825   a.
826   (defun foo (x)
827     (declare (optimize (speed 2) (safety 3)))
828     (let ((y 0d0))
829       (values
830        (the double-float x)
831        (setq y (+ x 1d0))
832        (setq x 3d0)
833        (quux y (+ y 2d0) (* y 3d0)))))
834   (foo 4) => segmentation violation
835
836   (see usage of CONTINUATION-ASSERTED-TYPE in USE-RESULT-CONSTRAINTS)
837   (see also bug 236)
838
839   b.
840   (declaim (optimize (speed 2) (safety 3)))
841   (defun foo (x y)
842     (if (typep (prog1 x (setq x y)) 'double-float)
843         (+ x 1d0)
844         (+ x 2)))
845   (foo 1d0 5) => segmentation violation
846
847 235: "type system and inline expansion"
848   a.
849   (declaim (ftype (function (cons) number) acc))
850   (declaim (inline acc))
851   (defun acc (c)
852     (the number (car c)))
853
854   (defun foo (x y)
855     (values (locally (declare (optimize (safety 0)))
856               (acc x))
857             (locally (declare (optimize (safety 3)))
858               (acc y))))
859
860   (foo '(nil) '(t)) => NIL, T.
861
862 237: "Environment arguments to type functions"
863   a. Functions SUBTYPEP, TYPEP, UPGRADED-ARRAY-ELEMENT-TYPE, and 
864      UPGRADED-COMPLEX-PART-TYPE now have an optional environment
865      argument, but they ignore it completely.  This is almost 
866      certainly not correct.
867   b. Also, the compiler's optimizers for TYPEP have not been informed
868      about the new argument; consequently, they will not transform
869      calls of the form (TYPEP 1 'INTEGER NIL), even though this is
870      just as optimizeable as (TYPEP 1 'INTEGER).
871
872 238: "REPL compiler overenthusiasm for CLOS code"
873   From the REPL,
874     * (defclass foo () ())
875     * (defmethod bar ((x foo) (foo foo)) (call-next-method))
876   causes approximately 100 lines of code deletion notes.  Some
877   discussion on this issue happened under the title 'Three "interesting"
878   bugs in PCL', resulting in a fix for this oververbosity from the
879   compiler proper; however, the problem persists in the interactor
880   because the notion of original source is not preserved: for the
881   compiler, the original source of the above expression is (DEFMETHOD
882   BAR ((X FOO) (FOO FOO)) (CALL-NEXT-METHOD)), while by the time the
883   compiler gets its hands on the code needing compilation from the REPL,
884   it has been macroexpanded several times.
885
886   A symptom of the same underlying problem, reported by Tony Martinez:
887     * (handler-case
888         (with-input-from-string (*query-io* "    no")
889           (yes-or-no-p))
890       (simple-type-error () 'error))
891     ; in: LAMBDA NIL
892     ;     (SB-KERNEL:FLOAT-WAIT)
893     ; 
894     ; note: deleting unreachable code
895     ; compilation unit finished
896     ;   printed 1 note
897
898 241: "DEFCLASS mysteriously remembers uninterned accessor names."
899   (from tonyms on #lisp IRC 2003-02-25)
900   In sbcl-0.7.12.55, typing
901     (defclass foo () ((bar :accessor foo-bar)))
902     (profile foo-bar)
903     (unintern 'foo-bar)
904     (defclass foo () ((bar :accessor foo-bar)))
905   gives the error message
906     "#:FOO-BAR already names an ordinary function or a macro."
907   So it's somehow checking the uninterned old accessor name instead
908   of the new requested accessor name, which seems broken to me (WHN).
909
910 242: "WRITE-SEQUENCE suboptimality"
911   (observed from clx performance)
912   In sbcl-0.7.13, WRITE-SEQUENCE of a sequence of type 
913   (SIMPLE-ARRAY (UNSIGNED-BYTE 8) (*)) on a stream with element-type
914   (UNSIGNED-BYTE 8) will write to the stream one byte at a time,
915   rather than writing the sequence in one go, leading to severe
916   performance degradation.
917
918 243: "STYLE-WARNING overenthusiasm for unused variables"
919   (observed from clx compilation)
920   In sbcl-0.7.14, in the presence of the macros
921     (DEFMACRO FOO (X) `(BAR ,X))
922     (DEFMACRO BAR (X) (DECLARE (IGNORABLE X)) 'NIL)
923   somewhat surprising style warnings are emitted for
924     (COMPILE NIL '(LAMBDA (Y) (FOO Y))):
925   ; in: LAMBDA (Y)
926   ;     (LAMBDA (Y) (FOO Y))
927   ; 
928   ; caught STYLE-WARNING:
929   ;   The variable Y is defined but never used.
930
931 245: bugs in disassembler
932   a. On X86 an immediate operand for IMUL is printed incorrectly.
933   b. On X86 operand size prefix is not recognized.
934
935 248: "reporting errors in type specifier syntax"
936   (TYPEP 1 '(SYMBOL NIL)) says something about "unknown type
937   specifier".
938
939 251:
940   (defun foo (&key (a :x))
941     (declare (fixnum a))
942     a)
943
944   does not cause a warning. (BTW: old SBCL issued a warning, but for a
945   function, which was never called!)
946
947 256:
948   Compiler does not emit warnings for
949
950   a. (lambda () (svref (make-array 8 :adjustable t) 1))
951
952   b. (lambda (x)
953        (list (let ((y (the real x)))
954                (unless (floatp y) (error ""))
955                y)
956              (integer-length x)))
957
958   c. (lambda (x)
959        (declare (optimize (debug 0)))
960        (declare (type vector x))
961        (list (fill-pointer x)
962              (svref x 1)))
963
964 257:
965   Complex array type does not have corresponding type specifier.
966
967   This is a problem because the compiler emits optimization notes when
968   you use a non-simple array, and without a type specifier for hairy
969   array types, there's no good way to tell it you're doing it
970   intentionally so that it should shut up and just compile the code.
971
972   Another problem is confusing error message "asserted type ARRAY
973   conflicts with derived type (VALUES SIMPLE-VECTOR &OPTIONAL)" during
974   compiling (LAMBDA (V) (VALUES (SVREF V 0) (VECTOR-POP V))).
975
976   The last problem is that when type assertions are converted to type
977   checks, types are represented with type specifiers, so we could lose
978   complex attribute. (Now this is probably not important, because
979   currently checks for complex arrays seem to be performed by
980   callees.)
981
982 259:
983   (compile nil '(lambda () (aref (make-array 0) 0))) compiles without
984   warning.  Analogous cases with the index and length being equal and
985   greater than 0 are warned for; the problem here seems to be that the
986   type required for an array reference of this type is (INTEGER 0 (0))
987   which is canonicalized to NIL.
988
989 260:
990   a.
991   (let* ((s (gensym))
992          (t1 (specifier-type s)))
993     (eval `(defstruct ,s))
994     (type= t1 (specifier-type s)))
995   => NIL, NIL
996
997   (fixed in 0.8.1.24)
998
999   b. The same for CSUBTYPEP.
1000
1001 261:
1002     * (let () (list (the (values &optional fixnum) (eval '(values)))))
1003     debugger invoked on condition of type TYPE-ERROR:
1004       The value NIL is not of type FIXNUM.
1005
1006 262: "yet another bug in inline expansion of local functions"
1007   Compiler fails on
1008
1009     (defun foo (x y)
1010       (declare (integer x y))
1011       (+ (block nil
1012             (flet ((xyz (u)
1013                      (declare (integer u))
1014                      (if (> (1+ (the unsigned-byte u)) 0)
1015                          (+ 1 u)
1016                          (return (+ 38 (cos (/ u 78)))))))
1017               (declare (inline xyz))
1018               (return-from foo
1019                 (* (funcall (eval #'xyz) x)
1020                    (if (> x 30)
1021                        (funcall (if (> x 5) #'xyz #'identity)
1022                                 (+ x 13))
1023                        38)))))
1024          (sin (* x y))))
1025
1026   Urgh... It's time to write IR1-copier.
1027
1028 265:
1029   SB-EXT:RUN-PROGRAM is currently non-functional on Linux/PPC;
1030   attempting to use it leads to segmentation violations.  This is
1031   probably because of a bogus implementation of
1032   os_restore_fp_control().
1033
1034 266:
1035   David Lichteblau provided (sbcl-devel 2003-06-01) a patch to fix
1036   behaviour of streams with element-type (SIGNED-BYTE 8).  The patch
1037   looks reasonable, if not obviously correct; however, it caused the
1038   PPC/Linux port to segfault during warm-init while loading
1039   src/pcl/std-class.fasl.  A workaround patch was made, but it would
1040   be nice to understand why the first patch caused problems, and to
1041   fix the cause if possible.
1042
1043 268: "wrong free declaration scope"
1044   The following code must signal type error:
1045
1046     (locally (declare (optimize (safety 3)))
1047       (flet ((foo (x &optional (y (car x)))
1048                (declare (optimize (safety 0)))
1049                (list x y)))
1050         (funcall (eval #'foo) 1)))
1051
1052 269:
1053   SCALE-FLOAT should accept any integer for its second argument.
1054
1055 270:
1056   In the following function constraint propagator optimizes nothing:
1057
1058     (defun foo (x)
1059       (declare (integer x))
1060       (declare (optimize speed))
1061       (typecase x
1062         (fixnum "hala")
1063         (fixnum "buba")
1064         (bignum "hip")
1065         (t "zuz")))
1066
1067 272:
1068   All forms of GC hooks (including notifiers and finalisers) are currently
1069   (since 0.8.0) broken for gencgc (i.e. x86) users 
1070
1071 273:
1072   Compilation of the following two forms causes "X is unbound" error:
1073
1074     (symbol-macrolet ((x pi))
1075       (macrolet ((foo (y) (+ x y)))
1076         (declaim (inline bar))
1077         (defun bar (z)
1078           (* z (foo 4)))))
1079     (defun quux (z)
1080       (bar z))
1081
1082   (See (COERCE (CDR X) 'FUNCTION) in IR1-CONVERT-INLINE-LAMBDA.)
1083
1084 274:
1085   CLHS says that type declaration of a symbol macro should not affect
1086   its expansion, but in SBCL it does.
1087
1088 275:
1089   The following code (taken from CLOCC) takes a lot of time to compile:
1090
1091     (defun foo (n)
1092       (declare (type (integer 0 #.large-constant) n))
1093       (expt 1/10 n))
1094
1095   (fixed in 0.8.2.51, but a test case would be good)
1096
1097 276:
1098     (defmethod fee ((x fixnum))
1099       (setq x (/ x 2))
1100       x)
1101     (fee 1) => type error
1102
1103   (taken from CLOCC)
1104
1105 277:
1106   IGNORE/IGNORABLE declarations should be acceptable for symbol
1107   macros.
1108
1109
1110 DEFUNCT CATEGORIES OF BUGS
1111   IR1-#:
1112     These labels were used for bugs related to the old IR1 interpreter.
1113     The # values reached 6 before the category was closed down.