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
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.
16 ;;;; information for known functions:
18 (defknown coerce (t type-specifier) t
20 ;; This is not FLUSHABLE because it's defined to signal errors.
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
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
52 ;; (SUBTYPEP 'INTEGER 'FOO) => T, T
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.)
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
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?
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))
81 (defknown fixnum-mod-p (t fixnum) boolean
82 (movable foldable flushable always-translatable))
87 (sb!xc:deftype name-for-class () t)
88 (defknown classoid-name (classoid) symbol (flushable))
89 (defknown find-classoid (name-for-class &optional t)
90 (or classoid null) ())
91 (defknown classoid-of (t) classoid (flushable))
92 (defknown layout-of (t) layout (flushable))
93 (defknown copy-structure (structure-object) structure-object
94 (flushable)) ;; FIXME: can derive the type based on the structure
96 ;;;; from the "Control Structure" chapter:
98 ;;; This is not FLUSHABLE, since it's required to signal an error if
100 (defknown (symbol-value) (symbol) t ())
101 ;;; From CLHS, "If the symbol is globally defined as a macro or a
102 ;;; special operator, an object of implementation-dependent nature and
103 ;;; identity is returned. If the symbol is not globally defined as
104 ;;; either a macro or a special operator, and if the symbol is fbound,
105 ;;; a function object is returned". Our objects of
106 ;;; implementation-dependent nature happen to be functions.
107 (defknown (symbol-function) (symbol) function ())
109 (defknown boundp (symbol) boolean (flushable))
110 (defknown fboundp ((or symbol cons)) boolean (unsafely-flushable explicit-check))
111 (defknown special-operator-p (symbol) t
112 ;; The set of special operators never changes.
113 (movable foldable flushable))
114 (defknown set (symbol t) t ()
115 :derive-type #'result-type-last-arg)
116 (defknown fdefinition ((or symbol cons)) function (explicit-check))
117 (defknown %set-fdefinition ((or symbol cons) function) function
119 :derive-type #'result-type-last-arg)
120 (defknown makunbound (symbol) symbol
122 :derive-type #'result-type-first-arg)
123 (defknown fmakunbound ((or symbol cons)) (or symbol cons)
125 :derive-type #'result-type-first-arg)
126 (defknown apply (callable t &rest t) *) ; ### Last arg must be List...
127 (defknown funcall (callable &rest t) *)
129 (defknown (mapcar maplist) (callable list &rest list) list
132 ;;; According to CLHS the result must be a LIST, but we do not check
134 (defknown (mapcan mapcon) (callable list &rest list) t
137 (defknown (mapc mapl) (callable list &rest list) list (foldable call))
139 ;;; We let VALUES-LIST be foldable, since constant-folding will turn
140 ;;; it into VALUES. VALUES is not foldable, since MV constants are
141 ;;; represented by a call to VALUES.
142 (defknown values (&rest t) * (movable flushable))
143 (defknown values-list (list) * (movable foldable unsafely-flushable))
145 ;;;; from the "Macros" chapter:
147 (defknown macro-function (symbol &optional lexenv-designator)
150 (defknown (macroexpand macroexpand-1 %macroexpand %macroexpand-1)
151 (t &optional lexenv-designator)
152 (values form &optional boolean))
154 (defknown compiler-macro-function (t &optional lexenv-designator)
158 ;;;; from the "Declarations" chapter:
160 (defknown proclaim (list) (values) (recursive))
162 ;;;; from the "Symbols" chapter:
164 (defknown get (symbol t &optional t) t (flushable))
165 (defknown sb!impl::get3 (symbol t t) t (flushable))
166 (defknown remprop (symbol t) t)
167 (defknown symbol-plist (symbol) list (flushable))
168 (defknown getf (list t &optional t) t (foldable flushable))
169 (defknown get-properties (list list) (values t t list) (foldable flushable))
170 (defknown symbol-name (symbol) simple-string (movable foldable flushable))
171 (defknown make-symbol (string) symbol (flushable))
172 (defknown %make-symbol (simple-string) symbol (flushable))
173 (defknown copy-symbol (symbol &optional t) symbol (flushable))
174 (defknown gensym (&optional (or string unsigned-byte)) symbol ())
175 (defknown symbol-package (symbol) (or sb!xc:package null) (flushable))
176 (defknown keywordp (t) boolean (flushable)) ; If someone uninterns it...
178 ;;;; from the "Packages" chapter:
180 (defknown gentemp (&optional string package-designator) symbol)
182 (defknown make-package (string-designator &key
186 (:internal-symbols index)
187 (:external-symbols index))
189 (defknown find-package (package-designator) (or sb!xc:package null)
191 (defknown package-name (package-designator) (or simple-string null)
192 (unsafely-flushable))
193 (defknown package-nicknames (package-designator) list (unsafely-flushable))
194 (defknown rename-package (package-designator package-designator &optional list)
196 (defknown package-use-list (package-designator) list (unsafely-flushable))
197 (defknown package-used-by-list (package-designator) list (unsafely-flushable))
198 (defknown package-shadowing-symbols (package-designator) list (unsafely-flushable))
199 (defknown list-all-packages () list (flushable))
200 (defknown intern (string &optional package-designator)
201 (values symbol (member :internal :external :inherited nil))
203 (defknown find-symbol (string &optional package-designator)
204 (values symbol (member :internal :external :inherited nil))
206 (defknown (export import) (symbols-designator &optional package-designator)
208 (defknown unintern (symbol &optional package-designator) boolean)
209 (defknown unexport (symbols-designator &optional package-designator) (eql t))
210 (defknown shadowing-import (symbols-designator &optional package-designator)
212 (defknown shadow ((or symbol character string list) &optional package-designator)
214 (defknown (use-package unuse-package)
215 ((or list package-designator) &optional package-designator) (eql t))
216 (defknown find-all-symbols (string-designator) list (flushable))
218 ;;;; from the "Numbers" chapter:
220 (defknown zerop (number) boolean (movable foldable flushable explicit-check))
221 (defknown (plusp minusp) (real) boolean
222 (movable foldable flushable explicit-check))
223 (defknown (oddp evenp) (integer) boolean
224 (movable foldable flushable explicit-check))
225 (defknown (= /=) (number &rest number) boolean
226 (movable foldable flushable explicit-check))
227 (defknown (< > <= >=) (real &rest real) boolean
228 (movable foldable flushable explicit-check))
229 (defknown (max min) (real &rest real) real
230 (movable foldable flushable explicit-check))
232 (defknown + (&rest number) number
233 (movable foldable flushable explicit-check))
234 (defknown - (number &rest number) number
235 (movable foldable flushable explicit-check))
236 (defknown * (&rest number) number
237 (movable foldable flushable explicit-check))
238 (defknown / (number &rest number) number
239 (movable foldable unsafely-flushable explicit-check))
240 (defknown (1+ 1-) (number) number
241 (movable foldable flushable explicit-check))
243 (defknown conjugate (number) number
244 (movable foldable flushable explicit-check))
246 (defknown gcd (&rest integer) unsigned-byte
247 (movable foldable flushable explicit-check)
248 #|:derive-type 'boolean-result-type|#)
249 (defknown lcm (&rest integer) unsigned-byte
250 (movable foldable flushable explicit-check))
252 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
253 (defknown exp (number) irrational
254 (movable foldable flushable explicit-check recursive)
255 :derive-type #'result-type-float-contagion)
257 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
258 (defknown exp (number) irrational
259 (movable foldable flushable explicit-check recursive))
261 (defknown expt (number number) number
262 (movable foldable flushable explicit-check recursive))
263 (defknown log (number &optional real) irrational
264 (movable foldable flushable explicit-check recursive))
265 (defknown sqrt (number) irrational
266 (movable foldable flushable explicit-check))
267 (defknown isqrt (unsigned-byte) unsigned-byte
268 (movable foldable flushable explicit-check recursive))
270 (defknown (abs phase signum) (number) number
271 (movable foldable flushable explicit-check))
272 (defknown cis (real) (complex float)
273 (movable foldable flushable explicit-check))
275 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
277 (defknown (sin cos) (number)
278 (or (float -1.0 1.0) (complex float))
279 (movable foldable flushable explicit-check recursive)
280 :derive-type #'result-type-float-contagion)
283 (number &optional real) irrational
284 (movable foldable unsafely-flushable explicit-check recursive)
285 :derive-type #'result-type-float-contagion)
287 (defknown (tan sinh cosh tanh asinh)
288 (number) irrational (movable foldable flushable explicit-check recursive)
289 :derive-type #'result-type-float-contagion)
292 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
294 (defknown (sin cos) (number)
295 (or (float -1.0 1.0) (complex float))
296 (movable foldable flushable explicit-check recursive))
299 (number &optional real) irrational
300 (movable foldable unsafely-flushable explicit-check recursive))
302 (defknown (tan sinh cosh tanh asinh)
303 (number) irrational (movable foldable flushable explicit-check recursive))
306 (defknown (asin acos acosh atanh)
308 (movable foldable flushable explicit-check recursive))
310 (defknown float (real &optional float) float
311 (movable foldable flushable explicit-check))
313 (defknown (rational) (real) rational
314 (movable foldable flushable explicit-check))
316 (defknown (rationalize) (real) rational
317 (movable foldable flushable explicit-check recursive))
319 (defknown (numerator denominator) (rational) integer
320 (movable foldable flushable))
322 (defknown (floor ceiling round)
323 (real &optional real) (values integer real)
324 (movable foldable flushable explicit-check))
327 (real &optional real) (values integer real)
328 (movable foldable flushable explicit-check recursive))
330 (defknown %multiply-high (word word) word
331 (movable foldable flushable))
333 (defknown (%floor %ceiling)
334 (real real) (values integer real)
335 (movable foldable flushable explicit-check))
337 (defknown (mod rem) (real real) real
338 (movable foldable flushable explicit-check))
340 (defknown (ffloor fceiling fround ftruncate)
341 (real &optional real) (values float real)
342 (movable foldable flushable explicit-check))
344 (defknown decode-float (float) (values float float-exponent float)
345 (movable foldable unsafely-flushable explicit-check))
346 (defknown scale-float (float integer) float
347 (movable foldable unsafely-flushable explicit-check))
348 (defknown float-radix (float) float-radix
349 (movable foldable unsafely-flushable))
350 (defknown float-sign (float &optional float) float
351 (movable foldable unsafely-flushable explicit-check))
352 (defknown (float-digits float-precision) (float) float-digits
353 (movable foldable unsafely-flushable explicit-check))
354 (defknown integer-decode-float (float)
355 (values integer float-int-exponent (member -1 1))
356 (movable foldable unsafely-flushable explicit-check))
358 (defknown complex (real &optional real) number
359 (movable foldable flushable explicit-check))
361 (defknown (realpart imagpart) (number) real (movable foldable flushable))
363 (defknown (logior logxor logand logeqv) (&rest integer) integer
364 (movable foldable flushable explicit-check))
366 (defknown (lognand lognor logandc1 logandc2 logorc1 logorc2)
367 (integer integer) integer
368 (movable foldable flushable explicit-check))
370 (defknown boole (boole-code integer integer) integer
371 (movable foldable flushable))
373 (defknown lognot (integer) integer (movable foldable flushable explicit-check))
374 (defknown logtest (integer integer) boolean (movable foldable flushable))
375 (defknown logbitp (unsigned-byte integer) boolean (movable foldable flushable))
376 (defknown ash (integer integer) integer
377 (movable foldable flushable explicit-check))
379 (defknown %ash/right ((or word sb!vm:signed-word) (mod #.sb!vm:n-word-bits))
380 (or word sb!vm:signed-word)
381 (movable foldable flushable always-translatable))
382 (defknown (logcount integer-length) (integer) bit-index
383 (movable foldable flushable explicit-check))
384 ;;; FIXME: According to the ANSI spec, it's legal to use any
385 ;;; nonnegative indices for BYTE arguments, not just BIT-INDEX. It's
386 ;;; hard to come up with useful ways to do this, but it is possible to
387 ;;; come up with *legal* ways to do this, so it would be nice
388 ;;; to fix this so we comply with the spec.
389 (defknown byte (bit-index bit-index) byte-specifier
390 (movable foldable flushable))
391 (defknown (byte-size byte-position) (byte-specifier) bit-index
392 (movable foldable flushable))
393 (defknown ldb (byte-specifier integer) integer (movable foldable flushable))
394 (defknown ldb-test (byte-specifier integer) boolean
395 (movable foldable flushable))
396 (defknown mask-field (byte-specifier integer) integer
397 (movable foldable flushable))
398 (defknown dpb (integer byte-specifier integer) integer
399 (movable foldable flushable))
400 (defknown deposit-field (integer byte-specifier integer) integer
401 (movable foldable flushable))
402 (defknown random ((or (float (0.0)) (integer 1)) &optional random-state)
403 (or (float 0.0) (integer 0))
405 (defknown make-random-state (&optional
406 (or (member nil t) random-state unsigned-byte
407 (simple-array (unsigned-byte 8) (*))
408 (simple-array (unsigned-byte 32) (*))))
409 random-state (flushable))
410 (defknown random-state-p (t) boolean (movable foldable flushable))
412 ;;;; from the "Characters" chapter:
413 (defknown (standard-char-p graphic-char-p alpha-char-p
414 upper-case-p lower-case-p both-case-p alphanumericp)
415 (character) boolean (movable foldable flushable))
417 (defknown digit-char-p (character &optional (integer 2 36))
418 (or (integer 0 35) null) (movable foldable flushable))
420 (defknown (char= char/= char< char> char<= char>= char-equal char-not-equal
421 char-lessp char-greaterp char-not-greaterp char-not-lessp)
422 (character &rest character) boolean (movable foldable flushable))
424 (defknown (two-arg-char-equal
425 two-arg-char-not-equal
427 two-arg-char-not-lessp
428 two-arg-char-greaterp
429 two-arg-char-not-greaterp)
430 (character character) boolean (movable foldable flushable))
432 (defknown char-equal-constant (character character character)
434 (movable foldable flushable explicit-check))
436 (defknown character (t) character (movable foldable unsafely-flushable))
437 (defknown char-code (character) char-code (movable foldable flushable))
438 (defknown (char-upcase char-downcase) (character) character
439 (movable foldable flushable))
440 (defknown digit-char (unsigned-byte &optional (integer 2 36))
441 (or character null) (movable foldable flushable))
442 (defknown char-int (character) char-code (movable foldable flushable))
443 (defknown char-name (character) (or simple-string null)
444 (movable foldable flushable))
445 (defknown name-char (string-designator) (or character null)
446 (movable foldable flushable))
447 (defknown code-char (char-code) character
448 ;; By suppressing constant folding on CODE-CHAR when the
449 ;; cross-compiler is running in the cross-compilation host vanilla
450 ;; ANSI Common Lisp, we can use CODE-CHAR expressions to delay until
451 ;; target Lisp run time the generation of CHARACTERs which aren't
452 ;; STANDARD-CHARACTERs. That way, we don't need to rely on the host
453 ;; Common Lisp being able to handle any characters other than those
454 ;; guaranteed by the ANSI spec.
455 (movable #-sb-xc-host foldable flushable))
457 ;;;; from the "Sequences" chapter:
459 (defknown elt (sequence index) t (foldable unsafely-flushable))
461 (defknown subseq (sequence index &optional sequence-end) consed-sequence
463 :derive-type (sequence-result-nth-arg 1))
465 (defknown copy-seq (sequence) consed-sequence (flushable)
466 :derive-type (sequence-result-nth-arg 1))
468 (defknown length (sequence) index (foldable flushable dx-safe))
470 (defknown reverse (sequence) consed-sequence (flushable)
471 :derive-type (sequence-result-nth-arg 1))
473 (defknown nreverse (sequence) sequence (important-result)
474 :derive-type #'result-type-first-arg
475 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
477 (defknown make-sequence (type-specifier index
479 (:initial-element t))
482 :derive-type (creation-result-type-specifier-nth-arg 1))
484 (defknown concatenate (type-specifier &rest sequence) consed-sequence
486 :derive-type (creation-result-type-specifier-nth-arg 1))
488 (defknown %concatenate-to-string (&rest sequence) simple-string
489 (explicit-check flushable))
490 (defknown %concatenate-to-base-string (&rest sequence) simple-base-string
491 (explicit-check flushable))
493 (defknown (map %map) (type-specifier callable sequence &rest sequence)
496 ; :DERIVE-TYPE 'TYPE-SPEC-ARG1 ? Nope... (MAP NIL ...) returns NULL, not NIL.
498 (defknown %map-to-list-arity-1 (callable sequence) list (flushable call))
499 (defknown %map-to-simple-vector-arity-1 (callable sequence) simple-vector
502 (defknown map-into (sequence callable &rest sequence)
505 :derive-type #'result-type-first-arg
506 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
508 ;;; returns the result from the predicate...
509 (defknown some (callable sequence &rest sequence) t
510 (foldable unsafely-flushable call))
512 (defknown (every notany notevery) (callable sequence &rest sequence) boolean
513 (foldable unsafely-flushable call))
515 (defknown reduce (callable sequence &rest t &key (:from-end t) (:start index)
516 (:end sequence-end) (:initial-value t) (:key callable))
518 (foldable flushable call))
520 (defknown fill (sequence t &rest t &key
521 (:start index) (:end sequence-end)) sequence
523 :derive-type #'result-type-first-arg
524 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
527 (defknown replace (sequence sequence &rest t &key (:start1 index)
528 (:end1 sequence-end) (:start2 index) (:end2 sequence-end))
530 :derive-type #'result-type-first-arg
531 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
535 (t sequence &rest t &key (:from-end t) (:test callable)
536 (:test-not callable) (:start index) (:end sequence-end)
537 (:count sequence-count) (:key callable))
540 :derive-type (sequence-result-nth-arg 2))
543 (t t sequence &rest t &key (:from-end t) (:test callable)
544 (:test-not callable) (:start index) (:end sequence-end)
545 (:count sequence-count) (:key callable))
548 :derive-type (sequence-result-nth-arg 3))
550 (defknown (remove-if remove-if-not)
551 (callable sequence &rest t &key (:from-end t) (:start index)
552 (:end sequence-end) (:count sequence-count) (:key callable))
555 :derive-type (sequence-result-nth-arg 2))
557 (defknown (substitute-if substitute-if-not)
558 (t callable sequence &rest t &key (:from-end t) (:start index)
559 (:end sequence-end) (:count sequence-count) (:key callable))
562 :derive-type (sequence-result-nth-arg 3))
565 (t sequence &rest t &key (:from-end t) (:test callable)
566 (:test-not callable) (:start index) (:end sequence-end)
567 (:count sequence-count) (:key callable))
569 (flushable call important-result)
570 :derive-type (sequence-result-nth-arg 2)
571 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
573 (defknown nsubstitute
574 (t t sequence &rest t &key (:from-end t) (:test callable)
575 (:test-not callable) (:start index) (:end sequence-end)
576 (:count sequence-count) (:key callable))
579 :derive-type (sequence-result-nth-arg 3)
580 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
582 (defknown (delete-if delete-if-not)
583 (callable sequence &rest t &key (:from-end t) (:start index)
584 (:end sequence-end) (:count sequence-count) (:key callable))
586 (flushable call important-result)
587 :derive-type (sequence-result-nth-arg 2)
588 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
590 (defknown (nsubstitute-if nsubstitute-if-not)
591 (t callable sequence &rest t &key (:from-end t) (:start index)
592 (:end sequence-end) (:count sequence-count) (:key callable))
595 :derive-type (sequence-result-nth-arg 3)
596 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
598 (defknown remove-duplicates
599 (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
600 (:from-end t) (:end sequence-end) (:key callable))
602 (unsafely-flushable call)
603 :derive-type (sequence-result-nth-arg 1))
605 (defknown delete-duplicates
606 (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
607 (:from-end t) (:end sequence-end) (:key callable))
609 (unsafely-flushable call important-result)
610 :derive-type (sequence-result-nth-arg 1)
611 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
613 (defknown find (t sequence &rest t &key (:test callable)
614 (:test-not callable) (:start index) (:from-end t)
615 (:end sequence-end) (:key callable))
617 (foldable flushable call))
619 (defknown (find-if find-if-not)
620 (callable sequence &rest t &key (:from-end t) (:start index)
621 (:end sequence-end) (:key callable))
623 (foldable flushable call))
625 (defknown position (t sequence &rest t &key (:test callable)
626 (:test-not callable) (:start index) (:from-end t)
627 (:end sequence-end) (:key callable))
629 (foldable flushable call))
631 (defknown (position-if position-if-not)
632 (callable sequence &rest t &key (:from-end t) (:start index)
633 (:end sequence-end) (:key callable))
635 (foldable flushable call))
637 (defknown count (t sequence &rest t &key
638 (:test callable) (:test-not callable) (:start index)
639 (:from-end t) (:end sequence-end) (:key callable))
641 (foldable flushable call))
643 (defknown (count-if count-if-not)
644 (callable sequence &rest t &key
645 (:from-end t) (:start index) (:end sequence-end) (:key callable))
647 (foldable flushable call))
649 (defknown (mismatch search)
650 (sequence sequence &rest t &key (:from-end t) (:test callable)
651 (:test-not callable) (:start1 index) (:end1 sequence-end)
652 (:start2 index) (:end2 sequence-end) (:key callable))
654 (foldable flushable call))
656 ;;; not FLUSHABLE, since vector sort guaranteed in-place...
657 (defknown (stable-sort sort) (sequence callable &rest t &key (:key callable))
660 :derive-type (sequence-result-nth-arg 1)
661 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
662 (defknown sb!impl::stable-sort-list (list function function) list
663 (call important-result)
664 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
665 (defknown sb!impl::sort-vector (vector index index function (or function null))
666 * ; SORT-VECTOR works through side-effect
668 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
670 (defknown merge (type-specifier sequence sequence callable
671 &key (:key callable))
673 (call important-result)
674 :derive-type (creation-result-type-specifier-nth-arg 1)
675 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2 3))
677 (defknown read-sequence (sequence stream
684 (defknown write-sequence (sequence stream
690 :derive-type #'result-type-first-arg)
692 ;;;; from the "Manipulating List Structure" chapter:
693 (defknown (car cdr first rest)
696 (foldable flushable))
698 ;; Correct argument type restrictions for these functions are
699 ;; complicated, so we just declare them to accept LISTs and suppress
700 ;; flushing is safe code.
701 (defknown (caar cadr cdar cddr
702 caaar caadr cadar caddr cdaar cdadr cddar cdddr
703 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
704 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
705 second third fourth fifth sixth seventh eighth ninth tenth)
708 (foldable unsafely-flushable))
710 (defknown cons (t t) cons (movable flushable))
712 (defknown tree-equal (t t &key (:test callable) (:test-not callable)) boolean
713 (foldable flushable call))
714 (defknown endp (list) boolean (foldable flushable movable))
715 (defknown list-length (list) (or index null) (foldable unsafely-flushable))
716 (defknown nth (unsigned-byte list) t (foldable flushable))
717 (defknown nthcdr (unsigned-byte list) t (foldable unsafely-flushable))
719 (defknown last (list &optional unsigned-byte) t (foldable flushable))
720 (defknown %last0 (list) t (foldable flushable))
721 (defknown %last1 (list) t (foldable flushable))
722 (defknown %lastn/fixnum (list (and unsigned-byte fixnum)) t (foldable flushable))
723 (defknown %lastn/bignum (list (and unsigned-byte bignum)) t (foldable flushable))
725 (defknown list (&rest t) list (movable flushable))
726 (defknown list* (t &rest t) t (movable flushable))
727 (defknown make-list (index &key (:initial-element t)) list
730 (defknown sb!impl::backq-list (&rest t) list (movable flushable))
731 (defknown sb!impl::backq-list* (t &rest t) t (movable flushable))
732 (defknown sb!impl::backq-append (&rest t) t (flushable))
733 (defknown sb!impl::backq-nconc (&rest t) t ()
734 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
735 (defknown sb!impl::backq-cons (t t) cons (foldable movable flushable))
736 (defknown sb!impl::backq-vector (list) simple-vector
737 (foldable movable flushable))
739 ;;; All but last must be of type LIST, but there seems to be no way to
740 ;;; express that in this syntax.
741 (defknown append (&rest t) t (flushable))
742 (defknown sb!impl::append2 (list t) t (flushable))
744 (defknown copy-list (list) list (flushable))
745 (defknown copy-alist (list) list (flushable))
746 (defknown copy-tree (t) t (flushable recursive))
747 (defknown revappend (list t) t (flushable))
749 ;;; All but last must be of type LIST, but there seems to be no way to
750 ;;; express that in this syntax. The result must be LIST, but we do
751 ;;; not check it now :-).
752 (defknown nconc (&rest t) t ()
753 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
754 (defknown sb!impl::nconc2 (list t) t ()
755 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
757 (defknown nreconc (list t) t (important-result)
758 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
759 (defknown butlast (list &optional unsigned-byte) list (flushable))
760 (defknown nbutlast (list &optional unsigned-byte) list ()
761 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
763 (defknown ldiff (list t) list (flushable))
764 (defknown (rplaca rplacd) (cons t) cons ()
765 :destroyed-constant-args (nth-constant-args 1))
767 (defknown subst (t t t &key (:key callable) (:test callable)
768 (:test-not callable))
770 (defknown nsubst (t t t &key (:key callable) (:test callable)
771 (:test-not callable))
773 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
775 (defknown (subst-if subst-if-not)
776 (t callable t &key (:key callable))
778 (defknown (nsubst-if nsubst-if-not)
779 (t callable t &key (:key callable))
781 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
783 (defknown sublis (list t &key (:key callable) (:test callable)
784 (:test-not callable))
786 (defknown nsublis (list t &key (:key callable) (:test callable)
787 (:test-not callable))
789 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
791 (defknown member (t list &key (:key callable) (:test callable)
792 (:test-not callable))
793 list (foldable flushable call))
794 (defknown (member-if member-if-not) (callable list &key (:key callable))
795 list (foldable flushable call))
797 (defknown tailp (t list) boolean (foldable flushable))
799 (defknown adjoin (t list &key (:key callable) (:test callable)
800 (:test-not callable))
801 cons (flushable call))
803 (defknown (union intersection set-difference set-exclusive-or)
804 (list list &key (:key callable) (:test callable) (:test-not callable))
806 (foldable flushable call))
808 (defknown (nunion nintersection nset-difference nset-exclusive-or)
809 (list list &key (:key callable) (:test callable) (:test-not callable))
811 (foldable flushable call important-result)
812 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1 2))
815 (list list &key (:key callable) (:test callable) (:test-not callable))
817 (foldable flushable call))
819 (defknown acons (t t t) cons (movable flushable))
820 (defknown pairlis (t t &optional t) list (flushable))
822 (defknown (rassoc assoc)
823 (t list &key (:key callable) (:test callable) (:test-not callable))
824 list (foldable flushable call))
825 (defknown (assoc-if-not assoc-if rassoc-if rassoc-if-not)
826 (callable list &key (:key callable)) list (foldable flushable call))
828 (defknown (memq assq) (t list) list (foldable flushable))
829 (defknown delq (t list) list (flushable)
830 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
832 ;;;; from the "Hash Tables" chapter:
834 (defknown make-hash-table
835 (&key (:test callable) (:size unsigned-byte)
836 (:rehash-size (or (integer 1) (float (1.0))))
837 (:rehash-threshold (real 0 1))
838 (:hash-function (or null callable))
839 (:weakness (member nil :key :value :key-and-value :key-or-value))
843 (defknown hash-table-p (t) boolean (movable foldable flushable))
844 (defknown gethash (t hash-table &optional t) (values t boolean)
845 (flushable)) ; not FOLDABLE, since hash table contents can change
846 (defknown sb!impl::gethash3 (t hash-table t) (values t boolean)
847 (flushable)) ; not FOLDABLE, since hash table contents can change
848 (defknown %puthash (t hash-table t) t ()
849 :destroyed-constant-args (nth-constant-args 2)
850 :derive-type #'result-type-last-arg)
851 (defknown remhash (t hash-table) boolean ()
852 :destroyed-constant-args (nth-constant-args 2))
853 (defknown maphash (callable hash-table) null (flushable call))
854 (defknown clrhash (hash-table) hash-table ()
855 :destroyed-constant-args (nth-constant-args 2))
856 (defknown hash-table-count (hash-table) index (flushable))
857 (defknown hash-table-rehash-size (hash-table) (or index (single-float (1.0)))
858 (foldable flushable))
859 (defknown hash-table-rehash-threshold (hash-table) (single-float (0.0) 1.0)
860 (foldable flushable))
861 (defknown hash-table-size (hash-table) index (flushable))
862 (defknown hash-table-test (hash-table) symbol (foldable flushable))
863 (defknown sxhash (t) hash (#-sb-xc-host foldable flushable))
864 (defknown psxhash (t &optional t) hash (#-sb-xc-host foldable flushable))
865 (defknown hash-table-equalp (hash-table hash-table) boolean (foldable flushable))
867 ;;;; from the "Arrays" chapter
869 (defknown make-array ((or index list)
871 (:element-type type-specifier)
873 (:initial-contents t)
876 (:displaced-to (or array null))
877 (:displaced-index-offset index))
880 (defknown vector (&rest t) simple-vector (flushable))
882 (defknown aref (array &rest index) t (foldable))
883 (defknown row-major-aref (array index) t (foldable))
885 (defknown array-element-type (array)
887 (foldable flushable recursive))
888 (defknown array-rank (array) array-rank (foldable flushable))
889 (defknown array-dimension (array array-rank) index (foldable flushable))
890 (defknown array-dimensions (array) list (foldable flushable))
891 (defknown array-in-bounds-p (array &rest integer) boolean (foldable flushable))
892 (defknown array-row-major-index (array &rest index) array-total-size
893 (foldable flushable))
894 (defknown array-total-size (array) array-total-size (foldable flushable))
895 (defknown adjustable-array-p (array) boolean (movable foldable flushable))
897 (defknown svref (simple-vector index) t (foldable flushable))
898 (defknown bit ((array bit) &rest index) bit (foldable flushable))
899 (defknown sbit ((simple-array bit) &rest index) bit (foldable flushable))
901 ;;; FIXME: :DESTROYED-CONSTANT-ARGS for these is complicated.
902 (defknown (bit-and bit-ior bit-xor bit-eqv bit-nand bit-nor bit-andc1 bit-andc2
904 ((array bit) (array bit) &optional (or (array bit) (member t nil)))
907 #|:derive-type #'result-type-last-arg|#)
909 (defknown bit-not ((array bit) &optional (or (array bit) (member t nil)))
912 #|:derive-type #'result-type-last-arg|#)
914 (defknown bit-vector-= (bit-vector bit-vector) boolean
915 (movable foldable flushable))
917 (defknown array-has-fill-pointer-p (array) boolean
918 (movable foldable flushable))
919 (defknown fill-pointer (complex-vector) index
920 (unsafely-flushable explicit-check))
921 (defknown vector-push (t complex-vector) (or index null)
923 :destroyed-constant-args (nth-constant-args 2))
924 (defknown vector-push-extend (t complex-vector &optional (and index (integer 1))) index
926 :destroyed-constant-args (nth-constant-args 2))
927 (defknown vector-pop (complex-vector) t
929 :destroyed-constant-args (nth-constant-args 1))
931 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
932 ;;; Also, an important-result warning could be provided if the array
933 ;;; is known to be not expressly adjustable.
934 (defknown adjust-array
935 (array (or index list) &key (:element-type type-specifier)
936 (:initial-element t) (:initial-contents t)
937 (:fill-pointer t) (:displaced-to (or array null))
938 (:displaced-index-offset index))
940 ; :derive-type 'result-type-arg1) Not even close...
942 ;;;; from the "Strings" chapter:
944 (defknown char (string index) character (foldable flushable))
945 (defknown schar (simple-string index) character (foldable flushable))
947 (defknown (string= string-equal)
948 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
949 (:start2 index) (:end2 sequence-end))
951 (foldable flushable))
953 (defknown (string< string> string<= string>= string/= string-lessp
954 string-greaterp string-not-lessp string-not-greaterp
956 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
957 (:start2 index) (:end2 sequence-end))
959 (foldable flushable))
961 (defknown make-string (index &key (:element-type type-specifier)
962 (:initial-element character))
963 simple-string (flushable))
965 (defknown (string-trim string-left-trim string-right-trim)
966 (sequence string-designator) string (flushable))
968 (defknown (string-upcase string-downcase string-capitalize)
969 (string-designator &key (:start index) (:end sequence-end))
970 simple-string (flushable))
972 (defknown (nstring-upcase nstring-downcase nstring-capitalize)
973 (string &key (:start index) (:end sequence-end))
975 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
977 (defknown string (string-designator) string
978 (flushable explicit-check))
980 ;;;; internal non-keyword versions of string predicates:
982 (defknown (string<* string>* string<=* string>=* string/=*)
983 (string-designator string-designator index sequence-end index sequence-end)
985 (foldable flushable))
988 (string-designator string-designator index sequence-end index sequence-end)
990 (foldable flushable))
992 ;;;; from the "Eval" chapter:
994 (defknown eval (t) * (recursive))
995 (defknown constantp (t &optional lexenv-designator) boolean
996 (foldable flushable))
998 ;;;; from the "Streams" chapter:
1000 (defknown make-synonym-stream (symbol) stream (flushable))
1001 (defknown make-broadcast-stream (&rest stream) stream (unsafely-flushable))
1002 (defknown make-concatenated-stream (&rest stream) stream (unsafely-flushable))
1003 (defknown make-two-way-stream (stream stream) stream (unsafely-flushable))
1004 (defknown make-echo-stream (stream stream) stream (flushable))
1005 (defknown make-string-input-stream (string &optional index sequence-end)
1008 (defknown make-string-output-stream
1009 (&key (:element-type type-specifier))
1010 string-output-stream
1012 (defknown get-output-stream-string (stream) simple-string ())
1013 (defknown streamp (t) boolean (movable foldable flushable))
1014 (defknown stream-element-type (stream) type-specifier
1015 (movable foldable flushable))
1016 (defknown stream-external-format (stream) t (flushable))
1017 (defknown (output-stream-p input-stream-p) (stream) boolean
1018 (movable foldable flushable))
1019 (defknown open-stream-p (stream) boolean (flushable))
1020 (defknown close (stream &key (:abort t)) (eql t) ())
1021 (defknown file-string-length (ansi-stream (or string character))
1022 (or unsigned-byte null)
1025 ;;;; from the "Input/Output" chapter:
1027 ;;; (The I/O functions are given effects ANY under the theory that
1028 ;;; code motion over I/O operations is particularly confusing and not
1029 ;;; very important for efficiency.)
1031 (defknown copy-readtable (&optional (or readtable null) (or readtable null))
1034 (defknown readtablep (t) boolean (movable foldable flushable))
1036 (defknown set-syntax-from-char
1037 (character character &optional readtable (or readtable null)) (eql t)
1040 (defknown set-macro-character (character callable &optional t (or readtable null))
1043 (defknown get-macro-character (character &optional (or readtable null))
1044 (values callable boolean) (flushable))
1046 (defknown make-dispatch-macro-character (character &optional t readtable)
1048 (defknown set-dispatch-macro-character
1049 (character character callable &optional (or readtable null)) (eql t)
1051 (defknown get-dispatch-macro-character
1052 (character character &optional (or readtable null)) (or callable null)
1055 (defknown copy-pprint-dispatch
1056 (&optional (or sb!pretty:pprint-dispatch-table null))
1057 sb!pretty:pprint-dispatch-table
1059 (defknown pprint-dispatch
1060 (t &optional (or sb!pretty:pprint-dispatch-table null))
1061 (values callable boolean)
1063 (defknown (pprint-fill pprint-linear)
1064 (stream-designator t &optional t t)
1067 (defknown pprint-tabular
1068 (stream-designator t &optional t t unsigned-byte)
1071 (defknown pprint-indent
1072 ((member :block :current) real &optional stream-designator)
1075 (defknown pprint-newline
1076 ((member :linear :fill :miser :mandatory) &optional stream-designator)
1079 (defknown pprint-tab
1080 ((member :line :section :line-relative :section-relative)
1081 unsigned-byte unsigned-byte &optional stream-designator)
1084 (defknown set-pprint-dispatch
1085 (type-specifier (or null callable)
1086 &optional real sb!pretty:pprint-dispatch-table)
1090 ;;; may return any type due to eof-value...
1091 (defknown (read read-preserving-whitespace read-char-no-hang read-char)
1092 (&optional stream-designator t t t) t (explicit-check))
1094 (defknown read-delimited-list (character &optional stream-designator t) list
1096 (defknown read-line (&optional stream-designator t t t) (values t boolean)
1098 (defknown unread-char (character &optional stream-designator) t
1100 (defknown peek-char (&optional (or character (member nil t))
1101 stream-designator t t t)
1104 (defknown listen (&optional stream-designator) boolean (flushable explicit-check))
1106 (defknown clear-input (&optional stream-designator) null (explicit-check))
1108 (defknown read-from-string
1109 (string &optional t t
1113 (:preserve-whitespace t))
1115 (defknown parse-integer
1119 (:radix (integer 2 36))
1121 (values (or integer null ()) index))
1123 (defknown read-byte (stream &optional t t) t (explicit-check))
1127 (:stream stream-designator)
1130 (:base (integer 2 36))
1133 (:level (or unsigned-byte null))
1135 (:length (or unsigned-byte null))
1139 (:lines (or unsigned-byte null))
1140 (:right-margin (or unsigned-byte null))
1141 (:miser-width (or unsigned-byte null))
1142 (:pprint-dispatch t)
1143 (:suppress-errors t))
1145 (any explicit-check)
1146 :derive-type #'result-type-first-arg)
1148 (defknown (prin1 print princ) (t &optional stream-designator)
1150 (any explicit-check)
1151 :derive-type #'result-type-first-arg)
1153 (defknown (pprint) (t &optional stream-designator) (values)
1156 ;;; xxx-TO-STRING functions are not foldable because they depend on
1157 ;;; the dynamic environment, the state of the pretty printer dispatch
1158 ;;; table, and probably other run-time factors.
1159 (defknown write-to-string
1160 (t &key (:escape t) (:radix t) (:base (integer 2 36)) (:readably t)
1161 (:circle t) (:pretty t) (:level (or unsigned-byte null))
1162 (:length (or unsigned-byte null)) (:case t) (:array t) (:gensym t)
1163 (:lines (or unsigned-byte null)) (:right-margin (or unsigned-byte null))
1164 (:miser-width (or unsigned-byte null)) (:pprint-dispatch t))
1166 (flushable explicit-check))
1168 (defknown (prin1-to-string princ-to-string) (t) simple-string (flushable))
1170 (defknown write-char (character &optional stream-designator) character
1172 :derive-type #'result-type-first-arg)
1174 (defknown (write-string write-line)
1175 (string &optional stream-designator &key (:start index) (:end sequence-end))
1178 :derive-type #'result-type-first-arg)
1180 (defknown (terpri finish-output force-output clear-output)
1181 (&optional stream-designator) null
1184 (defknown fresh-line (&optional stream-designator) boolean
1187 (defknown write-byte (integer stream) integer
1189 :derive-type #'result-type-first-arg)
1191 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
1192 (defknown format ((or (member nil t) stream string)
1193 (or string function) &rest t)
1197 (defknown (y-or-n-p yes-or-no-p) (&optional string &rest t) boolean
1200 ;;;; from the "File System Interface" chapter:
1202 ;;; (No pathname functions are FOLDABLE because they all potentially
1203 ;;; depend on *DEFAULT-PATHNAME-DEFAULTS*, e.g. to provide a default
1204 ;;; host when parsing a namestring. They are not FLUSHABLE because
1205 ;;; parsing of a PATHNAME-DESIGNATOR might signal an error.)
1207 (defknown wild-pathname-p (pathname-designator
1209 (member nil :host :device
1215 (defknown pathname-match-p (pathname-designator pathname-designator)
1219 (defknown translate-pathname (pathname-designator
1221 pathname-designator &key)
1225 (defknown logical-pathname (pathname-designator) logical-pathname ())
1226 (defknown translate-logical-pathname (pathname-designator &key) pathname
1228 (defknown load-logical-pathname-translations (string) t ())
1229 (defknown logical-pathname-translations (logical-host-designator) list ())
1231 (defknown pathname (pathname-designator) pathname ())
1232 (defknown truename (pathname-designator) pathname ())
1234 (defknown parse-namestring
1235 (pathname-designator &optional
1236 (or list host string (member :unspecific))
1242 (values (or pathname null) sequence-end)
1245 (defknown merge-pathnames
1246 (pathname-designator &optional pathname-designator pathname-version)
1250 (defknown make-pathname
1251 (&key (:defaults pathname-designator)
1252 (:host (or string pathname-host))
1253 (:device (or string pathname-device))
1254 (:directory (or pathname-directory string (member :wild)))
1255 (:name (or pathname-name string (member :wild)))
1256 (:type (or pathname-type string (member :wild)))
1257 (:version pathname-version) (:case (member :local :common)))
1258 pathname (unsafely-flushable))
1260 (defknown pathnamep (t) boolean (movable flushable))
1262 (defknown pathname-host (pathname-designator
1263 &key (:case (member :local :common)))
1264 pathname-host (flushable))
1265 (defknown pathname-device (pathname-designator
1266 &key (:case (member :local :common)))
1267 pathname-device (flushable))
1268 (defknown pathname-directory (pathname-designator
1269 &key (:case (member :local :common)))
1270 pathname-directory (flushable))
1271 (defknown pathname-name (pathname-designator
1272 &key (:case (member :local :common)))
1273 pathname-name (flushable))
1274 (defknown pathname-type (pathname-designator
1275 &key (:case (member :local :common)))
1276 pathname-type (flushable))
1277 (defknown pathname-version (pathname-designator)
1278 pathname-version (flushable))
1280 (defknown pathname= (pathname pathname) boolean (movable foldable flushable))
1282 (defknown (namestring file-namestring directory-namestring host-namestring)
1283 (pathname-designator) (or simple-string null)
1284 (unsafely-flushable))
1286 (defknown enough-namestring (pathname-designator &optional pathname-designator)
1288 (unsafely-flushable))
1290 (defknown user-homedir-pathname (&optional t) pathname (flushable))
1293 (pathname-designator &key
1294 (:direction (member :input :output :io :probe))
1295 (:element-type type-specifier)
1296 (:if-exists (member :error :new-version :rename
1297 :rename-and-delete :overwrite
1298 :append :supersede nil))
1299 (:if-does-not-exist (member :error :create nil))
1300 (:external-format external-format-designator))
1303 (defknown rename-file (pathname-designator filename)
1304 (values pathname pathname pathname))
1305 (defknown delete-file (pathname-designator) (eql t))
1306 (defknown probe-file (pathname-designator) (or pathname null) ())
1307 (defknown file-write-date (pathname-designator) (or unsigned-byte null)
1309 (defknown file-author (pathname-designator) (or simple-string null)
1312 (defknown file-position (stream &optional
1313 (or unsigned-byte (member :start :end)))
1314 (or unsigned-byte (member t nil)))
1315 (defknown file-length (stream) (or unsigned-byte null) (unsafely-flushable))
1318 ((or filename stream)
1322 (:if-does-not-exist t)
1323 (:external-format external-format-designator))
1326 (defknown directory (pathname-designator &key (:resolve-symlinks t))
1329 ;;;; from the "Conditions" chapter:
1331 (defknown error (t &rest t) nil)
1332 (defknown cerror (format-control t &rest t) null)
1333 (defknown invalid-method-error (t format-control &rest t) *) ; FIXME: first arg is METHOD
1334 (defknown method-combination-error (format-control &rest t) *)
1335 (defknown signal (t &rest t) null)
1336 (defknown warn (t &rest t) null)
1337 (defknown invoke-debugger (condition) nil)
1338 (defknown break (&optional format-control &rest t) null)
1339 (defknown make-condition (type-specifier &rest t) condition)
1340 (defknown compute-restarts (&optional (or condition null)) list)
1341 (defknown find-restart (restart-designator &optional (or condition null))
1343 (defknown invoke-restart (restart-designator &rest t) *)
1344 (defknown invoke-restart-interactively (restart-designator) *)
1345 (defknown restart-name (restart) symbol)
1346 (defknown (abort muffle-warning) (&optional (or condition null)) nil)
1347 (defknown continue (&optional (or condition null)) null)
1348 (defknown (store-value use-value) (t &optional (or condition null))
1351 ;;; and analogous SBCL extension:
1352 (defknown sb!impl::%failed-aver (t) nil)
1353 (defknown bug (t &rest t) nil) ; never returns
1356 ;;;; from the "Miscellaneous" Chapter:
1358 (defknown compile ((or symbol cons) &optional (or list function null))
1359 (values (or function symbol cons) boolean boolean))
1361 (defknown compile-file
1362 (pathname-designator
1366 (:output-file (or pathname-designator
1368 ;; FIXME: This last case is a non-ANSI hack.
1372 (:external-format external-format-designator)
1378 (values (or pathname null) boolean boolean))
1380 (defknown (compile-file-pathname)
1381 (pathname-designator &key (:output-file (or pathname-designator
1387 ;; FIXME: consider making (OR CALLABLE CONS) something like
1388 ;; EXTENDED-FUNCTION-DESIGNATOR
1389 (defknown disassemble ((or callable cons) &key
1390 (:stream stream) (:use-labels t))
1393 (defknown describe (t &optional (or stream (member t nil))) (values))
1394 (defknown function-lambda-expression (function) (values t boolean t))
1395 (defknown inspect (t) (values))
1396 (defknown room (&optional (member t nil :default)) (values))
1397 (defknown ed (&optional (or symbol cons filename))
1399 (defknown dribble (&optional filename &key (:if-exists t)) (values))
1401 (defknown apropos (string-designator &optional package-designator t) (values))
1402 (defknown apropos-list (string-designator &optional package-designator t) list
1403 (flushable recursive))
1405 (defknown get-decoded-time ()
1406 (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1407 (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1410 (defknown get-universal-time () unsigned-byte (flushable))
1412 (defknown decode-universal-time
1413 (unsigned-byte &optional (or null (rational -24 24)))
1414 (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1415 (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1418 (defknown encode-universal-time
1419 ((integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1420 (integer 1 12) unsigned-byte &optional (or null (rational -24 24)))
1424 (defknown (get-internal-run-time get-internal-real-time)
1425 () internal-time (flushable))
1427 (defknown sleep ((real 0)) null (explicit-check))
1429 (defknown call-with-timing (callable callable &rest t) *
1432 ;;; Even though ANSI defines LISP-IMPLEMENTATION-TYPE and
1433 ;;; LISP-IMPLEMENTATION-VERSION to possibly punt and return NIL, we
1434 ;;; know that there's no valid reason for our implementations to ever
1435 ;;; do so, so we can safely guarantee that they'll return strings.
1436 (defknown (lisp-implementation-type lisp-implementation-version)
1437 () simple-string (flushable))
1439 ;;; For any of these functions, meaningful information might not be
1440 ;;; available, so -- unlike the related LISP-IMPLEMENTATION-FOO
1441 ;;; functions -- these really can return NIL.
1442 (defknown (machine-type machine-version machine-instance
1443 software-type software-version
1444 short-site-name long-site-name)
1445 () (or simple-string null) (flushable))
1447 (defknown identity (t) t (movable foldable flushable)
1448 :derive-type #'result-type-first-arg)
1450 (defknown constantly (t) function (movable flushable))
1451 (defknown complement (function) function (movable flushable))
1453 ;;;; miscellaneous extensions
1455 (defknown symbol-global-value (symbol) t ())
1456 (defknown set-symbol-global-value (symbol t) t ()
1457 :derive-type #'result-type-last-arg)
1459 (defknown get-bytes-consed () unsigned-byte (flushable))
1460 (defknown mask-signed-field ((integer 0 *) integer) integer
1461 (movable flushable foldable))
1463 (defknown array-storage-vector (array) (simple-array * (*))
1466 ;;;; magical compiler frobs
1468 (defknown %rest-values (t t t) * (always-translatable))
1469 (defknown %rest-ref (t t t t) * (always-translatable))
1470 (defknown %rest-length (t t t) * (always-translatable))
1471 (defknown %rest-null (t t t t) * (always-translatable))
1472 (defknown %rest-true (t t t) * (always-translatable))
1474 (defknown %unary-truncate/single-float (single-float) integer (movable foldable flushable))
1475 (defknown %unary-truncate/double-float (double-float) integer (movable foldable flushable))
1477 ;;; We can't fold this in general because of SATISFIES. There is a
1478 ;;; special optimizer anyway.
1479 (defknown %typep (t (or type-specifier ctype)) boolean
1480 (movable flushable explicit-check))
1481 (defknown %instance-typep (t (or type-specifier ctype)) boolean
1482 (movable flushable explicit-check always-translatable))
1483 ;;; We should never emit a call to %typep-wrapper
1484 (defknown %typep-wrapper (t t (or type-specifier ctype)) t
1485 (movable flushable always-translatable))
1487 (defknown %cleanup-point () t)
1488 (defknown %special-bind (t t) t)
1489 (defknown %special-unbind (t) t)
1490 (defknown %listify-rest-args (t index) list (flushable))
1491 (defknown %more-arg-context (t t) (values t index) (flushable))
1492 (defknown %more-arg (t index) t)
1493 #!+stack-grows-downward-not-upward
1494 ;;; FIXME: The second argument here should really be NEGATIVE-INDEX, but doing that
1495 ;;; breaks the build, and I cannot seem to figure out why. --NS 2006-06-29
1496 (defknown %more-kw-arg (t fixnum) (values t t))
1497 (defknown %more-arg-values (t index index) * (flushable))
1498 (defknown %verify-arg-count (index index) (values))
1499 (defknown %arg-count-error (t) nil)
1500 (defknown %unknown-values () *)
1501 (defknown %catch (t t) t)
1502 (defknown %unwind-protect (t t) t)
1503 (defknown (%catch-breakup %unwind-protect-breakup) () t)
1504 (defknown %lexical-exit-breakup (t) t)
1505 (defknown %continue-unwind (t t t) nil)
1506 (defknown %throw (t &rest t) nil) ; This is MV-called.
1507 (defknown %nlx-entry (t) *)
1508 (defknown %%primitive (t t &rest t) *)
1509 (defknown %pop-values (t) t)
1510 (defknown %nip-values (t t &rest t) (values))
1511 (defknown %allocate-closures (t) *)
1512 (defknown %type-check-error (t t) nil)
1514 ;; FIXME: This function does not return, but due to the implementation
1515 ;; of FILTER-LVAR we cannot write it here.
1516 (defknown %compile-time-type-error (t t t t) *)
1517 (defknown sb!kernel::case-failure (t t t) nil)
1519 (defknown %odd-key-args-error () nil)
1520 (defknown %unknown-key-arg-error (t) nil)
1521 (defknown (%ldb %mask-field) (bit-index bit-index integer) unsigned-byte
1522 (movable foldable flushable explicit-check))
1523 (defknown (%dpb %deposit-field) (integer bit-index bit-index integer) integer
1524 (movable foldable flushable explicit-check))
1525 (defknown %negate (number) number (movable foldable flushable explicit-check))
1526 (defknown %check-bound (array index fixnum) index
1527 (movable foldable flushable dx-safe))
1528 (defknown data-vector-ref (simple-array index) t
1529 (foldable unsafely-flushable explicit-check always-translatable))
1530 (defknown data-vector-ref-with-offset (simple-array fixnum fixnum) t
1531 (foldable unsafely-flushable explicit-check always-translatable))
1532 (defknown data-vector-set (array index t) t
1533 (explicit-check always-translatable))
1534 (defknown data-vector-set-with-offset (array fixnum fixnum t) t
1535 (explicit-check always-translatable))
1536 (defknown hairy-data-vector-ref (array index) t
1537 (foldable explicit-check))
1538 (defknown hairy-data-vector-set (array index t) t (explicit-check))
1539 (defknown hairy-data-vector-ref/check-bounds (array index) t
1540 (foldable explicit-check))
1541 (defknown hairy-data-vector-set/check-bounds (array index t)
1544 (defknown %caller-frame () t (flushable))
1545 (defknown %caller-pc () system-area-pointer (flushable))
1546 (defknown %with-array-data (array index (or index null))
1547 (values (simple-array * (*)) index index index)
1548 (foldable flushable))
1549 (defknown %with-array-data/fp (array index (or index null))
1550 (values (simple-array * (*)) index index index)
1551 (foldable flushable))
1552 (defknown %set-symbol-package (symbol t) t ())
1553 (defknown %coerce-name-to-fun ((or symbol cons)) function (flushable))
1554 (defknown %coerce-callable-to-fun (callable) function (flushable))
1555 (defknown array-bounding-indices-bad-error (t t t) nil)
1556 (defknown sequence-bounding-indices-bad-error (t t t) nil)
1557 (defknown %find-position
1558 (t sequence t index sequence-end function function)
1559 (values t (or index null))
1561 (defknown (%find-position-if %find-position-if-not)
1562 (function sequence t index sequence-end function)
1563 (values t (or index null))
1565 (defknown effective-find-position-test (callable callable)
1567 (flushable foldable))
1568 (defknown effective-find-position-key (callable)
1570 (flushable foldable))
1572 (defknown (%adjoin %adjoin-eq)
1575 (explicit-check flushable))
1577 (defknown (%member %member-eq
1578 %assoc %assoc-eq %rassoc %rassoc-eq)
1581 (explicit-check foldable flushable))
1583 (defknown (%adjoin-key %adjoin-key-eq)
1586 (explicit-check flushable call))
1588 (defknown (%member-key %member-key-eq
1589 %assoc-key %assoc-key-eq %rassoc-key %rassoc-key-eq)
1592 (explicit-check foldable flushable call))
1594 (defknown (%assoc-if %assoc-if-not %rassoc-if %rassoc-if-not
1595 %member-if %member-if-not)
1598 (explicit-check foldable flushable call))
1600 (defknown (%assoc-if-key %assoc-if-not-key %rassoc-if-key %rassoc-if-not-key
1601 %member-if-key %member-if-not-key)
1602 (function list function)
1604 (explicit-check foldable flushable call))
1606 (defknown (%adjoin-test %adjoin-test-not)
1609 (explicit-check flushable call))
1611 (defknown (%member-test %member-test-not
1612 %assoc-test %assoc-test-not
1613 %rassoc-test %rassoc-test-not)
1616 (explicit-check foldable flushable call))
1618 (defknown (%adjoin-key-test %adjoin-key-test-not)
1619 (t list function function)
1621 (explicit-check flushable call))
1623 (defknown (%member-key-test %member-key-test-not
1624 %assoc-key-test %assoc-key-test-not
1625 %rassoc-key-test %rassoc-key-test-not)
1626 (t list function function)
1628 (explicit-check foldable flushable call))
1630 (defknown %check-vector-sequence-bounds (vector index sequence-end)
1633 ;;; FIXME: including this information here is probably necessary to
1634 ;;; get efficient compilation of the inline expansion of
1635 ;;; %FIND-POSITION-IF, so it should maybe be in a more
1636 ;;; compiler-friendly package (SB-INT?)
1637 (defknown sb!impl::signal-bounding-indices-bad-error
1638 (sequence index sequence-end)
1639 nil) ; never returns
1642 (defknown arg-count-error (t t t t t t) nil ())
1646 (defknown (setf aref) (t array &rest index) t ()
1647 :destroyed-constant-args (nth-constant-args 2)
1648 :derive-type #'result-type-first-arg)
1649 (defknown %set-row-major-aref (array index t) t ()
1650 :destroyed-constant-args (nth-constant-args 1))
1651 (defknown (%rplaca %rplacd) (cons t) t ()
1652 :destroyed-constant-args (nth-constant-args 1)
1653 :derive-type #'result-type-last-arg)
1654 (defknown %put (symbol t t) t ())
1655 (defknown %setelt (sequence index t) t ()
1656 :destroyed-constant-args (nth-constant-args 1)
1657 :derive-type #'result-type-last-arg)
1658 (defknown %svset (simple-vector index t) t ()
1659 :destroyed-constant-args (nth-constant-args 1))
1660 (defknown (setf bit) (bit (array bit) &rest index) bit ()
1661 :destroyed-constant-args (nth-constant-args 2))
1662 (defknown (setf sbit) (bit (simple-array bit) &rest index) bit ()
1663 :destroyed-constant-args (nth-constant-args 2))
1664 (defknown %charset (string index character) character ()
1665 :destroyed-constant-args (nth-constant-args 1))
1666 (defknown %scharset (simple-string index character) character ()
1667 :destroyed-constant-args (nth-constant-args 1))
1668 (defknown %set-symbol-value (symbol t) t ())
1669 (defknown (setf symbol-function) (function symbol) function ())
1670 (defknown %set-symbol-plist (symbol list) list ()
1671 :derive-type #'result-type-last-arg)
1672 (defknown %setnth (unsigned-byte list t) t ()
1673 :destroyed-constant-args (nth-constant-args 2)
1674 :derive-type #'result-type-last-arg)
1675 (defknown %set-fill-pointer (complex-vector index) index
1677 :destroyed-constant-args (nth-constant-args 1)
1678 :derive-type #'result-type-last-arg)
1680 ;;;; ALIEN and call-out-to-C stuff
1682 ;; Used by WITH-PINNED-OBJECTS
1684 (defknown sb!vm::touch-object (t) (values)
1685 (always-translatable))
1688 (defknown foreign-symbol-dataref-sap (simple-string)
1690 (movable flushable))
1692 (defknown foreign-symbol-sap (simple-string &optional boolean)
1694 (movable flushable))
1696 (defknown foreign-symbol-address (simple-string &optional boolean)
1697 (values integer boolean)
1698 (movable flushable))
1700 ;;;; miscellaneous internal utilities
1702 (defknown %fun-name (function) t (flushable))
1703 (defknown (setf %fun-name) (t function) t ())
1705 (defknown policy-quality (policy symbol) policy-quality
1708 (defknown compiler-error (t &rest t) nil ())
1709 (defknown (compiler-warn compiler-style-warn) (t &rest t) (values) ())
1710 (defknown (compiler-notify maybe-compiler-notify) ((or string symbol) &rest t)
1713 (defknown style-warn (t &rest t) null ())
1715 (defknown coerce-to-condition ((or condition symbol string function)
1716 list type-specifier symbol)
1720 (defknown sc-number-or-lose (symbol) sc-number
1723 ;;;; memory barriers
1725 (defknown sb!vm:%compiler-barrier () (values) ())
1726 (defknown sb!vm:%memory-barrier () (values) ())
1727 (defknown sb!vm:%read-barrier () (values) ())
1728 (defknown sb!vm:%write-barrier () (values) ())
1729 (defknown sb!vm:%data-dependency-barrier () (values) ())
1732 ;;; Note: This known function does not have an out-of-line definition;
1733 ;;; and if such a definition were needed, it would not need to "call"
1734 ;;; itself inline, but could be a no-op, because the compiler inserts a
1735 ;;; use of the VOP in the function prologue anyway.
1736 (defknown sb!kernel::gc-safepoint () (values) ())
1739 (defknown %compare-and-swap-svref (simple-vector index t t) t
1741 (defknown %compare-and-swap-instance-ref (instance index t t) t
1743 (defknown %compare-and-swap-symbol-value (symbol t t) t
1745 (defknown spin-loop-hint () (values)
1746 (always-translatable))