0.9.17:
[sbcl/lichteblau.git] / src / compiler / fndb.lisp
blob71eb2727015dc3e8439a6055cf11a38a5a54b170
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.
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.
14 (in-package "SB!C")
16 ;;;; information for known functions:
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.
25 (defknown list-to-vector* (list type-specifier) vector)
26 (defknown vector-to-vector* (vector type-specifier) vector)
28 (defknown type-of (t) t (foldable flushable))
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))
35 ;;;; from the "Predicates" chapter:
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.
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.
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))
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))
77 (defknown (eq eql) (t t) boolean (movable foldable flushable))
78 (defknown (equal equalp) (t t) boolean (foldable flushable recursive))
80 ;;;; classes
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 lexenv-designator)
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))
91 ;;;; from the "Control Structure" chapter:
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 ())
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) *)
124 (defknown (mapcar maplist) (callable list &rest list) list
125 (call))
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))
132 (defknown (mapc mapl) (callable list &rest list) list (foldable call))
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))
140 ;;;; from the "Macros" chapter:
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))
148 (defknown compiler-macro-function (t &optional lexenv-designator)
149 (or function null)
150 (flushable))
152 ;;;; from the "Declarations" chapter:
154 (defknown proclaim (list) (values) (recursive))
156 ;;;; from the "Symbols" chapter:
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...
173 ;;;; from the "Packages" chapter:
175 (defknown gentemp (&optional string package-designator) symbol)
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))
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 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))
213 ;;;; from the "Numbers" chapter:
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))
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 flushable explicit-check))
235 (defknown (1+ 1-) (number) number
236 (movable foldable flushable explicit-check))
238 (defknown conjugate (number) number
239 (movable foldable flushable explicit-check))
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))
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)
252 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
253 (defknown exp (number) irrational
254 (movable foldable flushable explicit-check recursive))
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))
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))
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)
277 (defknown atan
278 (number &optional real) irrational
279 (movable foldable unsafely-flushable explicit-check recursive)
280 :derive-type #'result-type-float-contagion)
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
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))
293 (defknown atan
294 (number &optional real) irrational
295 (movable foldable unsafely-flushable explicit-check recursive))
297 (defknown (tan sinh cosh tanh asinh)
298 (number) irrational (movable foldable flushable explicit-check recursive))
299 ) ; PROGN
301 (defknown (asin acos acosh atanh)
302 (number) irrational
303 (movable foldable flushable explicit-check recursive))
305 (defknown float (real &optional float) float
306 (movable foldable flushable explicit-check))
308 (defknown (rational) (real) rational
309 (movable foldable flushable explicit-check))
311 (defknown (rationalize) (real) rational
312 (movable foldable flushable explicit-check recursive))
314 (defknown (numerator denominator) (rational) integer
315 (movable foldable flushable))
317 (defknown (floor ceiling truncate round)
318 (real &optional real) (values integer real)
319 (movable foldable flushable explicit-check))
321 (defknown (mod rem) (real real) real
322 (movable foldable flushable explicit-check))
324 (defknown (ffloor fceiling fround ftruncate)
325 (real &optional real) (values float real)
326 (movable foldable flushable explicit-check))
328 (defknown decode-float (float) (values float float-exponent float)
329 (movable foldable 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 flushable))
334 (defknown float-sign (float &optional float) float
335 (movable foldable flushable explicit-check))
336 (defknown (float-digits float-precision) (float) float-digits
337 (movable foldable flushable explicit-check))
338 (defknown integer-decode-float (float)
339 (values integer float-int-exponent (member -1 1))
340 (movable foldable flushable explicit-check))
342 (defknown complex (real &optional real) number
343 (movable foldable flushable explicit-check))
345 (defknown (realpart imagpart) (number) real (movable foldable flushable))
347 (defknown (logior logxor logand logeqv) (&rest integer) integer
348 (movable foldable flushable explicit-check))
350 (defknown (lognand lognor logandc1 logandc2 logorc1 logorc2)
351 (integer integer) integer
352 (movable foldable flushable explicit-check))
354 (defknown boole (boole-code integer integer) integer
355 (movable foldable flushable))
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 (or (member nil t) random-state))
385 random-state (flushable))
386 (defknown random-state-p (t) boolean (movable foldable flushable))
388 ;;;; from the "Characters" chapter:
389 (defknown (standard-char-p graphic-char-p alpha-char-p
390 upper-case-p lower-case-p both-case-p alphanumericp)
391 (character) boolean (movable foldable flushable))
393 (defknown digit-char-p (character &optional (integer 2 36))
394 (or (integer 0 35) null) (movable foldable flushable))
396 (defknown (char= char/= char< char> char<= char>= char-equal char-not-equal
397 char-lessp char-greaterp char-not-greaterp char-not-lessp)
398 (character &rest character) boolean (movable foldable flushable))
400 (defknown character (t) character (movable foldable unsafely-flushable))
401 (defknown char-code (character) char-code (movable foldable flushable))
402 (defknown (char-upcase char-downcase) (character) character
403 (movable foldable flushable))
404 (defknown digit-char (unsigned-byte &optional (integer 2 36))
405 (or character null) (movable foldable flushable))
406 (defknown char-int (character) char-code (movable foldable flushable))
407 (defknown char-name (character) (or simple-string null)
408 (movable foldable flushable))
409 (defknown name-char (string-designator) (or character null)
410 (movable foldable flushable))
411 (defknown code-char (char-code) character
412 ;; By suppressing constant folding on CODE-CHAR when the
413 ;; cross-compiler is running in the cross-compilation host vanilla
414 ;; ANSI Common Lisp, we can use CODE-CHAR expressions to delay until
415 ;; target Lisp run time the generation of CHARACTERs which aren't
416 ;; STANDARD-CHARACTERs. That way, we don't need to rely on the host
417 ;; Common Lisp being able to handle any characters other than those
418 ;; guaranteed by the ANSI spec.
419 (movable #-sb-xc-host foldable flushable))
421 ;;;; from the "Sequences" chapter:
423 (defknown elt (sequence index) t (foldable unsafely-flushable))
425 (defknown subseq (sequence index &optional sequence-end) consed-sequence
426 (flushable)
427 :derive-type (sequence-result-nth-arg 1))
429 (defknown copy-seq (sequence) consed-sequence (flushable)
430 :derive-type (sequence-result-nth-arg 1))
432 (defknown length (sequence) index (foldable flushable))
434 (defknown reverse (sequence) consed-sequence (flushable)
435 :derive-type (sequence-result-nth-arg 1))
437 (defknown nreverse (sequence) sequence (important-result)
438 :derive-type #'result-type-first-arg
439 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
441 (defknown make-sequence (type-specifier index
442 &key
443 (:initial-element t))
444 consed-sequence
445 (movable unsafe)
446 :derive-type (creation-result-type-specifier-nth-arg 1))
448 (defknown concatenate (type-specifier &rest sequence) consed-sequence
450 :derive-type (creation-result-type-specifier-nth-arg 1))
452 (defknown (map %map) (type-specifier callable sequence &rest sequence)
453 consed-sequence
454 (call)
455 ; :DERIVE-TYPE 'TYPE-SPEC-ARG1 ? Nope... (MAP NIL ...) returns NULL, not NIL.
457 (defknown %map-to-list-arity-1 (callable sequence) list (flushable call))
458 (defknown %map-to-simple-vector-arity-1 (callable sequence) simple-vector
459 (flushable call))
460 (defknown %map-to-nil-on-simple-vector (callable simple-vector) null
461 (flushable call))
462 (defknown %map-to-nil-on-vector (callable vector) null (flushable call))
463 (defknown %map-to-nil-on-sequence (callable sequence) null (flushable call))
465 (defknown map-into (sequence callable &rest sequence)
466 sequence
467 (call)
468 :derive-type #'result-type-first-arg
469 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
471 ;;; returns the result from the predicate...
472 (defknown some (callable sequence &rest sequence) t
473 (foldable unsafely-flushable call))
475 (defknown (every notany notevery) (callable sequence &rest sequence) boolean
476 (foldable unsafely-flushable call))
478 ;;; unsafe for :INITIAL-VALUE...
479 (defknown reduce (callable
480 sequence
481 &key
482 (:from-end t)
483 (:start index)
484 (:end sequence-end)
485 (:initial-value t)
486 (:key callable))
488 (foldable flushable call unsafe))
490 (defknown fill (sequence t &key (:start index) (:end sequence-end)) sequence
491 (unsafe)
492 :derive-type #'result-type-first-arg
493 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
495 (defknown replace (sequence
496 sequence
497 &key
498 (:start1 index)
499 (:end1 sequence-end)
500 (:start2 index)
501 (:end2 sequence-end))
502 sequence ()
503 :derive-type #'result-type-first-arg
504 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
506 (defknown remove
507 (t sequence &key (:from-end t) (:test callable)
508 (:test-not callable) (:start index) (:end sequence-end)
509 (:count sequence-count) (:key callable))
510 consed-sequence
511 (flushable call)
512 :derive-type (sequence-result-nth-arg 2))
514 (defknown substitute
515 (t t sequence &key (:from-end t) (:test callable)
516 (:test-not callable) (:start index) (:end sequence-end)
517 (:count sequence-count) (:key callable))
518 consed-sequence
519 (flushable call)
520 :derive-type (sequence-result-nth-arg 3))
522 (defknown (remove-if remove-if-not)
523 (callable sequence &key (:from-end t) (:start index) (:end sequence-end)
524 (:count sequence-count) (:key callable))
525 consed-sequence
526 (flushable call)
527 :derive-type (sequence-result-nth-arg 2))
529 (defknown (substitute-if substitute-if-not)
530 (t callable sequence &key (:from-end t) (:start index) (:end sequence-end)
531 (:count sequence-count) (:key callable))
532 consed-sequence
533 (flushable call)
534 :derive-type (sequence-result-nth-arg 3))
536 (defknown delete
537 (t sequence &key (:from-end t) (:test callable)
538 (:test-not callable) (:start index) (:end sequence-end)
539 (:count sequence-count) (:key callable))
540 sequence
541 (flushable call important-result)
542 :derive-type (sequence-result-nth-arg 2)
543 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
545 (defknown nsubstitute
546 (t t sequence &key (:from-end t) (:test callable)
547 (:test-not callable) (:start index) (:end sequence-end)
548 (:count sequence-count) (:key callable))
549 sequence
550 (flushable call)
551 :derive-type (sequence-result-nth-arg 3)
552 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
554 (defknown (delete-if delete-if-not)
555 (callable sequence &key (:from-end t) (:start index) (:end sequence-end)
556 (:count sequence-count) (:key callable))
557 sequence
558 (flushable call important-result)
559 :derive-type (sequence-result-nth-arg 2)
560 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
562 (defknown (nsubstitute-if nsubstitute-if-not)
563 (t callable sequence &key (:from-end t) (:start index) (:end sequence-end)
564 (:count sequence-count) (:key callable))
565 sequence
566 (flushable call)
567 :derive-type (sequence-result-nth-arg 3)
568 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
570 (defknown remove-duplicates
571 (sequence &key (:test callable) (:test-not callable) (:start index)
572 (:from-end t) (:end sequence-end) (:key callable))
573 consed-sequence
574 (unsafely-flushable call)
575 :derive-type (sequence-result-nth-arg 1))
577 (defknown delete-duplicates
578 (sequence &key (:test callable) (:test-not callable) (:start index)
579 (:from-end t) (:end sequence-end) (:key callable))
580 sequence
581 (unsafely-flushable call important-result)
582 :derive-type (sequence-result-nth-arg 1)
583 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
585 (defknown find (t sequence &key (:test callable) (:test-not callable)
586 (:start index) (:from-end t) (:end sequence-end)
587 (:key callable))
589 (foldable flushable call))
591 (defknown (find-if find-if-not)
592 (callable sequence &key (:from-end t) (:start index) (:end sequence-end)
593 (:key callable))
595 (foldable flushable call))
597 (defknown position (t sequence &key (:test callable) (:test-not callable)
598 (:start index) (:from-end t) (:end sequence-end)
599 (:key callable))
600 (or index null)
601 (foldable flushable call))
603 (defknown (position-if position-if-not)
604 (callable sequence &key (:from-end t) (:start index) (:end sequence-end)
605 (:key callable))
606 (or index null)
607 (foldable flushable call))
609 (defknown count (t sequence &key (:test callable) (:test-not callable)
610 (:start index) (:from-end t) (:end sequence-end)
611 (:key callable))
612 index
613 (foldable flushable call))
615 (defknown (count-if count-if-not)
616 (callable sequence &key (:from-end t) (:start index) (:end sequence-end)
617 (:key callable))
618 index
619 (foldable flushable call))
621 (defknown (mismatch search)
622 (sequence sequence &key (:from-end t) (:test callable) (:test-not callable)
623 (:start1 index) (:end1 sequence-end)
624 (:start2 index) (:end2 sequence-end)
625 (:key callable))
626 (or index null)
627 (foldable flushable call))
629 ;;; not FLUSHABLE, since vector sort guaranteed in-place...
630 (defknown (stable-sort sort) (sequence callable &key (:key callable)) sequence
631 (call)
632 :derive-type (sequence-result-nth-arg 1)
633 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
634 (defknown sb!impl::stable-sort-list (list function function) list
635 (call important-result)
636 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
637 (defknown sb!impl::sort-vector (vector index index function (or function null))
638 * ; SORT-VECTOR works through side-effect
639 (call)
640 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
642 (defknown merge (type-specifier sequence sequence callable
643 &key (:key callable))
644 sequence
645 (call important-result)
646 :derive-type (creation-result-type-specifier-nth-arg 1)
647 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2 3))
649 ;;; not FLUSHABLE, despite what CMU CL's DEFKNOWN said..
650 (defknown read-sequence (sequence stream
651 &key
652 (:start index)
653 (:end sequence-end))
654 (index)
657 (defknown write-sequence (sequence stream
658 &key
659 (:start index)
660 (:end sequence-end))
661 sequence
663 :derive-type (sequence-result-nth-arg 1))
665 ;;;; from the "Manipulating List Structure" chapter:
666 (defknown (car cdr first rest)
667 (list)
669 (foldable flushable))
671 ;; Correct argument type restrictions for these functions are
672 ;; complicated, so we just declare them to accept LISTs and suppress
673 ;; flushing is safe code.
674 (defknown (caar cadr cdar cddr
675 caaar caadr cadar caddr cdaar cdadr cddar cdddr
676 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
677 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
678 second third fourth fifth sixth seventh eighth ninth tenth)
679 (list)
681 (foldable unsafely-flushable))
683 (defknown cons (t t) cons (movable flushable unsafe))
685 (defknown tree-equal (t t &key (:test callable) (:test-not callable)) boolean
686 (foldable flushable call))
687 (defknown endp (list) boolean (foldable flushable movable))
688 (defknown list-length (list) (or index null) (foldable unsafely-flushable))
689 (defknown nth (unsigned-byte list) t (foldable flushable))
690 (defknown nthcdr (unsigned-byte list) t (foldable unsafely-flushable))
691 (defknown last (list &optional unsigned-byte) t (foldable flushable))
692 (defknown sb!impl::last1 (list) t (foldable flushable))
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))
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))
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))
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))
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))
721 (defknown ldiff (list t) list (flushable))
722 (defknown (rplaca rplacd) (cons t) list (unsafe)
723 :destroyed-constant-args (nth-constant-args 1))
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))
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))
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))
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))
755 (defknown tailp (t list) boolean (foldable flushable))
757 (defknown adjoin (t list &key (:key callable) (:test callable)
758 (:test-not callable))
759 list (foldable flushable unsafe call))
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))
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))
772 (defknown subsetp
773 (list list &key (:key callable) (:test callable) (:test-not callable))
774 boolean
775 (foldable flushable call))
777 (defknown acons (t t t) list (movable flushable unsafe))
778 (defknown pairlis (t t &optional t) list (flushable unsafe))
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))
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))
790 ;;;; from the "Hash Tables" chapter:
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 (:weakness (member nil :key :value :key-and-value :key-or-value)))
797 hash-table
798 (flushable unsafe))
799 (defknown hash-table-p (t) boolean (movable foldable flushable))
800 (defknown gethash (t hash-table &optional t) (values t boolean)
801 (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
802 (defknown sb!impl::gethash2 (t hash-table) (values t boolean)
803 (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
804 (defknown sb!impl::gethash3 (t hash-table t) (values t boolean)
805 (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
806 (defknown %puthash (t hash-table t) t (unsafe)
807 :destroyed-constant-args (nth-constant-args 2))
808 (defknown remhash (t hash-table) boolean ()
809 :destroyed-constant-args (nth-constant-args 2))
810 (defknown maphash (callable hash-table) null (flushable call))
811 (defknown clrhash (hash-table) hash-table ()
812 :destroyed-constant-args (nth-constant-args 2))
813 (defknown hash-table-count (hash-table) index (flushable))
814 (defknown hash-table-rehash-size (hash-table) (or (integer 1) (float (1.0)))
815 (foldable flushable))
816 (defknown hash-table-rehash-threshold (hash-table) (real 0 1)
817 (foldable flushable))
818 (defknown hash-table-size (hash-table) index (flushable))
819 (defknown hash-table-test (hash-table) symbol (foldable flushable))
820 (defknown sxhash (t) (integer 0 #.sb!xc:most-positive-fixnum)
821 (#-sb-xc-host foldable flushable))
823 ;;;; from the "Arrays" chapter
825 (defknown make-array ((or index list)
826 &key
827 (:element-type type-specifier)
828 (:initial-element t)
829 (:initial-contents t)
830 (:adjustable t)
831 (:fill-pointer t)
832 (:displaced-to (or array null))
833 (:displaced-index-offset index))
834 array (flushable unsafe))
836 (defknown vector (&rest t) simple-vector (flushable unsafe))
838 (defknown aref (array &rest index) t (foldable))
839 (defknown row-major-aref (array index) t (foldable))
841 (defknown array-element-type (array)
842 type-specifier
843 (foldable flushable recursive))
844 (defknown array-rank (array) array-rank (foldable flushable))
845 (defknown array-dimension (array array-rank) index (foldable flushable))
846 (defknown array-dimensions (array) list (foldable flushable))
847 (defknown array-in-bounds-p (array &rest integer) boolean (foldable flushable))
848 (defknown array-row-major-index (array &rest index) array-total-size
849 (foldable flushable))
850 (defknown array-total-size (array) array-total-size (foldable flushable))
851 (defknown adjustable-array-p (array) boolean (movable foldable flushable))
853 (defknown svref (simple-vector index) t (foldable flushable))
854 (defknown bit ((array bit) &rest index) bit (foldable flushable))
855 (defknown sbit ((simple-array bit) &rest index) bit (foldable flushable))
857 ;;; FIXME: :DESTROYED-CONSTANT-ARGS for these is complicated.
858 (defknown (bit-and bit-ior bit-xor bit-eqv bit-nand bit-nor bit-andc1 bit-andc2
859 bit-orc1 bit-orc2)
860 ((array bit) (array bit) &optional (or (array bit) (member t nil)))
861 (array bit)
863 #|:derive-type #'result-type-last-arg|#)
865 (defknown bit-not ((array bit) &optional (or (array bit) (member t nil)))
866 (array bit)
868 #|:derive-type #'result-type-last-arg|#)
870 (defknown bit-vector-= (bit-vector bit-vector) boolean
871 (movable foldable flushable))
873 (defknown array-has-fill-pointer-p (array) boolean
874 (movable foldable flushable))
875 (defknown fill-pointer (vector) index (foldable unsafely-flushable))
876 (defknown vector-push (t vector) (or index null) ()
877 :destroyed-constant-args (nth-constant-args 2))
878 (defknown vector-push-extend (t vector &optional index) index ()
879 :destroyed-constant-args (nth-constant-args 2))
880 (defknown vector-pop (vector) t ()
881 :destroyed-constant-args (nth-constant-args 1))
883 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
884 ;;; Also, an important-result warning could be provided if the array
885 ;;; is known to be not expressly adjustable.
886 (defknown adjust-array
887 (array (or index list) &key (:element-type type-specifier)
888 (:initial-element t) (:initial-contents t)
889 (:fill-pointer t) (:displaced-to (or array null))
890 (:displaced-index-offset index))
891 array (unsafe))
892 ; :derive-type 'result-type-arg1) Not even close...
894 ;;;; from the "Strings" chapter:
896 (defknown char (string index) character (foldable flushable))
897 (defknown schar (simple-string index) character (foldable flushable))
899 (defknown (string= string-equal)
900 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
901 (:start2 index) (:end2 sequence-end))
902 boolean
903 (foldable flushable))
905 (defknown (string< string> string<= string>= string/= string-lessp
906 string-greaterp string-not-lessp string-not-greaterp
907 string-not-equal)
908 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
909 (:start2 index) (:end2 sequence-end))
910 (or index null)
911 (foldable flushable))
913 (defknown make-string (index &key (:element-type type-specifier)
914 (:initial-element character))
915 simple-string (flushable))
917 (defknown (string-trim string-left-trim string-right-trim)
918 (sequence string-designator) simple-string (flushable))
920 (defknown (string-upcase string-downcase string-capitalize)
921 (string-designator &key (:start index) (:end sequence-end))
922 simple-string (flushable))
924 (defknown (nstring-upcase nstring-downcase nstring-capitalize)
925 (string &key (:start index) (:end sequence-end))
926 string ()
927 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
929 (defknown string (string-designator) string
930 (flushable explicit-check))
932 ;;;; internal non-keyword versions of string predicates:
934 (defknown (string<* string>* string<=* string>=* string/=*)
935 (string-designator string-designator index sequence-end index sequence-end)
936 (or index null)
937 (foldable flushable))
939 (defknown string=*
940 (string-designator string-designator index sequence-end index sequence-end)
941 boolean
942 (foldable flushable))
944 ;;;; from the "Eval" chapter:
946 (defknown eval (t) * (recursive))
947 (defknown constantp (t &optional lexenv-designator) boolean
948 (foldable flushable))
950 ;;;; from the "Streams" chapter:
952 (defknown make-synonym-stream (symbol) stream (flushable))
953 (defknown make-broadcast-stream (&rest stream) stream (unsafely-flushable))
954 (defknown make-concatenated-stream (&rest stream) stream (unsafely-flushable))
955 (defknown make-two-way-stream (stream stream) stream (unsafely-flushable))
956 (defknown make-echo-stream (stream stream) stream (flushable))
957 (defknown make-string-input-stream (string &optional index sequence-end)
958 stream
959 (flushable unsafe))
960 (defknown make-string-output-stream
961 (&key (:element-type type-specifier))
962 stream
963 (flushable))
964 (defknown get-output-stream-string (stream) simple-string ())
965 (defknown streamp (t) boolean (movable foldable flushable))
966 (defknown stream-element-type (stream) type-specifier
967 (movable foldable flushable))
968 (defknown (output-stream-p input-stream-p) (stream) boolean
969 (movable foldable flushable))
970 (defknown close (stream &key (:abort t)) (eql t) ())
972 ;;;; from the "Input/Output" chapter:
974 ;;; (The I/O functions are given effects ANY under the theory that
975 ;;; code motion over I/O operations is particularly confusing and not
976 ;;; very important for efficiency.)
978 (defknown copy-readtable (&optional (or readtable null) (or readtable null))
979 readtable
981 (defknown readtablep (t) boolean (movable foldable flushable))
983 (defknown set-syntax-from-char
984 (character character &optional readtable (or readtable null)) (eql t)
987 (defknown set-macro-character (character callable &optional t readtable)
988 (eql t)
989 (unsafe))
990 (defknown get-macro-character (character &optional (or readtable null))
991 (values callable boolean) (flushable))
993 (defknown make-dispatch-macro-character (character &optional t readtable)
994 (eql t) ())
995 (defknown set-dispatch-macro-character
996 (character character callable &optional readtable) function
997 (unsafe))
998 (defknown get-dispatch-macro-character
999 (character character &optional (or readtable null)) (or callable null)
1002 (defknown copy-pprint-dispatch
1003 (&optional (or sb!pretty:pprint-dispatch-table null))
1004 sb!pretty:pprint-dispatch-table
1006 (defknown pprint-dispatch
1007 (t &optional (or sb!pretty:pprint-dispatch-table null))
1008 (values callable boolean)
1010 (defknown (pprint-fill pprint-linear)
1011 (stream-designator t &optional t t)
1012 null
1014 (defknown pprint-tabular
1015 (stream-designator t &optional t t unsigned-byte)
1016 null
1018 (defknown pprint-indent
1019 ((member :block :current) real &optional stream-designator)
1020 null
1022 (defknown pprint-newline
1023 ((member :linear :fill :miser :mandatory) &optional stream-designator)
1024 null
1026 (defknown pprint-tab
1027 ((member :line :section :line-relative :section-relative)
1028 unsigned-byte unsigned-byte &optional stream-designator)
1029 null
1031 (defknown set-pprint-dispatch
1032 (type-specifier (or null callable)
1033 &optional real sb!pretty:pprint-dispatch-table)
1034 null
1037 ;;; may return any type due to eof-value...
1038 (defknown (read read-preserving-whitespace read-char-no-hang read-char)
1039 (&optional stream-designator t t t) t (explicit-check))
1041 (defknown read-delimited-list (character &optional stream-designator t) list
1042 (explicit-check))
1043 (defknown read-line (&optional stream-designator t t t) (values t boolean)
1044 (explicit-check))
1045 (defknown unread-char (character &optional stream-designator) t
1046 (explicit-check))
1047 (defknown peek-char (&optional (or character (member nil t))
1048 stream-designator t t t)
1050 (explicit-check))
1051 (defknown listen (&optional stream-designator) boolean (flushable explicit-check))
1053 (defknown clear-input (&optional stream-designator) null (explicit-check))
1055 (defknown read-from-string
1056 (string &optional t t
1057 &key
1058 (:start index)
1059 (:end sequence-end)
1060 (:preserve-whitespace t))
1061 (values t index))
1062 (defknown parse-integer
1063 (string &key
1064 (:start index)
1065 (:end sequence-end)
1066 (:radix (integer 2 36))
1067 (:junk-allowed t))
1068 (values (or integer null ()) index))
1070 (defknown read-byte (stream &optional t t) t (explicit-check))
1072 (defknown write
1073 (t &key
1074 (:stream stream-designator)
1075 (:escape t)
1076 (:radix t)
1077 (:base (integer 2 36))
1078 (:circle t)
1079 (:pretty t)
1080 (:level (or unsigned-byte null))
1081 (:readably t)
1082 (:length (or unsigned-byte null))
1083 (:case t)
1084 (:array t)
1085 (:gensym t)
1086 (:lines (or unsigned-byte null))
1087 (:right-margin (or unsigned-byte null))
1088 (:miser-width (or unsigned-byte null))
1089 (:pprint-dispatch t))
1091 (any explicit-check)
1092 :derive-type #'result-type-first-arg)
1094 (defknown (prin1 print princ) (t &optional stream-designator)
1096 (any explicit-check)
1097 :derive-type #'result-type-first-arg)
1099 ;;; xxx-TO-STRING functions are not foldable because they depend on
1100 ;;; the dynamic environment, the state of the pretty printer dispatch
1101 ;;; table, and probably other run-time factors.
1102 (defknown write-to-string
1103 (t &key (:escape t) (:radix t) (:base (integer 2 36)) (:readably t)
1104 (:circle t) (:pretty t) (:level (or unsigned-byte null))
1105 (:length (or unsigned-byte null)) (:case t) (:array t) (:gensym t)
1106 (:lines (or unsigned-byte null)) (:right-margin (or unsigned-byte null))
1107 (:miser-width (or unsigned-byte null)) (:pprint-dispatch t))
1108 simple-string
1109 (flushable explicit-check))
1111 (defknown (prin1-to-string princ-to-string) (t) simple-string (flushable))
1113 (defknown write-char (character &optional stream-designator) character
1114 (explicit-check))
1115 (defknown (write-string write-line)
1116 (string &optional stream-designator &key (:start index) (:end sequence-end))
1117 string
1118 (explicit-check))
1120 (defknown (terpri finish-output force-output clear-output)
1121 (&optional stream-designator) null
1122 (explicit-check))
1124 (defknown fresh-line (&optional stream-designator) boolean
1125 (explicit-check))
1127 (defknown write-byte (integer stream) integer
1128 (explicit-check))
1130 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
1131 (defknown format ((or (member nil t) stream string)
1132 (or string function) &rest t)
1133 (or string null)
1134 (explicit-check))
1136 (defknown (y-or-n-p yes-or-no-p) (&optional string &rest t) boolean
1137 (explicit-check))
1139 ;;;; from the "File System Interface" chapter:
1141 ;;; (No pathname functions are FOLDABLE because they all potentially
1142 ;;; depend on *DEFAULT-PATHNAME-DEFAULTS*, e.g. to provide a default
1143 ;;; host when parsing a namestring. They are not FLUSHABLE because
1144 ;;; parsing of a PATHNAME-DESIGNATOR might signal an error.)
1146 (defknown wild-pathname-p (pathname-designator
1147 &optional
1148 (member nil :host :device
1149 :directory :name
1150 :type :version))
1151 generalized-boolean
1153 (defknown pathname-match-p (pathname-designator pathname-designator)
1154 generalized-boolean
1156 (defknown translate-pathname (pathname-designator
1157 pathname-designator
1158 pathname-designator &key)
1159 pathname
1162 (defknown logical-pathname (pathname-designator) logical-pathname ())
1163 (defknown translate-logical-pathname (pathname-designator &key) pathname
1164 (recursive))
1165 (defknown load-logical-pathname-translations (string) t ())
1166 (defknown logical-pathname-translations (logical-host-designator) list ())
1168 (defknown pathname (pathname-designator) pathname ())
1169 (defknown truename (pathname-designator) pathname ())
1171 (defknown parse-namestring
1172 (pathname-designator &optional
1173 (or list host string (member :unspecific))
1174 pathname-designator
1175 &key
1176 (:start index)
1177 (:end sequence-end)
1178 (:junk-allowed t))
1179 (values (or pathname null) sequence-end)
1182 (defknown merge-pathnames
1183 (pathname-designator &optional pathname-designator pathname-version)
1184 pathname
1187 (defknown make-pathname
1188 (&key (:defaults pathname-designator)
1189 (:host (or string pathname-host))
1190 (:device (or string pathname-device))
1191 (:directory (or pathname-directory string (member :wild)))
1192 (:name (or pathname-name string (member :wild)))
1193 (:type (or pathname-type string (member :wild)))
1194 (:version pathname-version) (:case (member :local :common)))
1195 pathname (unsafely-flushable))
1197 (defknown pathnamep (t) boolean (movable flushable))
1199 (defknown pathname-host (pathname-designator
1200 &key (:case (member :local :common)))
1201 pathname-host (flushable))
1202 (defknown pathname-device (pathname-designator
1203 &key (:case (member :local :common)))
1204 pathname-device (flushable))
1205 (defknown pathname-directory (pathname-designator
1206 &key (:case (member :local :common)))
1207 pathname-directory (flushable))
1208 (defknown pathname-name (pathname-designator
1209 &key (:case (member :local :common)))
1210 pathname-name (flushable))
1211 (defknown pathname-type (pathname-designator
1212 &key (:case (member :local :common)))
1213 pathname-type (flushable))
1214 (defknown pathname-version (pathname-designator)
1215 pathname-version (flushable))
1217 (defknown (namestring file-namestring directory-namestring host-namestring)
1218 (pathname-designator) (or simple-string null)
1219 (unsafely-flushable))
1221 (defknown enough-namestring (pathname-designator &optional pathname-designator)
1222 simple-string
1223 (unsafely-flushable))
1225 (defknown user-homedir-pathname (&optional t) pathname (flushable))
1227 (defknown open
1228 (pathname-designator &key
1229 (:direction (member :input :output :io :probe))
1230 (:element-type type-specifier)
1231 (:if-exists (member :error :new-version :rename
1232 :rename-and-delete :overwrite
1233 :append :supersede nil))
1234 (:if-does-not-exist (member :error :create nil))
1235 (:external-format keyword))
1236 (or stream null))
1238 (defknown rename-file (pathname-designator filename)
1239 (values pathname pathname pathname))
1240 (defknown delete-file (pathname-designator) t)
1241 (defknown probe-file (pathname-designator) (or pathname null) ())
1242 (defknown file-write-date (pathname-designator) (or unsigned-byte null)
1244 (defknown file-author (pathname-designator) (or simple-string null)
1247 (defknown file-position (stream &optional
1248 (or unsigned-byte (member :start :end)))
1249 (or unsigned-byte (member t nil)))
1250 (defknown file-length (stream) (or unsigned-byte null) (unsafely-flushable))
1252 (defknown load
1253 ((or filename stream)
1254 &key
1255 (:verbose t)
1256 (:print t)
1257 (:if-does-not-exist (member :error :create nil))
1258 (:external-format keyword))
1261 (defknown directory (pathname-designator &key)
1262 list ())
1264 ;;;; from the "Conditions" chapter:
1266 (defknown cell-error-name (cell-error) t)
1267 (defknown error (t &rest t) nil)
1268 (defknown cerror (format-control t &rest t) null)
1269 (defknown invalid-method-error (t format-control &rest t) *) ; FIXME: first arg is METHOD
1270 (defknown method-combination-error (format-control &rest t) *)
1271 (defknown signal (t &rest t) null)
1272 (defknown simple-condition-format-control (condition)
1273 format-control)
1274 (defknown simple-condition-format-arguments (condition)
1275 list)
1276 (defknown warn (t &rest t) null)
1277 (defknown invoke-debugger (condition) nil)
1278 (defknown break (&optional format-control &rest t) null)
1279 (defknown make-condition (type-specifier &rest t) condition)
1280 (defknown compute-restarts (&optional (or condition null)) list)
1281 (defknown find-restart (restart-designator &optional (or condition null))
1282 (or restart null))
1283 (defknown invoke-restart (restart-designator &rest t) *)
1284 (defknown invoke-restart-interactively (restart-designator) *)
1285 (defknown restart-name (restart) symbol)
1286 (defknown (abort muffle-warning) (&optional (or condition null)) nil)
1287 (defknown continue (&optional (or condition null)) null)
1288 (defknown (store-value use-value) (t &optional (or condition null))
1289 null)
1291 ;;; and analogous SBCL extension:
1292 (defknown bug (t &rest t) nil) ; never returns
1294 ;;;; from the "Miscellaneous" Chapter:
1296 (defknown compile ((or symbol cons) &optional (or list function null))
1297 (values (or function symbol cons) boolean boolean))
1299 (defknown compile-file
1300 (pathname-designator
1301 &key
1303 ;; ANSI options
1304 (:output-file (or pathname-designator
1305 null
1306 ;; FIXME: This last case is a non-ANSI hack.
1307 (member t)))
1308 (:verbose t)
1309 (:print t)
1310 (:external-format keyword)
1312 ;; extensions
1313 (:trace-file t)
1314 (:block-compile t))
1315 (values (or pathname null) boolean boolean))
1317 ;; FIXME: consider making (OR CALLABLE CONS) something like
1318 ;; EXTENDED-FUNCTION-DESIGNATOR
1319 (defknown disassemble ((or callable cons) &key
1320 (:stream stream) (:use-labels t))
1321 null)
1323 (defknown fdocumentation (t symbol)
1324 (or string null)
1325 (flushable))
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))
1332 (defknown dribble (&optional filename &key (:if-exists t)) (values))
1334 (defknown apropos (string-designator &optional package-designator t) (values))
1335 (defknown apropos-list (string-designator &optional package-designator t) list
1336 (flushable))
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))
1343 (defknown get-universal-time () unsigned-byte (flushable))
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))
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))
1357 (defknown (get-internal-run-time get-internal-real-time)
1358 () internal-time (flushable))
1360 (defknown sleep ((or (rational 0) (float 0.0))) null)
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))
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))
1377 (defknown identity (t) t (movable foldable flushable unsafe)
1378 :derive-type #'result-type-first-arg)
1380 (defknown constantly (t) function (movable flushable))
1381 (defknown complement (function) function (movable flushable))
1383 ;;;; miscellaneous extensions
1385 (defknown get-bytes-consed () unsigned-byte (flushable))
1386 (defknown mask-signed-field ((integer 0 *) integer) integer
1387 (movable flushable foldable))
1389 ;;; PCOUNTERs
1390 (defknown incf-pcounter (pcounter unsigned-byte) pcounter)
1391 (defknown pcounter->integer (pcounter) unsigned-byte)
1392 (defknown %incf-pcounter-or-fixnum ((or pcounter fixnum) unsigned-byte)
1393 (or pcounter fixnum))
1394 (defknown pcounter-or-fixnum->integer ((or pcounter fixnum)) unsigned-byte)
1396 ;;;; magical compiler frobs
1398 ;;; We can't fold this in general because of SATISFIES. There is a
1399 ;;; special optimizer anyway.
1400 (defknown %typep (t (or type-specifier ctype)) boolean
1401 (movable flushable explicit-check))
1402 (defknown %instance-typep (t (or type-specifier ctype)) boolean
1403 (movable flushable explicit-check))
1405 (defknown %cleanup-point () t)
1406 (defknown %special-bind (t t) t)
1407 (defknown %special-unbind (t) t)
1408 (defknown %listify-rest-args (t index) list (flushable))
1409 (defknown %more-arg-context (t t) (values t index) (flushable))
1410 #!-stack-grows-downward-not-upward
1411 (defknown %more-arg (t index) t)
1412 #!+stack-grows-downward-not-upward
1413 (defknown %more-kw-arg (t index) (values t t))
1414 (defknown %more-arg-values (t index index) * (flushable))
1415 (defknown %verify-arg-count (index index) (values))
1416 (defknown %arg-count-error (t) nil)
1417 (defknown %unknown-values () *)
1418 (defknown %catch (t t) t)
1419 (defknown %unwind-protect (t t) t)
1420 (defknown (%catch-breakup %unwind-protect-breakup) () t)
1421 (defknown %lexical-exit-breakup (t) t)
1422 (defknown %continue-unwind (t t t) nil)
1423 (defknown %throw (t &rest t) nil) ; This is MV-called.
1424 (defknown %nlx-entry (t) *)
1425 (defknown %%primitive (t t &rest t) *)
1426 (defknown %pop-values (t) t)
1427 (defknown %nip-values (t t &rest t) (values))
1428 (defknown %allocate-closures (t) *)
1429 (defknown %type-check-error (t t) nil)
1431 ;; FIXME: This function does not return, but due to the implementation
1432 ;; of FILTER-LVAR we cannot write it here.
1433 (defknown %compile-time-type-error (t t t) *)
1435 (defknown %odd-key-args-error () nil)
1436 (defknown %unknown-key-arg-error (t) nil)
1437 (defknown (%ldb %mask-field) (bit-index bit-index integer) unsigned-byte
1438 (movable foldable flushable explicit-check))
1439 (defknown (%dpb %deposit-field) (integer bit-index bit-index integer) integer
1440 (movable foldable flushable explicit-check))
1441 (defknown %negate (number) number (movable foldable flushable explicit-check))
1442 (defknown %check-bound (array index fixnum) index (movable foldable flushable))
1443 (defknown data-vector-ref (simple-array index) t
1444 (foldable explicit-check always-translatable))
1445 (defknown data-vector-set (array index t) t
1446 (unsafe explicit-check always-translatable))
1447 (defknown hairy-data-vector-ref (array index) t
1448 (foldable explicit-check))
1449 (defknown hairy-data-vector-set (array index t) t (unsafe explicit-check))
1450 (defknown %caller-frame-and-pc () (values t t) (flushable))
1451 (defknown %with-array-data (array index (or index null))
1452 (values (simple-array * (*)) index index index)
1453 (foldable flushable))
1454 (defknown %set-symbol-package (symbol t) t (unsafe))
1455 (defknown %coerce-name-to-fun ((or symbol cons)) function (flushable))
1456 (defknown %coerce-callable-to-fun (callable) function (flushable))
1457 (defknown failed-%with-array-data (t t t) nil)
1458 (defknown %find-position
1459 (t sequence t index sequence-end function function)
1460 (values t (or index null))
1461 (flushable call))
1462 (defknown (%find-position-if %find-position-if-not)
1463 (function sequence t index sequence-end function)
1464 (values t (or index null))
1465 (call))
1466 (defknown effective-find-position-test (callable callable)
1467 function
1468 (flushable foldable))
1469 (defknown effective-find-position-key (callable)
1470 function
1471 (flushable foldable))
1473 (defknown %check-vector-sequence-bounds (vector index sequence-end)
1474 index
1475 (unwind))
1476 ;;; FIXME: including this information here is probably necessary to
1477 ;;; get efficient compilation of the inline expansion of
1478 ;;; %FIND-POSITION-IF, so it should maybe be in a more
1479 ;;; compiler-friendly package (SB-INT?)
1480 (defknown sb!impl::signal-bounding-indices-bad-error
1481 (sequence index sequence-end)
1482 nil) ; never returns
1485 (defknown arg-count-error (t t t t t t) nil (unsafe))
1487 ;;;; SETF inverses
1489 (defknown %aset (array &rest t) t (unsafe)
1490 :destroyed-constant-args (nth-constant-args 1))
1491 (defknown %set-row-major-aref (array index t) t (unsafe)
1492 :destroyed-constant-args (nth-constant-args 1))
1493 (defknown (%rplaca %rplacd) (cons t) t (unsafe)
1494 :destroyed-constant-args (nth-constant-args 1))
1495 (defknown %put (symbol t t) t (unsafe))
1496 (defknown %setelt (sequence index t) t (unsafe)
1497 :destroyed-constant-args (nth-constant-args 1))
1498 (defknown %svset (simple-vector index t) t (unsafe)
1499 :destroyed-constant-args (nth-constant-args 1))
1500 (defknown %bitset ((array bit) &rest index) bit (unsafe)
1501 :destroyed-constant-args (nth-constant-args 1))
1502 (defknown %sbitset ((simple-array bit) &rest index) bit (unsafe)
1503 :destroyed-constant-args (nth-constant-args 1))
1504 (defknown %charset (string index character) character (unsafe)
1505 :destroyed-constant-args (nth-constant-args 1))
1506 (defknown %scharset (simple-string index character) character (unsafe)
1507 :destroyed-constant-args (nth-constant-args 1))
1508 (defknown %set-symbol-value (symbol t) t (unsafe))
1509 (defknown (setf symbol-function) (function symbol) function (unsafe))
1510 (defknown %set-symbol-plist (symbol t) t (unsafe))
1511 (defknown (setf fdocumentation) ((or string null) t symbol)
1512 (or string null)
1514 (defknown %setnth (unsigned-byte list t) t (unsafe)
1515 :destroyed-constant-args (nth-constant-args 2))
1516 (defknown %set-fill-pointer (vector index) index (unsafe)
1517 :destroyed-constant-args (nth-constant-args 1))
1519 ;;;; ALIEN and call-out-to-C stuff
1521 ;;; 'unsafe' attribute because we store the arg on the stack, which is in
1522 ;;; some sense 'passing it upwards'
1523 (defknown sb!vm::push-word-on-c-stack (system-area-pointer) (values) (unsafe))
1524 (defknown sb!vm::pop-words-from-c-stack (index) (values) ())
1526 #!+linkage-table
1527 (defknown foreign-symbol-dataref-sap (simple-string)
1528 system-area-pointer
1529 (movable flushable))
1531 (defknown foreign-symbol-sap (simple-string &optional boolean)
1532 system-area-pointer
1533 (movable flushable))
1535 (defknown foreign-symbol-address (simple-string &optional boolean)
1536 (values integer boolean)
1537 (movable flushable))
1539 ;;;; miscellaneous internal utilities
1541 (defknown %fun-name (function) t (flushable))
1542 (defknown (setf %fun-name) (t function) t (unsafe))
1544 (defknown policy-quality (policy symbol) policy-quality
1545 (flushable))
1547 (defknown (compiler-abort compiler-error) (string &rest t) nil ())
1548 (defknown (compiler-warn compiler-style-warn) (string &rest t) (values) ())
1549 (defknown (compiler-notify maybe-compiler-notify) ((or string symbol) &rest t)
1550 (values)
1552 (defknown style-warn (string &rest t) null ())