1.0.36.34: WHO-CALLS information for source transformed calls
[sbcl.git] / src / compiler / fndb.lisp
1 ;;;; This file defines all the standard functions to be known
2 ;;;; functions. Each function has type and side-effect information,
3 ;;;; and may also have IR1 optimizers.
4
5 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; more information.
7 ;;;;
8 ;;;; This software is derived from the CMU CL system, which was
9 ;;;; written at Carnegie Mellon University and released into the
10 ;;;; public domain. The software is in the public domain and is
11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
12 ;;;; files for more information.
13
14 (in-package "SB!C")
15 \f
16 ;;;; information for known functions:
17
18 (defknown coerce (t type-specifier) t
19     ;; Note:
20     ;; This is not FLUSHABLE because it's defined to signal errors.
21     (movable)
22   ;; :DERIVE-TYPE RESULT-TYPE-SPEC-NTH-ARG 2 ? Nope... (COERCE 1 'COMPLEX)
23   ;; returns REAL/INTEGER, not COMPLEX.
24   )
25 (defknown list-to-vector* (list type-specifier) vector)
26 (defknown vector-to-vector* (vector type-specifier) vector)
27
28 (defknown type-of (t) t (foldable flushable))
29
30 ;;; These can be affected by type definitions, so they're not FOLDABLE.
31 (defknown (sb!xc:upgraded-complex-part-type sb!xc:upgraded-array-element-type)
32     (type-specifier &optional lexenv-designator) type-specifier
33     (unsafely-flushable))
34 \f
35 ;;;; from the "Predicates" chapter:
36
37 ;;; FIXME: Is it right to have TYPEP (and TYPE-OF, elsewhere; and
38 ;;; perhaps SPECIAL-OPERATOR-P and others) be FOLDABLE in the
39 ;;; cross-compilation host? After all, some type relationships (e.g.
40 ;;; FIXNUMness) might be different between host and target. Perhaps
41 ;;; this property should be protected by #-SB-XC-HOST? Perhaps we need
42 ;;; 3-stage bootstrapping after all? (Ugh! It's *so* slow already!)
43 (defknown typep (t type-specifier &optional lexenv-designator) t
44    ;; Unlike SUBTYPEP or UPGRADED-ARRAY-ELEMENT-TYPE and friends, this
45    ;; seems to be FOLDABLE. Like SUBTYPEP, it's affected by type
46    ;; definitions, but unlike SUBTYPEP, there should be no way to make
47    ;; a TYPEP expression with constant arguments which doesn't return
48    ;; an error before the type declaration (because of undefined
49    ;; type). E.g. you can do
50    ;;   (SUBTYPEP 'INTEGER 'FOO) => NIL, NIL
51    ;;   (DEFTYPE FOO () T)
52    ;;   (SUBTYPEP 'INTEGER 'FOO) => T, T
53    ;; but the analogous
54    ;;   (TYPEP 12 'FOO)
55    ;;   (DEFTYPE FOO () T)
56    ;;   (TYPEP 12 'FOO)
57    ;; doesn't work because the first call is an error.
58    ;;
59    ;; (UPGRADED-ARRAY-ELEMENT-TYPE and UPGRADED-COMPLEX-PART-TYPE have
60    ;; behavior like SUBTYPEP in this respect, not like TYPEP.)
61    (foldable))
62 (defknown subtypep (type-specifier type-specifier &optional lexenv-designator)
63   (values boolean boolean)
64   ;; This is not FOLDABLE because its value is affected by type
65   ;; definitions.
66   ;;
67   ;; FIXME: Is it OK to fold this when the types have already been
68   ;; defined? Does the code inherited from CMU CL already do this?
69   (unsafely-flushable))
70
71 (defknown (null symbolp atom consp listp numberp integerp rationalp floatp
72                 complexp characterp stringp bit-vector-p vectorp
73                 simple-vector-p simple-string-p simple-bit-vector-p arrayp
74                 sb!xc:packagep functionp compiled-function-p not)
75   (t) boolean (movable foldable flushable))
76
77 (defknown (eq eql) (t t) boolean (movable foldable flushable))
78 (defknown (equal equalp) (t t) boolean (foldable flushable recursive))
79 \f
80 ;;;; classes
81
82 (sb!xc:deftype name-for-class () t)
83 (defknown classoid-name (classoid) name-for-class (flushable))
84 (defknown find-classoid (name-for-class &optional t)
85   (or classoid null) ())
86 (defknown classoid-of (t) classoid (flushable))
87 (defknown layout-of (t) layout (flushable))
88 (defknown copy-structure (structure-object) structure-object
89   (flushable unsafe))
90 \f
91 ;;;; from the "Control Structure" chapter:
92
93 ;;; This is not FLUSHABLE, since it's required to signal an error if
94 ;;; unbound.
95 (defknown (symbol-value) (symbol) t ())
96 ;;; From CLHS, "If the symbol is globally defined as a macro or a
97 ;;; special operator, an object of implementation-dependent nature and
98 ;;; identity is returned. If the symbol is not globally defined as
99 ;;; either a macro or a special operator, and if the symbol is fbound,
100 ;;; a function object is returned".  Our objects of
101 ;;; implementation-dependent nature happen to be functions.
102 (defknown (symbol-function) (symbol) function ())
103
104 (defknown boundp (symbol) boolean (flushable))
105 (defknown fboundp ((or symbol cons)) boolean (unsafely-flushable explicit-check))
106 (defknown special-operator-p (symbol) t
107   ;; The set of special operators never changes.
108   (movable foldable flushable))
109 (defknown set (symbol t) t (unsafe)
110   :derive-type #'result-type-last-arg)
111 (defknown fdefinition ((or symbol cons)) function (unsafe explicit-check))
112 (defknown %set-fdefinition ((or symbol cons) function) function
113   (unsafe explicit-check))
114 (defknown makunbound (symbol) symbol)
115 (defknown fmakunbound ((or symbol cons)) (or symbol cons)
116   (unsafe explicit-check))
117 (defknown (get-setf-method get-setf-method-multiple-value)
118   ((or list symbol) &optional lexenv-designator)
119   (values list list list form form)
120   (flushable))
121 (defknown apply (callable t &rest t) *) ; ### Last arg must be List...
122 (defknown funcall (callable &rest t) *)
123
124 (defknown (mapcar maplist) (callable list &rest list) list
125   (call))
126
127 ;;; According to CLHS the result must be a LIST, but we do not check
128 ;;; it.
129 (defknown (mapcan mapcon) (callable list &rest list) t
130   (call))
131
132 (defknown (mapc mapl) (callable list &rest list) list (foldable call))
133
134 ;;; We let VALUES-LIST be foldable, since constant-folding will turn
135 ;;; it into VALUES. VALUES is not foldable, since MV constants are
136 ;;; represented by a call to VALUES.
137 (defknown values (&rest t) * (movable flushable unsafe))
138 (defknown values-list (list) * (movable foldable unsafely-flushable))
139 \f
140 ;;;; from the "Macros" chapter:
141
142 (defknown macro-function (symbol &optional lexenv-designator)
143   (or function null)
144   (flushable))
145 (defknown (macroexpand macroexpand-1) (t &optional lexenv-designator)
146   (values form &optional boolean))
147
148 (defknown compiler-macro-function (t &optional lexenv-designator)
149   (or function null)
150   (flushable))
151 \f
152 ;;;; from the "Declarations" chapter:
153
154 (defknown proclaim (list) (values) (recursive))
155
156 ;;;; from the "Symbols" chapter:
157
158 (defknown get (symbol t &optional t) t (flushable))
159 (defknown sb!impl::get2 (symbol t) t (flushable))
160 (defknown sb!impl::get3 (symbol t t) t (flushable))
161 (defknown remprop (symbol t) t)
162 (defknown symbol-plist (symbol) list (flushable))
163 (defknown getf (list t &optional t) t (foldable flushable))
164 (defknown get-properties (list list) (values t t list) (foldable flushable))
165 (defknown symbol-name (symbol) simple-string (movable foldable flushable))
166 (defknown make-symbol (string) symbol (flushable))
167 (defknown %make-symbol (simple-string) symbol (flushable))
168 (defknown copy-symbol (symbol &optional t) symbol (flushable))
169 (defknown gensym (&optional (or string unsigned-byte)) symbol ())
170 (defknown symbol-package (symbol) (or sb!xc:package null) (flushable))
171 (defknown keywordp (t) boolean (flushable))       ; If someone uninterns it...
172 \f
173 ;;;; from the "Packages" chapter:
174
175 (defknown gentemp (&optional string package-designator) symbol)
176
177 (defknown make-package (string-designator &key
178                                           (:use list)
179                                           (:nicknames list)
180                                           ;; ### extensions...
181                                           (:internal-symbols index)
182                                           (:external-symbols index))
183   sb!xc:package)
184 (defknown find-package (package-designator) (or sb!xc:package null)
185   (flushable))
186 (defknown package-name (package-designator) (or simple-string null)
187   (unsafely-flushable))
188 (defknown package-nicknames (package-designator) list (unsafely-flushable))
189 (defknown rename-package (package-designator package-designator &optional list)
190   sb!xc:package)
191 (defknown package-use-list (package-designator) list (unsafely-flushable))
192 (defknown package-used-by-list (package-designator) list (unsafely-flushable))
193 (defknown package-shadowing-symbols (package-designator) list (unsafely-flushable))
194 (defknown list-all-packages () list (flushable))
195 (defknown intern (string &optional package-designator)
196   (values symbol (member :internal :external :inherited nil))
197   ())
198 (defknown find-symbol (string &optional package-designator)
199   (values symbol (member :internal :external :inherited nil))
200   (flushable))
201 (defknown (export import) (symbols-designator &optional package-designator)
202   (eql t))
203 (defknown unintern (symbol &optional package-designator) boolean)
204 (defknown unexport (symbols-designator &optional package-designator) (eql t))
205 (defknown shadowing-import (symbols-designator &optional package-designator)
206   (eql t))
207 (defknown shadow ((or symbol character string list) &optional package-designator)
208   (eql t))
209 (defknown (use-package unuse-package)
210   ((or list package-designator) &optional package-designator) (eql t))
211 (defknown find-all-symbols (string-designator) list (flushable))
212 \f
213 ;;;; from the "Numbers" chapter:
214
215 (defknown zerop (number) boolean (movable foldable flushable explicit-check))
216 (defknown (plusp minusp) (real) boolean
217   (movable foldable flushable explicit-check))
218 (defknown (oddp evenp) (integer) boolean
219   (movable foldable flushable explicit-check))
220 (defknown (= /=) (number &rest number) boolean
221   (movable foldable flushable explicit-check))
222 (defknown (< > <= >=) (real &rest real) boolean
223   (movable foldable flushable explicit-check))
224 (defknown (max min) (real &rest real) real
225   (movable foldable flushable explicit-check))
226
227 (defknown + (&rest number) number
228   (movable foldable flushable explicit-check))
229 (defknown - (number &rest number) number
230   (movable foldable flushable explicit-check))
231 (defknown * (&rest number) number
232   (movable foldable flushable explicit-check))
233 (defknown / (number &rest number) number
234   (movable foldable unsafely-flushable explicit-check))
235 (defknown (1+ 1-) (number) number
236   (movable foldable flushable explicit-check))
237
238 (defknown conjugate (number) number
239   (movable foldable flushable explicit-check))
240
241 (defknown gcd (&rest integer) unsigned-byte
242   (movable foldable flushable explicit-check)
243   #|:derive-type 'boolean-result-type|#)
244 (defknown lcm (&rest integer) unsigned-byte
245   (movable foldable flushable explicit-check))
246
247 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
248 (defknown exp (number) irrational
249   (movable foldable flushable explicit-check recursive)
250   :derive-type #'result-type-float-contagion)
251
252 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
253 (defknown exp (number) irrational
254   (movable foldable flushable explicit-check recursive))
255
256 (defknown expt (number number) number
257   (movable foldable flushable explicit-check recursive))
258 (defknown log (number &optional real) irrational
259   (movable foldable flushable explicit-check))
260 (defknown sqrt (number) irrational
261   (movable foldable flushable explicit-check))
262 (defknown isqrt (unsigned-byte) unsigned-byte
263   (movable foldable flushable explicit-check recursive))
264
265 (defknown (abs phase signum) (number) number
266   (movable foldable flushable explicit-check))
267 (defknown cis (real) (complex float)
268   (movable foldable flushable explicit-check))
269
270 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
271 (progn
272 (defknown (sin cos) (number)
273   (or (float -1.0 1.0) (complex float))
274   (movable foldable flushable explicit-check recursive)
275   :derive-type #'result-type-float-contagion)
276
277 (defknown atan
278   (number &optional real) irrational
279   (movable foldable unsafely-flushable explicit-check recursive)
280   :derive-type #'result-type-float-contagion)
281
282 (defknown (tan sinh cosh tanh asinh)
283   (number) irrational (movable foldable flushable explicit-check recursive)
284   :derive-type #'result-type-float-contagion)
285 ) ; PROGN
286
287 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
288 (progn
289 (defknown (sin cos) (number)
290   (or (float -1.0 1.0) (complex float))
291   (movable foldable flushable explicit-check recursive))
292
293 (defknown atan
294   (number &optional real) irrational
295   (movable foldable unsafely-flushable explicit-check recursive))
296
297 (defknown (tan sinh cosh tanh asinh)
298   (number) irrational (movable foldable flushable explicit-check recursive))
299 ) ; PROGN
300
301 (defknown (asin acos acosh atanh)
302   (number) irrational
303   (movable foldable flushable explicit-check recursive))
304
305 (defknown float (real &optional float) float
306   (movable foldable flushable explicit-check))
307
308 (defknown (rational) (real) rational
309   (movable foldable flushable explicit-check))
310
311 (defknown (rationalize) (real) rational
312   (movable foldable flushable explicit-check recursive))
313
314 (defknown (numerator denominator) (rational) integer
315   (movable foldable flushable))
316
317 (defknown (floor ceiling truncate round)
318   (real &optional real) (values integer real)
319   (movable foldable flushable explicit-check))
320
321 (defknown (mod rem) (real real) real
322   (movable foldable flushable explicit-check))
323
324 (defknown (ffloor fceiling fround ftruncate)
325   (real &optional real) (values float real)
326   (movable foldable flushable explicit-check))
327
328 (defknown decode-float (float) (values float float-exponent float)
329   (movable foldable unsafely-flushable explicit-check))
330 (defknown scale-float (float integer) float
331   (movable foldable unsafely-flushable explicit-check))
332 (defknown float-radix (float) float-radix
333   (movable foldable unsafely-flushable))
334 (defknown float-sign (float &optional float) float
335   (movable foldable unsafely-flushable explicit-check))
336 (defknown (float-digits float-precision) (float) float-digits
337   (movable foldable unsafely-flushable explicit-check))
338 (defknown integer-decode-float (float)
339     (values integer float-int-exponent (member -1 1))
340     (movable foldable unsafely-flushable explicit-check))
341
342 (defknown complex (real &optional real) number
343   (movable foldable flushable explicit-check))
344
345 (defknown (realpart imagpart) (number) real (movable foldable flushable))
346
347 (defknown (logior logxor logand logeqv) (&rest integer) integer
348   (movable foldable flushable explicit-check))
349
350 (defknown (lognand lognor logandc1 logandc2 logorc1 logorc2)
351           (integer integer) integer
352   (movable foldable flushable explicit-check))
353
354 (defknown boole (boole-code integer integer) integer
355   (movable foldable flushable))
356
357 (defknown lognot (integer) integer (movable foldable flushable explicit-check))
358 (defknown logtest (integer integer) boolean (movable foldable flushable))
359 (defknown logbitp (unsigned-byte integer) boolean (movable foldable flushable))
360 (defknown ash (integer integer) integer
361   (movable foldable flushable explicit-check))
362 (defknown (logcount integer-length) (integer) bit-index
363   (movable foldable flushable explicit-check))
364 ;;; FIXME: According to the ANSI spec, it's legal to use any
365 ;;; nonnegative indices for BYTE arguments, not just BIT-INDEX. It's
366 ;;; hard to come up with useful ways to do this, but it is possible to
367 ;;; come up with *legal* ways to do this, so it would be nice
368 ;;; to fix this so we comply with the spec.
369 (defknown byte (bit-index bit-index) byte-specifier
370   (movable foldable flushable))
371 (defknown (byte-size byte-position) (byte-specifier) bit-index
372   (movable foldable flushable))
373 (defknown ldb (byte-specifier integer) integer (movable foldable flushable))
374 (defknown ldb-test (byte-specifier integer) boolean
375   (movable foldable flushable))
376 (defknown mask-field (byte-specifier integer) integer
377   (movable foldable flushable))
378 (defknown dpb (integer byte-specifier integer) integer
379   (movable foldable flushable))
380 (defknown deposit-field (integer byte-specifier integer) integer
381   (movable foldable flushable))
382 (defknown random ((or (float (0.0)) (integer 1)) &optional random-state)
383   (or (float 0.0) (integer 0)) ())
384 (defknown make-random-state (&optional
385                              (or (member nil t) random-state unsigned-byte
386                                  (simple-array (unsigned-byte 8) (*))
387                                  (simple-array (unsigned-byte 32) (*))))
388   random-state (flushable))
389 (defknown random-state-p (t) boolean (movable foldable flushable))
390 \f
391 ;;;; from the "Characters" chapter:
392 (defknown (standard-char-p graphic-char-p alpha-char-p
393                            upper-case-p lower-case-p both-case-p alphanumericp)
394   (character) boolean (movable foldable flushable))
395
396 (defknown digit-char-p (character &optional (integer 2 36))
397   (or (integer 0 35) null) (movable foldable flushable))
398
399 (defknown (char= char/= char< char> char<= char>= char-equal char-not-equal
400                  char-lessp char-greaterp char-not-greaterp char-not-lessp)
401   (character &rest character) boolean (movable foldable flushable))
402
403 (defknown character (t) character (movable foldable unsafely-flushable))
404 (defknown char-code (character) char-code (movable foldable flushable))
405 (defknown (char-upcase char-downcase) (character) character
406   (movable foldable flushable))
407 (defknown digit-char (unsigned-byte &optional (integer 2 36))
408   (or character null) (movable foldable flushable))
409 (defknown char-int (character) char-code (movable foldable flushable))
410 (defknown char-name (character) (or simple-string null)
411   (movable foldable flushable))
412 (defknown name-char (string-designator) (or character null)
413   (movable foldable flushable))
414 (defknown code-char (char-code) character
415   ;; By suppressing constant folding on CODE-CHAR when the
416   ;; cross-compiler is running in the cross-compilation host vanilla
417   ;; ANSI Common Lisp, we can use CODE-CHAR expressions to delay until
418   ;; target Lisp run time the generation of CHARACTERs which aren't
419   ;; STANDARD-CHARACTERs. That way, we don't need to rely on the host
420   ;; Common Lisp being able to handle any characters other than those
421   ;; guaranteed by the ANSI spec.
422   (movable #-sb-xc-host foldable flushable))
423 \f
424 ;;;; from the "Sequences" chapter:
425
426 (defknown elt (sequence index) t (foldable unsafely-flushable))
427
428 (defknown subseq (sequence index &optional sequence-end) consed-sequence
429   (flushable)
430   :derive-type (sequence-result-nth-arg 1))
431
432 (defknown copy-seq (sequence) consed-sequence (flushable)
433   :derive-type (sequence-result-nth-arg 1))
434
435 (defknown length (sequence) index (foldable flushable))
436
437 (defknown reverse (sequence) consed-sequence (flushable)
438   :derive-type (sequence-result-nth-arg 1))
439
440 (defknown nreverse (sequence) sequence (important-result)
441   :derive-type #'result-type-first-arg
442   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
443
444 (defknown make-sequence (type-specifier index
445                                         &key
446                                         (:initial-element t))
447   consed-sequence
448   (movable unsafe)
449   :derive-type (creation-result-type-specifier-nth-arg 1))
450
451 (defknown concatenate (type-specifier &rest sequence) consed-sequence
452   ()
453   :derive-type (creation-result-type-specifier-nth-arg 1))
454
455 (defknown (map %map) (type-specifier callable sequence &rest sequence)
456   consed-sequence
457   (call)
458 ; :DERIVE-TYPE 'TYPE-SPEC-ARG1 ? Nope... (MAP NIL ...) returns NULL, not NIL.
459   )
460 (defknown %map-to-list-arity-1 (callable sequence) list (flushable call))
461 (defknown %map-to-simple-vector-arity-1 (callable sequence) simple-vector
462   (flushable call))
463 (defknown %map-to-nil-on-simple-vector (callable simple-vector) null
464   (flushable call))
465 (defknown %map-to-nil-on-vector (callable vector) null (flushable call))
466 (defknown %map-to-nil-on-sequence (callable sequence) null (flushable call))
467
468 (defknown map-into (sequence callable &rest sequence)
469   sequence
470   (call)
471   :derive-type #'result-type-first-arg
472   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
473
474 ;;; returns the result from the predicate...
475 (defknown some (callable sequence &rest sequence) t
476   (foldable unsafely-flushable call))
477
478 (defknown (every notany notevery) (callable sequence &rest sequence) boolean
479   (foldable unsafely-flushable call))
480
481 ;;; unsafe for :INITIAL-VALUE...
482 (defknown reduce (callable sequence &rest t &key (:from-end t) (:start index)
483                   (:end sequence-end) (:initial-value t) (:key callable))
484   t
485   (foldable flushable call unsafe))
486
487 (defknown fill (sequence t &rest t &key
488                          (:start index) (:end sequence-end)) sequence
489   (unsafe)
490   :derive-type #'result-type-first-arg
491   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
492   :result-arg 0)
493
494 (defknown replace (sequence sequence &rest t &key (:start1 index)
495                    (:end1 sequence-end) (:start2 index) (:end2 sequence-end))
496   sequence ()
497   :derive-type #'result-type-first-arg
498   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
499   :result-arg 0)
500
501 (defknown remove
502   (t sequence &rest t &key (:from-end t) (:test callable)
503      (:test-not callable) (:start index) (:end sequence-end)
504      (:count sequence-count) (:key callable))
505   consed-sequence
506   (flushable call)
507   :derive-type (sequence-result-nth-arg 2))
508
509 (defknown substitute
510   (t t sequence &rest t &key (:from-end t) (:test callable)
511      (:test-not callable) (:start index) (:end sequence-end)
512      (:count sequence-count) (:key callable))
513   consed-sequence
514   (flushable call)
515   :derive-type (sequence-result-nth-arg 3))
516
517 (defknown (remove-if remove-if-not)
518   (callable sequence &rest t &key (:from-end t) (:start index)
519             (:end sequence-end) (:count sequence-count) (:key callable))
520   consed-sequence
521   (flushable call)
522   :derive-type (sequence-result-nth-arg 2))
523
524 (defknown (substitute-if substitute-if-not)
525   (t callable sequence &rest t &key (:from-end t) (:start index)
526      (:end sequence-end) (:count sequence-count) (:key callable))
527   consed-sequence
528   (flushable call)
529   :derive-type (sequence-result-nth-arg 3))
530
531 (defknown delete
532   (t sequence &rest t &key (:from-end t) (:test callable)
533      (:test-not callable) (:start index) (:end sequence-end)
534      (:count sequence-count) (:key callable))
535   sequence
536   (flushable call important-result)
537   :derive-type (sequence-result-nth-arg 2)
538   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
539
540 (defknown nsubstitute
541   (t t sequence &rest t &key (:from-end t) (:test callable)
542      (:test-not callable) (:start index) (:end sequence-end)
543      (:count sequence-count) (:key callable))
544   sequence
545   (flushable call)
546   :derive-type (sequence-result-nth-arg 3)
547   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
548
549 (defknown (delete-if delete-if-not)
550   (callable sequence &rest t &key (:from-end t) (:start index)
551             (:end sequence-end) (:count sequence-count) (:key callable))
552   sequence
553   (flushable call important-result)
554   :derive-type (sequence-result-nth-arg 2)
555   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
556
557 (defknown (nsubstitute-if nsubstitute-if-not)
558   (t callable sequence &rest t &key (:from-end t) (:start index)
559      (:end sequence-end) (:count sequence-count) (:key callable))
560   sequence
561   (flushable call)
562   :derive-type (sequence-result-nth-arg 3)
563   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
564
565 (defknown remove-duplicates
566   (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
567             (:from-end t) (:end sequence-end) (:key callable))
568   consed-sequence
569   (unsafely-flushable call)
570   :derive-type (sequence-result-nth-arg 1))
571
572 (defknown delete-duplicates
573   (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
574             (:from-end t) (:end sequence-end) (:key callable))
575   sequence
576   (unsafely-flushable call important-result)
577   :derive-type (sequence-result-nth-arg 1)
578   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
579
580 (defknown find (t sequence &rest t &key (:test callable)
581                 (:test-not callable) (:start index) (:from-end t)
582                 (:end sequence-end) (:key callable))
583   t
584   (foldable flushable call))
585
586 (defknown (find-if find-if-not)
587   (callable sequence &rest t &key (:from-end t) (:start index)
588    (:end sequence-end) (:key callable))
589   t
590   (foldable flushable call))
591
592 (defknown position (t sequence &rest t &key (:test callable)
593                     (:test-not callable) (:start index) (:from-end t)
594                     (:end sequence-end) (:key callable))
595   (or index null)
596   (foldable flushable call))
597
598 (defknown (position-if position-if-not)
599   (callable sequence &rest t &key (:from-end t) (:start index)
600    (:end sequence-end) (:key callable))
601   (or index null)
602   (foldable flushable call))
603
604 (defknown count (t sequence &rest t &key
605                    (:test callable) (:test-not callable) (:start index)
606                    (:from-end t) (:end sequence-end) (:key callable))
607   index
608   (foldable flushable call))
609
610 (defknown (count-if count-if-not)
611   (callable sequence &rest t &key
612             (:from-end t) (:start index) (:end sequence-end) (:key callable))
613   index
614   (foldable flushable call))
615
616 (defknown (mismatch search)
617   (sequence sequence &rest t &key (:from-end t) (:test callable)
618    (:test-not callable) (:start1 index) (:end1 sequence-end)
619    (:start2 index) (:end2 sequence-end) (:key callable))
620   (or index null)
621   (foldable flushable call))
622
623 ;;; not FLUSHABLE, since vector sort guaranteed in-place...
624 (defknown (stable-sort sort) (sequence callable &rest t &key (:key callable))
625   sequence
626   (call)
627   :derive-type (sequence-result-nth-arg 1)
628   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
629 (defknown sb!impl::stable-sort-list (list function function) list
630   (call important-result)
631   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
632 (defknown sb!impl::sort-vector (vector index index function (or function null))
633   * ; SORT-VECTOR works through side-effect
634   (call)
635   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
636
637 (defknown merge (type-specifier sequence sequence callable
638                                 &key (:key callable))
639   sequence
640   (call important-result)
641   :derive-type (creation-result-type-specifier-nth-arg 1)
642   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2 3))
643
644 ;;; not FLUSHABLE, despite what CMU CL's DEFKNOWN said..
645 (defknown read-sequence (sequence stream
646                                   &key
647                                   (:start index)
648                                   (:end sequence-end))
649   (index)
650   ())
651
652 (defknown write-sequence (sequence stream
653                                    &key
654                                    (:start index)
655                                    (:end sequence-end))
656   sequence
657   ()
658   :derive-type (sequence-result-nth-arg 1))
659 \f
660 ;;;; from the "Manipulating List Structure" chapter:
661 (defknown (car cdr first rest)
662   (list)
663   t
664   (foldable flushable))
665
666 ;; Correct argument type restrictions for these functions are
667 ;; complicated, so we just declare them to accept LISTs and suppress
668 ;; flushing is safe code.
669 (defknown (caar cadr cdar cddr
670                 caaar caadr cadar caddr cdaar cdadr cddar cdddr
671                 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
672                 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
673                 second third fourth fifth sixth seventh eighth ninth tenth)
674   (list)
675   t
676   (foldable unsafely-flushable))
677
678 (defknown cons (t t) cons (movable flushable unsafe))
679
680 (defknown tree-equal (t t &key (:test callable) (:test-not callable)) boolean
681   (foldable flushable call))
682 (defknown endp (list) boolean (foldable flushable movable))
683 (defknown list-length (list) (or index null) (foldable unsafely-flushable))
684 (defknown nth (unsigned-byte list) t (foldable flushable))
685 (defknown nthcdr (unsigned-byte list) t (foldable unsafely-flushable))
686
687 (defknown last (list &optional unsigned-byte) t (foldable flushable))
688 (defknown %last0 (list) t (foldable flushable))
689 (defknown %last1 (list) t (foldable flushable))
690 (defknown %lastn/fixnum (list (and unsigned-byte fixnum)) t (foldable flushable))
691 (defknown %lastn/bignum (list (and unsigned-byte bignum)) t (foldable flushable))
692
693 (defknown list (&rest t) list (movable flushable unsafe))
694 (defknown list* (t &rest t) t (movable flushable unsafe))
695 (defknown make-list (index &key (:initial-element t)) list
696   (movable flushable unsafe))
697
698 ;;; All but last must be of type LIST, but there seems to be no way to
699 ;;; express that in this syntax.
700 (defknown append (&rest t) t (flushable))
701
702 (defknown copy-list (list) list (flushable))
703 (defknown copy-alist (list) list (flushable))
704 (defknown copy-tree (t) t (flushable recursive))
705 (defknown revappend (list t) t (flushable))
706
707 ;;; All but last must be of type LIST, but there seems to be no way to
708 ;;; express that in this syntax. The result must be LIST, but we do
709 ;;; not check it now :-).
710 (defknown nconc (&rest t) t ()
711   :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
712 (defknown sb!impl::nconc2 (list t) t ()
713   :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
714
715 (defknown nreconc (list t) t (important-result)
716   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
717 (defknown butlast (list &optional unsigned-byte) list (flushable))
718 (defknown nbutlast (list &optional unsigned-byte) list ()
719   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
720
721 (defknown ldiff (list t) list (flushable))
722 (defknown (rplaca rplacd) (cons t) list (unsafe)
723   :destroyed-constant-args (nth-constant-args 1))
724
725 (defknown subst (t t t &key (:key callable) (:test callable)
726                    (:test-not callable))
727   t (flushable unsafe call))
728 (defknown nsubst (t t t &key (:key callable) (:test callable)
729                     (:test-not callable))
730   t (unsafe call)
731   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
732
733 (defknown (subst-if subst-if-not)
734           (t callable t &key (:key callable))
735   t (flushable unsafe call))
736 (defknown (nsubst-if nsubst-if-not)
737           (t callable t &key (:key callable))
738   t (unsafe call)
739   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
740
741 (defknown sublis (list t &key (:key callable) (:test callable)
742                        (:test-not callable))
743   t (flushable unsafe call))
744 (defknown nsublis (list t &key (:key callable) (:test callable)
745                         (:test-not callable))
746   t (flushable unsafe call)
747   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
748
749 (defknown member (t list &key (:key callable) (:test callable)
750                     (:test-not callable))
751   list (foldable flushable call))
752 (defknown (member-if member-if-not) (callable list &key (:key callable))
753   list (foldable flushable call))
754
755 (defknown tailp (t list) boolean (foldable flushable))
756
757 (defknown adjoin (t list &key (:key callable) (:test callable)
758                     (:test-not callable))
759   list (foldable flushable unsafe call))
760
761 (defknown (union intersection set-difference set-exclusive-or)
762   (list list &key (:key callable) (:test callable) (:test-not callable))
763   list
764   (foldable flushable call))
765
766 (defknown (nunion nintersection nset-difference nset-exclusive-or)
767   (list list &key (:key callable) (:test callable) (:test-not callable))
768   list
769   (foldable flushable call important-result)
770   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1 2))
771
772 (defknown subsetp
773   (list list &key (:key callable) (:test callable) (:test-not callable))
774   boolean
775   (foldable flushable call))
776
777 (defknown acons (t t t) list (movable flushable unsafe))
778 (defknown pairlis (t t &optional t) list (flushable unsafe))
779
780 (defknown (rassoc assoc)
781           (t list &key (:key callable) (:test callable) (:test-not callable))
782   list (foldable flushable call))
783 (defknown (assoc-if-not assoc-if rassoc-if rassoc-if-not)
784           (callable list &key (:key callable)) list (foldable flushable call))
785
786 (defknown (memq assq) (t list) list (foldable flushable unsafe))
787 (defknown delq (t list) list (flushable unsafe)
788   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
789 \f
790 ;;;; from the "Hash Tables" chapter:
791
792 (defknown make-hash-table
793   (&key (:test callable) (:size unsigned-byte)
794         (:rehash-size (or (integer 1) (float (1.0))))
795         (:rehash-threshold (real 0 1))
796         (:hash-function (or null callable))
797         (:weakness (member nil :key :value :key-and-value :key-or-value))
798         (:synchronized t))
799   hash-table
800   (flushable unsafe))
801 (defknown hash-table-p (t) boolean (movable foldable flushable))
802 (defknown gethash (t hash-table &optional t) (values t boolean)
803   (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
804 (defknown sb!impl::gethash2 (t hash-table) (values t boolean)
805   (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
806 (defknown sb!impl::gethash3 (t hash-table t) (values t boolean)
807   (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
808 (defknown %puthash (t hash-table t) t (unsafe)
809   :destroyed-constant-args (nth-constant-args 2))
810 (defknown remhash (t hash-table) boolean ()
811   :destroyed-constant-args (nth-constant-args 2))
812 (defknown maphash (callable hash-table) null (flushable call))
813 (defknown clrhash (hash-table) hash-table ()
814   :destroyed-constant-args (nth-constant-args 2))
815 (defknown hash-table-count (hash-table) index (flushable))
816 (defknown hash-table-rehash-size (hash-table) (or index (single-float (1.0)))
817   (foldable flushable))
818 (defknown hash-table-rehash-threshold (hash-table) (single-float (0.0) 1.0)
819   (foldable flushable))
820 (defknown hash-table-size (hash-table) index (flushable))
821 (defknown hash-table-test (hash-table) symbol (foldable flushable))
822 (defknown sxhash (t) hash (#-sb-xc-host foldable flushable))
823 (defknown psxhash (t &optional t) hash (#-sb-xc-host foldable flushable))
824 \f
825 ;;;; from the "Arrays" chapter
826
827 (defknown make-array ((or index list)
828                       &key
829                       (:element-type type-specifier)
830                       (:initial-element t)
831                       (:initial-contents t)
832                       (:adjustable t)
833                       (:fill-pointer t)
834                       (:displaced-to (or array null))
835                       (:displaced-index-offset index))
836   array (flushable unsafe))
837
838 (defknown vector (&rest t) simple-vector (flushable unsafe))
839
840 (defknown aref (array &rest index) t (foldable))
841 (defknown row-major-aref (array index) t (foldable))
842
843 (defknown array-element-type (array)
844   type-specifier
845   (foldable flushable recursive))
846 (defknown array-rank (array) array-rank (foldable flushable))
847 (defknown array-dimension (array array-rank) index (foldable flushable))
848 (defknown array-dimensions (array) list (foldable flushable))
849 (defknown array-in-bounds-p (array &rest integer) boolean (foldable flushable))
850 (defknown array-row-major-index (array &rest index) array-total-size
851   (foldable flushable))
852 (defknown array-total-size (array) array-total-size (foldable flushable))
853 (defknown adjustable-array-p (array) boolean (movable foldable flushable))
854
855 (defknown svref (simple-vector index) t (foldable flushable))
856 (defknown bit ((array bit) &rest index) bit (foldable flushable))
857 (defknown sbit ((simple-array bit) &rest index) bit (foldable flushable))
858
859 ;;; FIXME: :DESTROYED-CONSTANT-ARGS for these is complicated.
860 (defknown (bit-and bit-ior bit-xor bit-eqv bit-nand bit-nor bit-andc1 bit-andc2
861                    bit-orc1 bit-orc2)
862   ((array bit) (array bit) &optional (or (array bit) (member t nil)))
863   (array bit)
864   ()
865   #|:derive-type #'result-type-last-arg|#)
866
867 (defknown bit-not ((array bit) &optional (or (array bit) (member t nil)))
868   (array bit)
869   ()
870   #|:derive-type #'result-type-last-arg|#)
871
872 (defknown bit-vector-= (bit-vector bit-vector) boolean
873   (movable foldable flushable))
874
875 (defknown array-has-fill-pointer-p (array) boolean
876   (movable foldable flushable))
877 (defknown fill-pointer (vector) index (foldable unsafely-flushable))
878 (defknown vector-push (t vector) (or index null) ()
879   :destroyed-constant-args (nth-constant-args 2))
880 (defknown vector-push-extend (t vector &optional (and index (integer 1)))
881   index ()
882   :destroyed-constant-args (nth-constant-args 2))
883 (defknown vector-pop (vector) t ()
884   :destroyed-constant-args (nth-constant-args 1))
885
886 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
887 ;;; Also, an important-result warning could be provided if the array
888 ;;; is known to be not expressly adjustable.
889 (defknown adjust-array
890   (array (or index list) &key (:element-type type-specifier)
891          (:initial-element t) (:initial-contents t)
892          (:fill-pointer t) (:displaced-to (or array null))
893          (:displaced-index-offset index))
894   array (unsafe))
895 ;  :derive-type 'result-type-arg1) Not even close...
896 \f
897 ;;;; from the "Strings" chapter:
898
899 (defknown char (string index) character (foldable flushable))
900 (defknown schar (simple-string index) character (foldable flushable))
901
902 (defknown (string= string-equal)
903   (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
904               (:start2 index) (:end2 sequence-end))
905   boolean
906   (foldable flushable))
907
908 (defknown (string< string> string<= string>= string/= string-lessp
909                    string-greaterp string-not-lessp string-not-greaterp
910                    string-not-equal)
911   (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
912               (:start2 index) (:end2 sequence-end))
913   (or index null)
914   (foldable flushable))
915
916 (defknown make-string (index &key (:element-type type-specifier)
917                        (:initial-element character))
918   simple-string (flushable))
919
920 (defknown (string-trim string-left-trim string-right-trim)
921   (sequence string-designator) string (flushable))
922
923 (defknown (string-upcase string-downcase string-capitalize)
924   (string-designator &key (:start index) (:end sequence-end))
925   simple-string (flushable))
926
927 (defknown (nstring-upcase nstring-downcase nstring-capitalize)
928   (string &key (:start index) (:end sequence-end))
929   string ()
930   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
931
932 (defknown string (string-designator) string
933   (flushable explicit-check))
934 \f
935 ;;;; internal non-keyword versions of string predicates:
936
937 (defknown (string<* string>* string<=* string>=* string/=*)
938   (string-designator string-designator index sequence-end index sequence-end)
939   (or index null)
940   (foldable flushable))
941
942 (defknown string=*
943   (string-designator string-designator index sequence-end index sequence-end)
944   boolean
945   (foldable flushable))
946 \f
947 ;;;; from the "Eval" chapter:
948
949 (defknown eval (t) * (recursive))
950 (defknown constantp (t &optional lexenv-designator) boolean
951   (foldable flushable))
952 \f
953 ;;;; from the "Streams" chapter:
954
955 (defknown make-synonym-stream (symbol) stream (flushable))
956 (defknown make-broadcast-stream (&rest stream) stream (unsafely-flushable))
957 (defknown make-concatenated-stream (&rest stream) stream (unsafely-flushable))
958 (defknown make-two-way-stream (stream stream) stream (unsafely-flushable))
959 (defknown make-echo-stream (stream stream) stream (flushable))
960 (defknown make-string-input-stream (string &optional index sequence-end)
961   stream
962   (flushable unsafe))
963 (defknown make-string-output-stream
964     (&key (:element-type type-specifier))
965     stream
966   (flushable))
967 (defknown get-output-stream-string (stream) simple-string ())
968 (defknown streamp (t) boolean (movable foldable flushable))
969 (defknown stream-element-type (stream) type-specifier
970   (movable foldable flushable))
971 (defknown (output-stream-p input-stream-p) (stream) boolean
972   (movable foldable flushable))
973 (defknown close (stream &key (:abort t)) (eql t) ())
974 \f
975 ;;;; from the "Input/Output" chapter:
976
977 ;;; (The I/O functions are given effects ANY under the theory that
978 ;;; code motion over I/O operations is particularly confusing and not
979 ;;; very important for efficiency.)
980
981 (defknown copy-readtable (&optional (or readtable null) (or readtable null))
982   readtable
983   ())
984 (defknown readtablep (t) boolean (movable foldable flushable))
985
986 (defknown set-syntax-from-char
987   (character character &optional readtable (or readtable null)) (eql t)
988   ())
989
990 (defknown set-macro-character (character callable &optional t (or readtable null))
991   (eql t)
992   (unsafe))
993 (defknown get-macro-character (character &optional (or readtable null))
994   (values callable boolean) (flushable))
995
996 (defknown make-dispatch-macro-character (character &optional t readtable)
997   (eql t) ())
998 (defknown set-dispatch-macro-character
999   (character character callable &optional (or readtable null)) (eql t)
1000   (unsafe))
1001 (defknown get-dispatch-macro-character
1002   (character character &optional (or readtable null)) (or callable null)
1003   ())
1004
1005 (defknown copy-pprint-dispatch
1006   (&optional (or sb!pretty:pprint-dispatch-table null))
1007   sb!pretty:pprint-dispatch-table
1008   ())
1009 (defknown pprint-dispatch
1010   (t &optional (or sb!pretty:pprint-dispatch-table null))
1011   (values callable boolean)
1012   ())
1013 (defknown (pprint-fill pprint-linear)
1014   (stream-designator t &optional t t)
1015   null
1016   ())
1017 (defknown pprint-tabular
1018   (stream-designator t &optional t t unsigned-byte)
1019   null
1020   ())
1021 (defknown pprint-indent
1022   ((member :block :current) real &optional stream-designator)
1023   null
1024   ())
1025 (defknown pprint-newline
1026   ((member :linear :fill :miser :mandatory) &optional stream-designator)
1027   null
1028   ())
1029 (defknown pprint-tab
1030   ((member :line :section :line-relative :section-relative)
1031    unsigned-byte unsigned-byte &optional stream-designator)
1032   null
1033   ())
1034 (defknown set-pprint-dispatch
1035   (type-specifier (or null callable)
1036    &optional real sb!pretty:pprint-dispatch-table)
1037   null
1038   ())
1039
1040 ;;; may return any type due to eof-value...
1041 (defknown (read read-preserving-whitespace read-char-no-hang read-char)
1042   (&optional stream-designator t t t) t (explicit-check))
1043
1044 (defknown read-delimited-list (character &optional stream-designator t) list
1045   (explicit-check))
1046 (defknown read-line (&optional stream-designator t t t) (values t boolean)
1047   (explicit-check))
1048 (defknown unread-char (character &optional stream-designator) t
1049   (explicit-check))
1050 (defknown peek-char (&optional (or character (member nil t))
1051                                stream-designator t t t)
1052   t
1053   (explicit-check))
1054 (defknown listen (&optional stream-designator) boolean (flushable explicit-check))
1055
1056 (defknown clear-input (&optional stream-designator) null (explicit-check))
1057
1058 (defknown read-from-string
1059   (string &optional t t
1060           &key
1061           (:start index)
1062           (:end sequence-end)
1063           (:preserve-whitespace t))
1064   (values t index))
1065 (defknown parse-integer
1066   (string &key
1067           (:start index)
1068           (:end sequence-end)
1069           (:radix (integer 2 36))
1070           (:junk-allowed t))
1071   (values (or integer null ()) index))
1072
1073 (defknown read-byte (stream &optional t t) t (explicit-check))
1074
1075 (defknown write
1076   (t &key
1077      (:stream stream-designator)
1078      (:escape t)
1079      (:radix t)
1080      (:base (integer 2 36))
1081      (:circle t)
1082      (:pretty t)
1083      (:level (or unsigned-byte null))
1084      (:readably t)
1085      (:length (or unsigned-byte null))
1086      (:case t)
1087      (:array t)
1088      (:gensym t)
1089      (:lines (or unsigned-byte null))
1090      (:right-margin (or unsigned-byte null))
1091      (:miser-width (or unsigned-byte null))
1092      (:pprint-dispatch t))
1093   t
1094   (any explicit-check)
1095   :derive-type #'result-type-first-arg)
1096
1097 (defknown (prin1 print princ) (t &optional stream-designator)
1098   t
1099   (any explicit-check)
1100   :derive-type #'result-type-first-arg)
1101
1102 ;;; xxx-TO-STRING functions are not foldable because they depend on
1103 ;;; the dynamic environment, the state of the pretty printer dispatch
1104 ;;; table, and probably other run-time factors.
1105 (defknown write-to-string
1106   (t &key (:escape t) (:radix t) (:base (integer 2 36)) (:readably t)
1107      (:circle t) (:pretty t) (:level (or unsigned-byte null))
1108      (:length (or unsigned-byte null)) (:case t) (:array t) (:gensym t)
1109      (:lines (or unsigned-byte null)) (:right-margin (or unsigned-byte null))
1110      (:miser-width (or unsigned-byte null)) (:pprint-dispatch t))
1111   simple-string
1112   (flushable explicit-check))
1113
1114 (defknown (prin1-to-string princ-to-string) (t) simple-string (flushable))
1115
1116 (defknown write-char (character &optional stream-designator) character
1117   (explicit-check))
1118 (defknown (write-string write-line)
1119   (string &optional stream-designator &key (:start index) (:end sequence-end))
1120   string
1121   (explicit-check))
1122
1123 (defknown (terpri finish-output force-output clear-output)
1124   (&optional stream-designator) null
1125   (explicit-check))
1126
1127 (defknown fresh-line (&optional stream-designator) boolean
1128   (explicit-check))
1129
1130 (defknown write-byte (integer stream) integer
1131   (explicit-check))
1132
1133 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
1134 (defknown format ((or (member nil t) stream string)
1135                   (or string function) &rest t)
1136   (or string null)
1137   (explicit-check))
1138
1139 (defknown (y-or-n-p yes-or-no-p) (&optional string &rest t) boolean
1140   (explicit-check))
1141 \f
1142 ;;;; from the "File System Interface" chapter:
1143
1144 ;;; (No pathname functions are FOLDABLE because they all potentially
1145 ;;; depend on *DEFAULT-PATHNAME-DEFAULTS*, e.g. to provide a default
1146 ;;; host when parsing a namestring. They are not FLUSHABLE because
1147 ;;; parsing of a PATHNAME-DESIGNATOR might signal an error.)
1148
1149 (defknown wild-pathname-p (pathname-designator
1150                            &optional
1151                            (member nil :host :device
1152                                    :directory :name
1153                                    :type :version))
1154   generalized-boolean
1155   ())
1156 (defknown pathname-match-p (pathname-designator pathname-designator)
1157   generalized-boolean
1158   ())
1159 (defknown translate-pathname (pathname-designator
1160                               pathname-designator
1161                               pathname-designator &key)
1162   pathname
1163   ())
1164
1165 (defknown logical-pathname (pathname-designator) logical-pathname ())
1166 (defknown translate-logical-pathname (pathname-designator &key) pathname
1167   (recursive))
1168 (defknown load-logical-pathname-translations (string) t ())
1169 (defknown logical-pathname-translations (logical-host-designator) list ())
1170
1171 (defknown pathname (pathname-designator) pathname ())
1172 (defknown truename (pathname-designator) pathname ())
1173
1174 (defknown parse-namestring
1175   (pathname-designator &optional
1176                        (or list host string (member :unspecific))
1177                        pathname-designator
1178                        &key
1179                        (:start index)
1180                        (:end sequence-end)
1181                        (:junk-allowed t))
1182   (values (or pathname null) sequence-end)
1183   ())
1184
1185 (defknown merge-pathnames
1186   (pathname-designator &optional pathname-designator pathname-version)
1187   pathname
1188   ())
1189
1190 (defknown make-pathname
1191  (&key (:defaults pathname-designator)
1192        (:host (or string pathname-host))
1193        (:device (or string pathname-device))
1194        (:directory (or pathname-directory string (member :wild)))
1195        (:name (or pathname-name string (member :wild)))
1196        (:type (or pathname-type string (member :wild)))
1197        (:version pathname-version) (:case (member :local :common)))
1198   pathname (unsafely-flushable))
1199
1200 (defknown pathnamep (t) boolean (movable flushable))
1201
1202 (defknown pathname-host (pathname-designator
1203                          &key (:case (member :local :common)))
1204   pathname-host (flushable))
1205 (defknown pathname-device (pathname-designator
1206                            &key (:case (member :local :common)))
1207   pathname-device (flushable))
1208 (defknown pathname-directory (pathname-designator
1209                               &key (:case (member :local :common)))
1210   pathname-directory (flushable))
1211 (defknown pathname-name (pathname-designator
1212                          &key (:case (member :local :common)))
1213   pathname-name (flushable))
1214 (defknown pathname-type (pathname-designator
1215                          &key (:case (member :local :common)))
1216   pathname-type (flushable))
1217 (defknown pathname-version (pathname-designator)
1218   pathname-version (flushable))
1219
1220 (defknown (namestring file-namestring directory-namestring host-namestring)
1221   (pathname-designator) (or simple-string null)
1222   (unsafely-flushable))
1223
1224 (defknown enough-namestring (pathname-designator &optional pathname-designator)
1225   simple-string
1226   (unsafely-flushable))
1227
1228 (defknown user-homedir-pathname (&optional t) pathname (flushable))
1229
1230 (defknown open
1231   (pathname-designator &key
1232                        (:direction (member :input :output :io :probe))
1233                        (:element-type type-specifier)
1234                        (:if-exists (member :error :new-version :rename
1235                                            :rename-and-delete :overwrite
1236                                            :append :supersede nil))
1237                        (:if-does-not-exist (member :error :create nil))
1238                        (:external-format external-format-designator))
1239   (or stream null))
1240
1241 (defknown rename-file (pathname-designator filename)
1242   (values pathname pathname pathname))
1243 (defknown delete-file (pathname-designator) t)
1244 (defknown probe-file (pathname-designator) (or pathname null) ())
1245 (defknown file-write-date (pathname-designator) (or unsigned-byte null)
1246   ())
1247 (defknown file-author (pathname-designator) (or simple-string null)
1248   ())
1249
1250 (defknown file-position (stream &optional
1251                                 (or unsigned-byte (member :start :end)))
1252   (or unsigned-byte (member t nil)))
1253 (defknown file-length (stream) (or unsigned-byte null) (unsafely-flushable))
1254
1255 (defknown load
1256   ((or filename stream)
1257    &key
1258    (:verbose t)
1259    (:print t)
1260    (:if-does-not-exist t)
1261    (:external-format external-format-designator))
1262   t)
1263
1264 (defknown directory (pathname-designator &key (:resolve-symlinks t))
1265   list ())
1266 \f
1267 ;;;; from the "Conditions" chapter:
1268
1269 (defknown cell-error-name (cell-error) t)
1270 (defknown error (t &rest t) nil)
1271 (defknown cerror (format-control t &rest t) null)
1272 (defknown invalid-method-error (t format-control &rest t) *) ; FIXME: first arg is METHOD
1273 (defknown method-combination-error (format-control &rest t) *)
1274 (defknown signal (t &rest t) null)
1275 (defknown simple-condition-format-control (condition)
1276   format-control)
1277 (defknown simple-condition-format-arguments (condition)
1278   list)
1279 (defknown warn (t &rest t) null)
1280 (defknown invoke-debugger (condition) nil)
1281 (defknown break (&optional format-control &rest t) null)
1282 (defknown make-condition (type-specifier &rest t) condition)
1283 (defknown compute-restarts (&optional (or condition null)) list)
1284 (defknown find-restart (restart-designator &optional (or condition null))
1285   (or restart null))
1286 (defknown invoke-restart (restart-designator &rest t) *)
1287 (defknown invoke-restart-interactively (restart-designator) *)
1288 (defknown restart-name (restart) symbol)
1289 (defknown (abort muffle-warning) (&optional (or condition null)) nil)
1290 (defknown continue (&optional (or condition null)) null)
1291 (defknown (store-value use-value) (t &optional (or condition null))
1292   null)
1293
1294 ;;; and analogous SBCL extension:
1295 (defknown bug (t &rest t) nil) ; never returns
1296 \f
1297 ;;;; from the "Miscellaneous" Chapter:
1298
1299 (defknown compile ((or symbol cons) &optional (or list function null))
1300   (values (or function symbol cons) boolean boolean))
1301
1302 (defknown compile-file
1303   (pathname-designator
1304    &key
1305
1306    ;; ANSI options
1307    (:output-file (or pathname-designator
1308                      null
1309                      ;; FIXME: This last case is a non-ANSI hack.
1310                      (member t)))
1311    (:verbose t)
1312    (:print t)
1313    (:external-format external-format-designator)
1314
1315    ;; extensions
1316    (:trace-file t)
1317    (:block-compile t)
1318    (:emit-cfasl t))
1319   (values (or pathname null) boolean boolean))
1320
1321 ;; FIXME: consider making (OR CALLABLE CONS) something like
1322 ;; EXTENDED-FUNCTION-DESIGNATOR
1323 (defknown disassemble ((or callable cons) &key
1324                        (:stream stream) (:use-labels t))
1325   null)
1326
1327 (defknown describe (t &optional (or stream (member t nil))) (values))
1328 (defknown inspect (t) (values))
1329 (defknown room (&optional (member t nil :default)) (values))
1330 (defknown ed (&optional (or symbol cons filename))
1331   t)
1332 (defknown dribble (&optional filename &key (:if-exists t)) (values))
1333
1334 (defknown apropos      (string-designator &optional package-designator t) (values))
1335 (defknown apropos-list (string-designator &optional package-designator t) list
1336   (flushable))
1337
1338 (defknown get-decoded-time ()
1339   (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1340           (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1341   (flushable))
1342
1343 (defknown get-universal-time () unsigned-byte (flushable))
1344
1345 (defknown decode-universal-time
1346           (unsigned-byte &optional (or null (rational -24 24)))
1347   (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1348           (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1349   (flushable))
1350
1351 (defknown encode-universal-time
1352   ((integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1353    (integer 1 12) unsigned-byte &optional (or null (rational -24 24)))
1354   unsigned-byte
1355   (flushable))
1356
1357 (defknown (get-internal-run-time get-internal-real-time)
1358   () internal-time (flushable))
1359
1360 (defknown sleep ((or (rational 0) (float 0.0))) null)
1361
1362 ;;; Even though ANSI defines LISP-IMPLEMENTATION-TYPE and
1363 ;;; LISP-IMPLEMENTATION-VERSION to possibly punt and return NIL, we
1364 ;;; know that there's no valid reason for our implementations to ever
1365 ;;; do so, so we can safely guarantee that they'll return strings.
1366 (defknown (lisp-implementation-type lisp-implementation-version)
1367   () simple-string (flushable))
1368
1369 ;;; For any of these functions, meaningful information might not be
1370 ;;; available, so -- unlike the related LISP-IMPLEMENTATION-FOO
1371 ;;; functions -- these really can return NIL.
1372 (defknown (machine-type machine-version machine-instance
1373            software-type software-version
1374            short-site-name long-site-name)
1375   () (or simple-string null) (flushable))
1376
1377 (defknown identity (t) t (movable foldable flushable unsafe)
1378   :derive-type #'result-type-first-arg)
1379
1380 (defknown constantly (t) function (movable flushable))
1381 (defknown complement (function) function (movable flushable))
1382 \f
1383 ;;;; miscellaneous extensions
1384
1385 (defknown symbol-global-value (symbol) t ())
1386 (defknown set-symbol-global-value (symbol t) t ())
1387
1388 (defknown get-bytes-consed () unsigned-byte (flushable))
1389 (defknown mask-signed-field ((integer 0 *) integer) integer
1390           (movable flushable foldable))
1391
1392 (defknown array-storage-vector (array) (simple-array * (*))
1393     (any))
1394 \f
1395 ;;;; magical compiler frobs
1396
1397 (defknown %unary-truncate/single-float (single-float) integer (movable foldable flushable))
1398 (defknown %unary-truncate/double-float (double-float) integer (movable foldable flushable))
1399
1400 ;;; We can't fold this in general because of SATISFIES. There is a
1401 ;;; special optimizer anyway.
1402 (defknown %typep (t (or type-specifier ctype)) boolean
1403   (movable flushable explicit-check))
1404 (defknown %instance-typep (t (or type-specifier ctype)) boolean
1405   (movable flushable explicit-check))
1406
1407 (defknown %cleanup-point () t)
1408 (defknown %special-bind (t t) t)
1409 (defknown %special-unbind (t) t)
1410 (defknown %listify-rest-args (t index) list (flushable))
1411 (defknown %more-arg-context (t t) (values t index) (flushable))
1412 (defknown %more-arg (t index) t)
1413 #!+stack-grows-downward-not-upward
1414 ;;; FIXME: The second argument here should really be NEGATIVE-INDEX, but doing that
1415 ;;; breaks the build, and I cannot seem to figure out why. --NS 2006-06-29
1416 (defknown %more-kw-arg (t fixnum) (values t t))
1417 (defknown %more-arg-values (t index index) * (flushable))
1418 (defknown %verify-arg-count (index index) (values))
1419 (defknown %arg-count-error (t) nil)
1420 (defknown %unknown-values () *)
1421 (defknown %catch (t t) t)
1422 (defknown %unwind-protect (t t) t)
1423 (defknown (%catch-breakup %unwind-protect-breakup) () t)
1424 (defknown %lexical-exit-breakup (t) t)
1425 (defknown %continue-unwind (t t t) nil)
1426 (defknown %throw (t &rest t) nil) ; This is MV-called.
1427 (defknown %nlx-entry (t) *)
1428 (defknown %%primitive (t t &rest t) *)
1429 (defknown %pop-values (t) t)
1430 (defknown %nip-values (t t &rest t) (values))
1431 (defknown %allocate-closures (t) *)
1432 (defknown %type-check-error (t t) nil)
1433
1434 ;; FIXME: This function does not return, but due to the implementation
1435 ;; of FILTER-LVAR we cannot write it here.
1436 (defknown %compile-time-type-error (t t t) *)
1437 (defknown sb!kernel::case-failure (t t t) nil)
1438
1439 (defknown %odd-key-args-error () nil)
1440 (defknown %unknown-key-arg-error (t) nil)
1441 (defknown (%ldb %mask-field) (bit-index bit-index integer) unsigned-byte
1442   (movable foldable flushable explicit-check))
1443 (defknown (%dpb %deposit-field) (integer bit-index bit-index integer) integer
1444   (movable foldable flushable explicit-check))
1445 (defknown %negate (number) number (movable foldable flushable explicit-check))
1446 (defknown %check-bound (array index fixnum) index (movable foldable flushable))
1447 (defknown data-vector-ref (simple-array index) t
1448   (foldable explicit-check always-translatable))
1449 (defknown data-vector-ref-with-offset (simple-array index fixnum) t
1450   (foldable explicit-check always-translatable))
1451 (defknown data-vector-set (array index t) t
1452   (unsafe explicit-check always-translatable))
1453 (defknown data-vector-set-with-offset (array index fixnum t) t
1454   (unsafe explicit-check always-translatable))
1455 (defknown hairy-data-vector-ref (array index) t
1456   (foldable explicit-check))
1457 (defknown hairy-data-vector-set (array index t) t (unsafe explicit-check))
1458 (defknown hairy-data-vector-ref/check-bounds (array index) t
1459   (foldable explicit-check))
1460 (defknown hairy-data-vector-set/check-bounds (array index t)
1461   t
1462   (unsafe explicit-check))
1463 (defknown %caller-frame () t (flushable))
1464 (defknown %caller-pc () system-area-pointer (flushable))
1465 (defknown %with-array-data (array index (or index null))
1466   (values (simple-array * (*)) index index index)
1467   (foldable flushable))
1468 (defknown %with-array-data/fp (array index (or index null))
1469   (values (simple-array * (*)) index index index)
1470   (foldable flushable))
1471 (defknown %set-symbol-package (symbol t) t (unsafe))
1472 (defknown %coerce-name-to-fun ((or symbol cons)) function (flushable))
1473 (defknown %coerce-callable-to-fun (callable) function (flushable))
1474 (defknown array-bounding-indices-bad-error (t t t) nil)
1475 (defknown sequence-bounding-indices-bad-error (t t t) nil)
1476 (defknown %find-position
1477   (t sequence t index sequence-end function function)
1478   (values t (or index null))
1479   (flushable call))
1480 (defknown (%find-position-if %find-position-if-not)
1481   (function sequence t index sequence-end function)
1482   (values t (or index null))
1483   (call))
1484 (defknown effective-find-position-test (callable callable)
1485   function
1486   (flushable foldable))
1487 (defknown effective-find-position-key (callable)
1488   function
1489   (flushable foldable))
1490
1491 (defknown %adjoin     (t list)          list (explicit-check foldable flushable))
1492 (defknown %adjoin-key (t list function) list (explicit-check foldable flushable call))
1493 (defknown %assoc      (t list)          list (explicit-check foldable flushable))
1494 (defknown %assoc-key  (t list function) list (explicit-check foldable flushable call))
1495 (defknown %member     (t list)          list (explicit-check foldable flushable))
1496 (defknown %member-key (t list function) list (explicit-check foldable flushable call))
1497 (defknown %rassoc     (t list)          list (explicit-check foldable flushable))
1498 (defknown %rassoc-key (t list function) list (explicit-check foldable flushable call))
1499
1500 (defknown %check-vector-sequence-bounds (vector index sequence-end)
1501   index
1502   (unwind))
1503 ;;; FIXME: including this information here is probably necessary to
1504 ;;; get efficient compilation of the inline expansion of
1505 ;;; %FIND-POSITION-IF, so it should maybe be in a more
1506 ;;; compiler-friendly package (SB-INT?)
1507 (defknown sb!impl::signal-bounding-indices-bad-error
1508     (sequence index sequence-end)
1509   nil) ; never returns
1510
1511
1512 (defknown arg-count-error (t t t t t t) nil (unsafe))
1513 \f
1514 ;;;; SETF inverses
1515
1516 (defknown %aset (array &rest t) t (unsafe)
1517   :destroyed-constant-args (nth-constant-args 1))
1518 (defknown %set-row-major-aref (array index t) t (unsafe)
1519   :destroyed-constant-args (nth-constant-args 1))
1520 (defknown (%rplaca %rplacd) (cons t) t (unsafe)
1521   :destroyed-constant-args (nth-constant-args 1))
1522 (defknown %put (symbol t t) t (unsafe))
1523 (defknown %setelt (sequence index t) t (unsafe)
1524   :destroyed-constant-args (nth-constant-args 1))
1525 (defknown %svset (simple-vector index t) t (unsafe)
1526   :destroyed-constant-args (nth-constant-args 1))
1527 (defknown %bitset ((array bit) &rest index) bit (unsafe)
1528   :destroyed-constant-args (nth-constant-args 1))
1529 (defknown %sbitset ((simple-array bit) &rest index) bit (unsafe)
1530   :destroyed-constant-args (nth-constant-args 1))
1531 (defknown %charset (string index character) character (unsafe)
1532   :destroyed-constant-args (nth-constant-args 1))
1533 (defknown %scharset (simple-string index character) character (unsafe)
1534   :destroyed-constant-args (nth-constant-args 1))
1535 (defknown %set-symbol-value (symbol t) t (unsafe))
1536 (defknown (setf symbol-function) (function symbol) function (unsafe))
1537 (defknown %set-symbol-plist (symbol list) list (unsafe))
1538 (defknown %setnth (unsigned-byte list t) t (unsafe)
1539   :destroyed-constant-args (nth-constant-args 2))
1540 (defknown %set-fill-pointer (vector index) index (unsafe)
1541   :destroyed-constant-args (nth-constant-args 1))
1542 \f
1543 ;;;; ALIEN and call-out-to-C stuff
1544
1545 ;; Used by WITH-PINNED-OBJECTS
1546 #!+(or x86 x86-64)
1547 (defknown sb!vm::touch-object (t) (values)
1548     (unsafe always-translatable))
1549
1550 #!+linkage-table
1551 (defknown foreign-symbol-dataref-sap (simple-string)
1552   system-area-pointer
1553   (movable flushable))
1554
1555 (defknown foreign-symbol-sap (simple-string &optional boolean)
1556   system-area-pointer
1557   (movable flushable))
1558
1559 (defknown foreign-symbol-address (simple-string &optional boolean)
1560   (values integer boolean)
1561   (movable flushable))
1562
1563 ;;;; miscellaneous internal utilities
1564
1565 (defknown %fun-name (function) t (flushable))
1566 (defknown (setf %fun-name) (t function) t (unsafe))
1567
1568 (defknown policy-quality (policy symbol) policy-quality
1569           (flushable))
1570
1571 (defknown compiler-error (t &rest t) nil ())
1572 (defknown (compiler-warn compiler-style-warn) (t &rest t) (values) ())
1573 (defknown (compiler-notify maybe-compiler-notify) ((or string symbol) &rest t)
1574   (values)
1575   ())
1576 (defknown style-warn (t &rest t) null ())
1577
1578 ;;;; atomic ops
1579 (defknown %compare-and-swap-svref (simple-vector index t t) t
1580     (unsafe))
1581 (defknown %compare-and-swap-instance-ref (instance index t t) t
1582     (unsafe))
1583 (defknown %compare-and-swap-symbol-value (symbol t t) t
1584     (unsafe unwind))