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))
82 (sb!xc:deftype name-for-class () t)
83 (defknown classoid-name (classoid) symbol (flushable))
84 (defknown find-classoid (name-for-class &optional t)
85 (or classoid null) ())
86 (defknown classoid-of (t) classoid (flushable))
87 (defknown layout-of (t) layout (flushable))
88 (defknown copy-structure (structure-object) structure-object
91 ;;;; from the "Control Structure" chapter:
93 ;;; This is not FLUSHABLE, since it's required to signal an error if
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)
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
127 ;;; According to CLHS the result must be a LIST, but we do not check
129 (defknown (mapcan mapcon) (callable list &rest list) t
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)
145 (defknown (macroexpand macroexpand-1 %macroexpand %macroexpand-1)
146 (t &optional lexenv-designator)
147 (values form &optional boolean))
149 (defknown compiler-macro-function (t &optional lexenv-designator)
153 ;;;; from the "Declarations" chapter:
155 (defknown proclaim (list) (values) (recursive))
157 ;;;; from the "Symbols" chapter:
159 (defknown get (symbol t &optional t) t (flushable))
160 (defknown sb!impl::get2 (symbol t) t (flushable))
161 (defknown sb!impl::get3 (symbol t t) t (flushable))
162 (defknown remprop (symbol t) t)
163 (defknown symbol-plist (symbol) list (flushable))
164 (defknown getf (list t &optional t) t (foldable flushable))
165 (defknown get-properties (list list) (values t t list) (foldable flushable))
166 (defknown symbol-name (symbol) simple-string (movable foldable flushable))
167 (defknown make-symbol (string) symbol (flushable))
168 (defknown %make-symbol (simple-string) symbol (flushable))
169 (defknown copy-symbol (symbol &optional t) symbol (flushable))
170 (defknown gensym (&optional (or string unsigned-byte)) symbol ())
171 (defknown symbol-package (symbol) (or sb!xc:package null) (flushable))
172 (defknown keywordp (t) boolean (flushable)) ; If someone uninterns it...
174 ;;;; from the "Packages" chapter:
176 (defknown gentemp (&optional string package-designator) symbol)
178 (defknown make-package (string-designator &key
182 (:internal-symbols index)
183 (:external-symbols index))
185 (defknown find-package (package-designator) (or sb!xc:package null)
187 (defknown package-name (package-designator) (or simple-string null)
188 (unsafely-flushable))
189 (defknown package-nicknames (package-designator) list (unsafely-flushable))
190 (defknown rename-package (package-designator package-designator &optional list)
192 (defknown package-use-list (package-designator) list (unsafely-flushable))
193 (defknown package-used-by-list (package-designator) list (unsafely-flushable))
194 (defknown package-shadowing-symbols (package-designator) list (unsafely-flushable))
195 (defknown list-all-packages () list (flushable))
196 (defknown intern (string &optional package-designator)
197 (values symbol (member :internal :external :inherited nil))
199 (defknown find-symbol (string &optional package-designator)
200 (values symbol (member :internal :external :inherited nil))
202 (defknown (export import) (symbols-designator &optional package-designator)
204 (defknown unintern (symbol &optional package-designator) boolean)
205 (defknown unexport (symbols-designator &optional package-designator) (eql t))
206 (defknown shadowing-import (symbols-designator &optional package-designator)
208 (defknown shadow ((or symbol character string list) &optional package-designator)
210 (defknown (use-package unuse-package)
211 ((or list package-designator) &optional package-designator) (eql t))
212 (defknown find-all-symbols (string-designator) list (flushable))
214 ;;;; from the "Numbers" chapter:
216 (defknown zerop (number) boolean (movable foldable flushable explicit-check))
217 (defknown (plusp minusp) (real) boolean
218 (movable foldable flushable explicit-check))
219 (defknown (oddp evenp) (integer) boolean
220 (movable foldable flushable explicit-check))
221 (defknown (= /=) (number &rest number) boolean
222 (movable foldable flushable explicit-check))
223 (defknown (< > <= >=) (real &rest real) boolean
224 (movable foldable flushable explicit-check))
225 (defknown (max min) (real &rest real) real
226 (movable foldable flushable explicit-check))
228 (defknown + (&rest number) number
229 (movable foldable flushable explicit-check))
230 (defknown - (number &rest number) number
231 (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 unsafely-flushable explicit-check))
236 (defknown (1+ 1-) (number) number
237 (movable foldable flushable explicit-check))
239 (defknown conjugate (number) number
240 (movable foldable flushable explicit-check))
242 (defknown gcd (&rest integer) unsigned-byte
243 (movable foldable flushable explicit-check)
244 #|:derive-type 'boolean-result-type|#)
245 (defknown lcm (&rest integer) unsigned-byte
246 (movable foldable flushable explicit-check))
248 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
249 (defknown exp (number) irrational
250 (movable foldable flushable explicit-check recursive)
251 :derive-type #'result-type-float-contagion)
253 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
254 (defknown exp (number) irrational
255 (movable foldable flushable explicit-check recursive))
257 (defknown expt (number number) number
258 (movable foldable flushable explicit-check recursive))
259 (defknown log (number &optional real) irrational
260 (movable foldable flushable explicit-check))
261 (defknown sqrt (number) irrational
262 (movable foldable flushable explicit-check))
263 (defknown isqrt (unsigned-byte) unsigned-byte
264 (movable foldable flushable explicit-check recursive))
266 (defknown (abs phase signum) (number) number
267 (movable foldable flushable explicit-check))
268 (defknown cis (real) (complex float)
269 (movable foldable flushable explicit-check))
271 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
273 (defknown (sin cos) (number)
274 (or (float -1.0 1.0) (complex float))
275 (movable foldable flushable explicit-check recursive)
276 :derive-type #'result-type-float-contagion)
279 (number &optional real) irrational
280 (movable foldable unsafely-flushable explicit-check recursive)
281 :derive-type #'result-type-float-contagion)
283 (defknown (tan sinh cosh tanh asinh)
284 (number) irrational (movable foldable flushable explicit-check recursive)
285 :derive-type #'result-type-float-contagion)
288 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
290 (defknown (sin cos) (number)
291 (or (float -1.0 1.0) (complex float))
292 (movable foldable flushable explicit-check recursive))
295 (number &optional real) irrational
296 (movable foldable unsafely-flushable explicit-check recursive))
298 (defknown (tan sinh cosh tanh asinh)
299 (number) irrational (movable foldable flushable explicit-check recursive))
302 (defknown (asin acos acosh atanh)
304 (movable foldable flushable explicit-check recursive))
306 (defknown float (real &optional float) float
307 (movable foldable flushable explicit-check))
309 (defknown (rational) (real) rational
310 (movable foldable flushable explicit-check))
312 (defknown (rationalize) (real) rational
313 (movable foldable flushable explicit-check recursive))
315 (defknown (numerator denominator) (rational) integer
316 (movable foldable flushable))
318 (defknown (floor ceiling truncate round)
319 (real &optional real) (values integer real)
320 (movable foldable flushable explicit-check))
322 (defknown %multiply-high (word word) word
323 (movable foldable flushable))
325 (defknown (%floor %ceiling)
326 (real real) (values integer real)
327 (movable foldable flushable explicit-check))
329 (defknown (mod rem) (real real) real
330 (movable foldable flushable explicit-check))
332 (defknown (ffloor fceiling fround ftruncate)
333 (real &optional real) (values float real)
334 (movable foldable flushable explicit-check))
336 (defknown decode-float (float) (values float float-exponent float)
337 (movable foldable unsafely-flushable explicit-check))
338 (defknown scale-float (float integer) float
339 (movable foldable unsafely-flushable explicit-check))
340 (defknown float-radix (float) float-radix
341 (movable foldable unsafely-flushable))
342 (defknown float-sign (float &optional float) float
343 (movable foldable unsafely-flushable explicit-check))
344 (defknown (float-digits float-precision) (float) float-digits
345 (movable foldable unsafely-flushable explicit-check))
346 (defknown integer-decode-float (float)
347 (values integer float-int-exponent (member -1 1))
348 (movable foldable unsafely-flushable explicit-check))
350 (defknown complex (real &optional real) number
351 (movable foldable flushable explicit-check))
353 (defknown (realpart imagpart) (number) real (movable foldable flushable))
355 (defknown (logior logxor logand logeqv) (&rest integer) integer
356 (movable foldable flushable explicit-check))
358 (defknown (lognand lognor logandc1 logandc2 logorc1 logorc2)
359 (integer integer) integer
360 (movable foldable flushable explicit-check))
362 (defknown boole (boole-code integer integer) integer
363 (movable foldable flushable))
365 (defknown lognot (integer) integer (movable foldable flushable explicit-check))
366 (defknown logtest (integer integer) boolean (movable foldable flushable))
367 (defknown logbitp (unsigned-byte integer) boolean (movable foldable flushable))
368 (defknown ash (integer integer) integer
369 (movable foldable flushable explicit-check))
370 (defknown (logcount integer-length) (integer) bit-index
371 (movable foldable flushable explicit-check))
372 ;;; FIXME: According to the ANSI spec, it's legal to use any
373 ;;; nonnegative indices for BYTE arguments, not just BIT-INDEX. It's
374 ;;; hard to come up with useful ways to do this, but it is possible to
375 ;;; come up with *legal* ways to do this, so it would be nice
376 ;;; to fix this so we comply with the spec.
377 (defknown byte (bit-index bit-index) byte-specifier
378 (movable foldable flushable))
379 (defknown (byte-size byte-position) (byte-specifier) bit-index
380 (movable foldable flushable))
381 (defknown ldb (byte-specifier integer) integer (movable foldable flushable))
382 (defknown ldb-test (byte-specifier integer) boolean
383 (movable foldable flushable))
384 (defknown mask-field (byte-specifier integer) integer
385 (movable foldable flushable))
386 (defknown dpb (integer byte-specifier integer) integer
387 (movable foldable flushable))
388 (defknown deposit-field (integer byte-specifier integer) integer
389 (movable foldable flushable))
390 (defknown random ((or (float (0.0)) (integer 1)) &optional random-state)
391 (or (float 0.0) (integer 0))
393 (defknown make-random-state (&optional
394 (or (member nil t) random-state unsigned-byte
395 (simple-array (unsigned-byte 8) (*))
396 (simple-array (unsigned-byte 32) (*))))
397 random-state (flushable))
398 (defknown random-state-p (t) boolean (movable foldable flushable))
400 ;;;; from the "Characters" chapter:
401 (defknown (standard-char-p graphic-char-p alpha-char-p
402 upper-case-p lower-case-p both-case-p alphanumericp)
403 (character) boolean (movable foldable flushable))
405 (defknown digit-char-p (character &optional (integer 2 36))
406 (or (integer 0 35) null) (movable foldable flushable))
408 (defknown (char= char/= char< char> char<= char>= char-equal char-not-equal
409 char-lessp char-greaterp char-not-greaterp char-not-lessp)
410 (character &rest character) boolean (movable foldable flushable))
412 (defknown character (t) character (movable foldable unsafely-flushable))
413 (defknown char-code (character) char-code (movable foldable flushable))
414 (defknown (char-upcase char-downcase) (character) character
415 (movable foldable flushable))
416 (defknown digit-char (unsigned-byte &optional (integer 2 36))
417 (or character null) (movable foldable flushable))
418 (defknown char-int (character) char-code (movable foldable flushable))
419 (defknown char-name (character) (or simple-string null)
420 (movable foldable flushable))
421 (defknown name-char (string-designator) (or character null)
422 (movable foldable flushable))
423 (defknown code-char (char-code) character
424 ;; By suppressing constant folding on CODE-CHAR when the
425 ;; cross-compiler is running in the cross-compilation host vanilla
426 ;; ANSI Common Lisp, we can use CODE-CHAR expressions to delay until
427 ;; target Lisp run time the generation of CHARACTERs which aren't
428 ;; STANDARD-CHARACTERs. That way, we don't need to rely on the host
429 ;; Common Lisp being able to handle any characters other than those
430 ;; guaranteed by the ANSI spec.
431 (movable #-sb-xc-host foldable flushable))
433 ;;;; from the "Sequences" chapter:
435 (defknown elt (sequence index) t (foldable unsafely-flushable))
437 (defknown subseq (sequence index &optional sequence-end) consed-sequence
439 :derive-type (sequence-result-nth-arg 1))
441 (defknown copy-seq (sequence) consed-sequence (flushable)
442 :derive-type (sequence-result-nth-arg 1))
444 (defknown length (sequence) index (foldable flushable))
446 (defknown reverse (sequence) consed-sequence (flushable)
447 :derive-type (sequence-result-nth-arg 1))
449 (defknown nreverse (sequence) sequence (important-result)
450 :derive-type #'result-type-first-arg
451 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
453 (defknown make-sequence (type-specifier index
455 (:initial-element t))
458 :derive-type (creation-result-type-specifier-nth-arg 1))
460 (defknown concatenate (type-specifier &rest sequence) consed-sequence
462 :derive-type (creation-result-type-specifier-nth-arg 1))
464 (defknown (map %map) (type-specifier callable sequence &rest sequence)
467 ; :DERIVE-TYPE 'TYPE-SPEC-ARG1 ? Nope... (MAP NIL ...) returns NULL, not NIL.
469 (defknown %map-to-list-arity-1 (callable sequence) list (flushable call))
470 (defknown %map-to-simple-vector-arity-1 (callable sequence) simple-vector
472 (defknown %map-to-nil-on-simple-vector (callable simple-vector) null
474 (defknown %map-to-nil-on-vector (callable vector) null (flushable call))
475 (defknown %map-to-nil-on-sequence (callable sequence) null (flushable call))
477 (defknown map-into (sequence callable &rest sequence)
480 :derive-type #'result-type-first-arg
481 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
483 ;;; returns the result from the predicate...
484 (defknown some (callable sequence &rest sequence) t
485 (foldable unsafely-flushable call))
487 (defknown (every notany notevery) (callable sequence &rest sequence) boolean
488 (foldable unsafely-flushable call))
490 ;;; unsafe for :INITIAL-VALUE...
491 (defknown reduce (callable sequence &rest t &key (:from-end t) (:start index)
492 (:end sequence-end) (:initial-value t) (:key callable))
494 (foldable flushable call unsafe))
496 (defknown fill (sequence t &rest t &key
497 (:start index) (:end sequence-end)) sequence
499 :derive-type #'result-type-first-arg
500 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
503 (defknown replace (sequence sequence &rest t &key (:start1 index)
504 (:end1 sequence-end) (:start2 index) (:end2 sequence-end))
506 :derive-type #'result-type-first-arg
507 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
511 (t sequence &rest t &key (:from-end t) (:test callable)
512 (:test-not callable) (:start index) (:end sequence-end)
513 (:count sequence-count) (:key callable))
516 :derive-type (sequence-result-nth-arg 2))
519 (t t sequence &rest t &key (:from-end t) (:test callable)
520 (:test-not callable) (:start index) (:end sequence-end)
521 (:count sequence-count) (:key callable))
524 :derive-type (sequence-result-nth-arg 3))
526 (defknown (remove-if remove-if-not)
527 (callable sequence &rest t &key (:from-end t) (:start index)
528 (:end sequence-end) (:count sequence-count) (:key callable))
531 :derive-type (sequence-result-nth-arg 2))
533 (defknown (substitute-if substitute-if-not)
534 (t callable sequence &rest t &key (:from-end t) (:start index)
535 (:end sequence-end) (:count sequence-count) (:key callable))
538 :derive-type (sequence-result-nth-arg 3))
541 (t sequence &rest t &key (:from-end t) (:test callable)
542 (:test-not callable) (:start index) (:end sequence-end)
543 (:count sequence-count) (:key callable))
545 (flushable call important-result)
546 :derive-type (sequence-result-nth-arg 2)
547 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
549 (defknown nsubstitute
550 (t t sequence &rest t &key (:from-end t) (:test callable)
551 (:test-not callable) (:start index) (:end sequence-end)
552 (:count sequence-count) (:key callable))
555 :derive-type (sequence-result-nth-arg 3)
556 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
558 (defknown (delete-if delete-if-not)
559 (callable sequence &rest t &key (:from-end t) (:start index)
560 (:end sequence-end) (:count sequence-count) (:key callable))
562 (flushable call important-result)
563 :derive-type (sequence-result-nth-arg 2)
564 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
566 (defknown (nsubstitute-if nsubstitute-if-not)
567 (t callable sequence &rest t &key (:from-end t) (:start index)
568 (:end sequence-end) (:count sequence-count) (:key callable))
571 :derive-type (sequence-result-nth-arg 3)
572 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
574 (defknown remove-duplicates
575 (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
576 (:from-end t) (:end sequence-end) (:key callable))
578 (unsafely-flushable call)
579 :derive-type (sequence-result-nth-arg 1))
581 (defknown delete-duplicates
582 (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
583 (:from-end t) (:end sequence-end) (:key callable))
585 (unsafely-flushable call important-result)
586 :derive-type (sequence-result-nth-arg 1)
587 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
589 (defknown find (t sequence &rest t &key (:test callable)
590 (:test-not callable) (:start index) (:from-end t)
591 (:end sequence-end) (:key callable))
593 (foldable flushable call))
595 (defknown (find-if find-if-not)
596 (callable sequence &rest t &key (:from-end t) (:start index)
597 (:end sequence-end) (:key callable))
599 (foldable flushable call))
601 (defknown position (t sequence &rest t &key (:test callable)
602 (:test-not callable) (:start index) (:from-end t)
603 (:end sequence-end) (:key callable))
605 (foldable flushable call))
607 (defknown (position-if position-if-not)
608 (callable sequence &rest t &key (:from-end t) (:start index)
609 (:end sequence-end) (:key callable))
611 (foldable flushable call))
613 (defknown count (t sequence &rest t &key
614 (:test callable) (:test-not callable) (:start index)
615 (:from-end t) (:end sequence-end) (:key callable))
617 (foldable flushable call))
619 (defknown (count-if count-if-not)
620 (callable sequence &rest t &key
621 (:from-end t) (:start index) (:end sequence-end) (:key callable))
623 (foldable flushable call))
625 (defknown (mismatch search)
626 (sequence sequence &rest t &key (:from-end t) (:test callable)
627 (:test-not callable) (:start1 index) (:end1 sequence-end)
628 (:start2 index) (:end2 sequence-end) (:key callable))
630 (foldable flushable call))
632 ;;; not FLUSHABLE, since vector sort guaranteed in-place...
633 (defknown (stable-sort sort) (sequence callable &rest t &key (:key callable))
636 :derive-type (sequence-result-nth-arg 1)
637 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
638 (defknown sb!impl::stable-sort-list (list function function) list
639 (call important-result)
640 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
641 (defknown sb!impl::sort-vector (vector index index function (or function null))
642 * ; SORT-VECTOR works through side-effect
644 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
646 (defknown merge (type-specifier sequence sequence callable
647 &key (:key callable))
649 (call important-result)
650 :derive-type (creation-result-type-specifier-nth-arg 1)
651 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2 3))
653 ;;; not FLUSHABLE, despite what CMU CL's DEFKNOWN said..
654 (defknown read-sequence (sequence stream
661 (defknown write-sequence (sequence stream
667 :derive-type (sequence-result-nth-arg 1))
669 ;;;; from the "Manipulating List Structure" chapter:
670 (defknown (car cdr first rest)
673 (foldable flushable))
675 ;; Correct argument type restrictions for these functions are
676 ;; complicated, so we just declare them to accept LISTs and suppress
677 ;; flushing is safe code.
678 (defknown (caar cadr cdar cddr
679 caaar caadr cadar caddr cdaar cdadr cddar cdddr
680 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
681 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
682 second third fourth fifth sixth seventh eighth ninth tenth)
685 (foldable unsafely-flushable))
687 (defknown cons (t t) cons (movable flushable unsafe))
689 (defknown tree-equal (t t &key (:test callable) (:test-not callable)) boolean
690 (foldable flushable call))
691 (defknown endp (list) boolean (foldable flushable movable))
692 (defknown list-length (list) (or index null) (foldable unsafely-flushable))
693 (defknown nth (unsigned-byte list) t (foldable flushable))
694 (defknown nthcdr (unsigned-byte list) t (foldable unsafely-flushable))
696 (defknown last (list &optional unsigned-byte) t (foldable flushable))
697 (defknown %last0 (list) t (foldable flushable))
698 (defknown %last1 (list) t (foldable flushable))
699 (defknown %lastn/fixnum (list (and unsigned-byte fixnum)) t (foldable flushable))
700 (defknown %lastn/bignum (list (and unsigned-byte bignum)) t (foldable flushable))
702 (defknown list (&rest t) list (movable flushable unsafe))
703 (defknown list* (t &rest t) t (movable flushable unsafe))
704 (defknown make-list (index &key (:initial-element t)) list
705 (movable flushable unsafe))
707 ;;; All but last must be of type LIST, but there seems to be no way to
708 ;;; express that in this syntax.
709 (defknown append (&rest t) t (flushable))
711 (defknown copy-list (list) list (flushable))
712 (defknown copy-alist (list) list (flushable))
713 (defknown copy-tree (t) t (flushable recursive))
714 (defknown revappend (list t) t (flushable))
716 ;;; All but last must be of type LIST, but there seems to be no way to
717 ;;; express that in this syntax. The result must be LIST, but we do
718 ;;; not check it now :-).
719 (defknown nconc (&rest t) t ()
720 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
721 (defknown sb!impl::nconc2 (list t) t ()
722 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
724 (defknown nreconc (list t) t (important-result)
725 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
726 (defknown butlast (list &optional unsigned-byte) list (flushable))
727 (defknown nbutlast (list &optional unsigned-byte) list ()
728 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
730 (defknown ldiff (list t) list (flushable))
731 (defknown (rplaca rplacd) (cons t) list (unsafe)
732 :destroyed-constant-args (nth-constant-args 1))
734 (defknown subst (t t t &key (:key callable) (:test callable)
735 (:test-not callable))
736 t (flushable unsafe call))
737 (defknown nsubst (t t t &key (:key callable) (:test callable)
738 (:test-not callable))
740 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
742 (defknown (subst-if subst-if-not)
743 (t callable t &key (:key callable))
744 t (flushable unsafe call))
745 (defknown (nsubst-if nsubst-if-not)
746 (t callable t &key (:key callable))
748 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
750 (defknown sublis (list t &key (:key callable) (:test callable)
751 (:test-not callable))
752 t (flushable unsafe call))
753 (defknown nsublis (list t &key (:key callable) (:test callable)
754 (:test-not callable))
755 t (flushable unsafe call)
756 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
758 (defknown member (t list &key (:key callable) (:test callable)
759 (:test-not callable))
760 list (foldable flushable call))
761 (defknown (member-if member-if-not) (callable list &key (:key callable))
762 list (foldable flushable call))
764 (defknown tailp (t list) boolean (foldable flushable))
766 (defknown adjoin (t list &key (:key callable) (:test callable)
767 (:test-not callable))
768 list (foldable flushable unsafe call))
770 (defknown (union intersection set-difference set-exclusive-or)
771 (list list &key (:key callable) (:test callable) (:test-not callable))
773 (foldable flushable call))
775 (defknown (nunion nintersection nset-difference nset-exclusive-or)
776 (list list &key (:key callable) (:test callable) (:test-not callable))
778 (foldable flushable call important-result)
779 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1 2))
782 (list list &key (:key callable) (:test callable) (:test-not callable))
784 (foldable flushable call))
786 (defknown acons (t t t) list (movable flushable unsafe))
787 (defknown pairlis (t t &optional t) list (flushable unsafe))
789 (defknown (rassoc assoc)
790 (t list &key (:key callable) (:test callable) (:test-not callable))
791 list (foldable flushable call))
792 (defknown (assoc-if-not assoc-if rassoc-if rassoc-if-not)
793 (callable list &key (:key callable)) list (foldable flushable call))
795 (defknown (memq assq) (t list) list (foldable flushable unsafe))
796 (defknown delq (t list) list (flushable unsafe)
797 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
799 ;;;; from the "Hash Tables" chapter:
801 (defknown make-hash-table
802 (&key (:test callable) (:size unsigned-byte)
803 (:rehash-size (or (integer 1) (float (1.0))))
804 (:rehash-threshold (real 0 1))
805 (:hash-function (or null callable))
806 (:weakness (member nil :key :value :key-and-value :key-or-value))
810 (defknown hash-table-p (t) boolean (movable foldable flushable))
811 (defknown gethash (t hash-table &optional t) (values t boolean)
812 (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
813 (defknown sb!impl::gethash2 (t hash-table) (values t boolean)
814 (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
815 (defknown sb!impl::gethash3 (t hash-table t) (values t boolean)
816 (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
817 (defknown %puthash (t hash-table t) t (unsafe)
818 :destroyed-constant-args (nth-constant-args 2))
819 (defknown remhash (t hash-table) boolean ()
820 :destroyed-constant-args (nth-constant-args 2))
821 (defknown maphash (callable hash-table) null (flushable call))
822 (defknown clrhash (hash-table) hash-table ()
823 :destroyed-constant-args (nth-constant-args 2))
824 (defknown hash-table-count (hash-table) index (flushable))
825 (defknown hash-table-rehash-size (hash-table) (or index (single-float (1.0)))
826 (foldable flushable))
827 (defknown hash-table-rehash-threshold (hash-table) (single-float (0.0) 1.0)
828 (foldable flushable))
829 (defknown hash-table-size (hash-table) index (flushable))
830 (defknown hash-table-test (hash-table) symbol (foldable flushable))
831 (defknown sxhash (t) hash (#-sb-xc-host foldable flushable))
832 (defknown psxhash (t &optional t) hash (#-sb-xc-host foldable flushable))
834 ;;;; from the "Arrays" chapter
836 (defknown make-array ((or index list)
838 (:element-type type-specifier)
840 (:initial-contents t)
843 (:displaced-to (or array null))
844 (:displaced-index-offset index))
845 array (flushable unsafe))
847 (defknown vector (&rest t) simple-vector (flushable unsafe))
849 (defknown aref (array &rest index) t (foldable))
850 (defknown row-major-aref (array index) t (foldable))
852 (defknown array-element-type (array)
854 (foldable flushable recursive))
855 (defknown array-rank (array) array-rank (foldable flushable))
856 (defknown array-dimension (array array-rank) index (foldable flushable))
857 (defknown array-dimensions (array) list (foldable flushable))
858 (defknown array-in-bounds-p (array &rest integer) boolean (foldable flushable))
859 (defknown array-row-major-index (array &rest index) array-total-size
860 (foldable flushable))
861 (defknown array-total-size (array) array-total-size (foldable flushable))
862 (defknown adjustable-array-p (array) boolean (movable foldable flushable))
864 (defknown svref (simple-vector index) t (foldable flushable))
865 (defknown bit ((array bit) &rest index) bit (foldable flushable))
866 (defknown sbit ((simple-array bit) &rest index) bit (foldable flushable))
868 ;;; FIXME: :DESTROYED-CONSTANT-ARGS for these is complicated.
869 (defknown (bit-and bit-ior bit-xor bit-eqv bit-nand bit-nor bit-andc1 bit-andc2
871 ((array bit) (array bit) &optional (or (array bit) (member t nil)))
874 #|:derive-type #'result-type-last-arg|#)
876 (defknown bit-not ((array bit) &optional (or (array bit) (member t nil)))
879 #|:derive-type #'result-type-last-arg|#)
881 (defknown bit-vector-= (bit-vector bit-vector) boolean
882 (movable foldable flushable))
884 (defknown array-has-fill-pointer-p (array) boolean
885 (movable foldable flushable))
886 (defknown fill-pointer (complex-vector) index
887 (unsafely-flushable explicit-check))
888 (defknown vector-push (t complex-vector) (or index null)
890 :destroyed-constant-args (nth-constant-args 2))
891 (defknown vector-push-extend (t complex-vector &optional (and index (integer 1))) index
893 :destroyed-constant-args (nth-constant-args 2))
894 (defknown vector-pop (complex-vector) t
896 :destroyed-constant-args (nth-constant-args 1))
898 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
899 ;;; Also, an important-result warning could be provided if the array
900 ;;; is known to be not expressly adjustable.
901 (defknown adjust-array
902 (array (or index list) &key (:element-type type-specifier)
903 (:initial-element t) (:initial-contents t)
904 (:fill-pointer t) (:displaced-to (or array null))
905 (:displaced-index-offset index))
907 ; :derive-type 'result-type-arg1) Not even close...
909 ;;;; from the "Strings" chapter:
911 (defknown char (string index) character (foldable flushable))
912 (defknown schar (simple-string index) character (foldable flushable))
914 (defknown (string= string-equal)
915 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
916 (:start2 index) (:end2 sequence-end))
918 (foldable flushable))
920 (defknown (string< string> string<= string>= string/= string-lessp
921 string-greaterp string-not-lessp string-not-greaterp
923 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
924 (:start2 index) (:end2 sequence-end))
926 (foldable flushable))
928 (defknown make-string (index &key (:element-type type-specifier)
929 (:initial-element character))
930 simple-string (flushable))
932 (defknown (string-trim string-left-trim string-right-trim)
933 (sequence string-designator) string (flushable))
935 (defknown (string-upcase string-downcase string-capitalize)
936 (string-designator &key (:start index) (:end sequence-end))
937 simple-string (flushable))
939 (defknown (nstring-upcase nstring-downcase nstring-capitalize)
940 (string &key (:start index) (:end sequence-end))
942 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
944 (defknown string (string-designator) string
945 (flushable explicit-check))
947 ;;;; internal non-keyword versions of string predicates:
949 (defknown (string<* string>* string<=* string>=* string/=*)
950 (string-designator string-designator index sequence-end index sequence-end)
952 (foldable flushable))
955 (string-designator string-designator index sequence-end index sequence-end)
957 (foldable flushable))
959 ;;;; from the "Eval" chapter:
961 (defknown eval (t) * (recursive))
962 (defknown constantp (t &optional lexenv-designator) boolean
963 (foldable flushable))
965 ;;;; from the "Streams" chapter:
967 (defknown make-synonym-stream (symbol) stream (flushable))
968 (defknown make-broadcast-stream (&rest stream) stream (unsafely-flushable))
969 (defknown make-concatenated-stream (&rest stream) stream (unsafely-flushable))
970 (defknown make-two-way-stream (stream stream) stream (unsafely-flushable))
971 (defknown make-echo-stream (stream stream) stream (flushable))
972 (defknown make-string-input-stream (string &optional index sequence-end)
975 (defknown make-string-output-stream
976 (&key (:element-type type-specifier))
979 (defknown get-output-stream-string (stream) simple-string ())
980 (defknown streamp (t) boolean (movable foldable flushable))
981 (defknown stream-element-type (stream) type-specifier
982 (movable foldable flushable))
983 (defknown (output-stream-p input-stream-p) (stream) boolean
984 (movable foldable flushable))
985 (defknown close (stream &key (:abort t)) (eql t) ())
987 ;;;; from the "Input/Output" chapter:
989 ;;; (The I/O functions are given effects ANY under the theory that
990 ;;; code motion over I/O operations is particularly confusing and not
991 ;;; very important for efficiency.)
993 (defknown copy-readtable (&optional (or readtable null) (or readtable null))
996 (defknown readtablep (t) boolean (movable foldable flushable))
998 (defknown set-syntax-from-char
999 (character character &optional readtable (or readtable null)) (eql t)
1002 (defknown set-macro-character (character callable &optional t (or readtable null))
1005 (defknown get-macro-character (character &optional (or readtable null))
1006 (values callable boolean) (flushable))
1008 (defknown make-dispatch-macro-character (character &optional t readtable)
1010 (defknown set-dispatch-macro-character
1011 (character character callable &optional (or readtable null)) (eql t)
1013 (defknown get-dispatch-macro-character
1014 (character character &optional (or readtable null)) (or callable null)
1017 (defknown copy-pprint-dispatch
1018 (&optional (or sb!pretty:pprint-dispatch-table null))
1019 sb!pretty:pprint-dispatch-table
1021 (defknown pprint-dispatch
1022 (t &optional (or sb!pretty:pprint-dispatch-table null))
1023 (values callable boolean)
1025 (defknown (pprint-fill pprint-linear)
1026 (stream-designator t &optional t t)
1029 (defknown pprint-tabular
1030 (stream-designator t &optional t t unsigned-byte)
1033 (defknown pprint-indent
1034 ((member :block :current) real &optional stream-designator)
1037 (defknown pprint-newline
1038 ((member :linear :fill :miser :mandatory) &optional stream-designator)
1041 (defknown pprint-tab
1042 ((member :line :section :line-relative :section-relative)
1043 unsigned-byte unsigned-byte &optional stream-designator)
1046 (defknown set-pprint-dispatch
1047 (type-specifier (or null callable)
1048 &optional real sb!pretty:pprint-dispatch-table)
1052 ;;; may return any type due to eof-value...
1053 (defknown (read read-preserving-whitespace read-char-no-hang read-char)
1054 (&optional stream-designator t t t) t (explicit-check))
1056 (defknown read-delimited-list (character &optional stream-designator t) list
1058 (defknown read-line (&optional stream-designator t t t) (values t boolean)
1060 (defknown unread-char (character &optional stream-designator) t
1062 (defknown peek-char (&optional (or character (member nil t))
1063 stream-designator t t t)
1066 (defknown listen (&optional stream-designator) boolean (flushable explicit-check))
1068 (defknown clear-input (&optional stream-designator) null (explicit-check))
1070 (defknown read-from-string
1071 (string &optional t t
1075 (:preserve-whitespace t))
1077 (defknown parse-integer
1081 (:radix (integer 2 36))
1083 (values (or integer null ()) index))
1085 (defknown read-byte (stream &optional t t) t (explicit-check))
1089 (:stream stream-designator)
1092 (:base (integer 2 36))
1095 (:level (or unsigned-byte null))
1097 (:length (or unsigned-byte null))
1101 (:lines (or unsigned-byte null))
1102 (:right-margin (or unsigned-byte null))
1103 (:miser-width (or unsigned-byte null))
1104 (:pprint-dispatch t))
1106 (any explicit-check)
1107 :derive-type #'result-type-first-arg)
1109 (defknown (prin1 print princ) (t &optional stream-designator)
1111 (any explicit-check)
1112 :derive-type #'result-type-first-arg)
1114 ;;; xxx-TO-STRING functions are not foldable because they depend on
1115 ;;; the dynamic environment, the state of the pretty printer dispatch
1116 ;;; table, and probably other run-time factors.
1117 (defknown write-to-string
1118 (t &key (:escape t) (:radix t) (:base (integer 2 36)) (:readably t)
1119 (:circle t) (:pretty t) (:level (or unsigned-byte null))
1120 (:length (or unsigned-byte null)) (:case t) (:array t) (:gensym t)
1121 (:lines (or unsigned-byte null)) (:right-margin (or unsigned-byte null))
1122 (:miser-width (or unsigned-byte null)) (:pprint-dispatch t))
1124 (flushable explicit-check))
1126 (defknown (prin1-to-string princ-to-string) (t) simple-string (flushable))
1128 (defknown write-char (character &optional stream-designator) character
1130 (defknown (write-string write-line)
1131 (string &optional stream-designator &key (:start index) (:end sequence-end))
1135 (defknown (terpri finish-output force-output clear-output)
1136 (&optional stream-designator) null
1139 (defknown fresh-line (&optional stream-designator) boolean
1142 (defknown write-byte (integer stream) integer
1145 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
1146 (defknown format ((or (member nil t) stream string)
1147 (or string function) &rest t)
1151 (defknown (y-or-n-p yes-or-no-p) (&optional string &rest t) boolean
1154 ;;;; from the "File System Interface" chapter:
1156 ;;; (No pathname functions are FOLDABLE because they all potentially
1157 ;;; depend on *DEFAULT-PATHNAME-DEFAULTS*, e.g. to provide a default
1158 ;;; host when parsing a namestring. They are not FLUSHABLE because
1159 ;;; parsing of a PATHNAME-DESIGNATOR might signal an error.)
1161 (defknown wild-pathname-p (pathname-designator
1163 (member nil :host :device
1168 (defknown pathname-match-p (pathname-designator pathname-designator)
1171 (defknown translate-pathname (pathname-designator
1173 pathname-designator &key)
1177 (defknown logical-pathname (pathname-designator) logical-pathname ())
1178 (defknown translate-logical-pathname (pathname-designator &key) pathname
1180 (defknown load-logical-pathname-translations (string) t ())
1181 (defknown logical-pathname-translations (logical-host-designator) list ())
1183 (defknown pathname (pathname-designator) pathname ())
1184 (defknown truename (pathname-designator) pathname ())
1186 (defknown parse-namestring
1187 (pathname-designator &optional
1188 (or list host string (member :unspecific))
1194 (values (or pathname null) sequence-end)
1197 (defknown merge-pathnames
1198 (pathname-designator &optional pathname-designator pathname-version)
1202 (defknown make-pathname
1203 (&key (:defaults pathname-designator)
1204 (:host (or string pathname-host))
1205 (:device (or string pathname-device))
1206 (:directory (or pathname-directory string (member :wild)))
1207 (:name (or pathname-name string (member :wild)))
1208 (:type (or pathname-type string (member :wild)))
1209 (:version pathname-version) (:case (member :local :common)))
1210 pathname (unsafely-flushable))
1212 (defknown pathnamep (t) boolean (movable flushable))
1214 (defknown pathname-host (pathname-designator
1215 &key (:case (member :local :common)))
1216 pathname-host (flushable))
1217 (defknown pathname-device (pathname-designator
1218 &key (:case (member :local :common)))
1219 pathname-device (flushable))
1220 (defknown pathname-directory (pathname-designator
1221 &key (:case (member :local :common)))
1222 pathname-directory (flushable))
1223 (defknown pathname-name (pathname-designator
1224 &key (:case (member :local :common)))
1225 pathname-name (flushable))
1226 (defknown pathname-type (pathname-designator
1227 &key (:case (member :local :common)))
1228 pathname-type (flushable))
1229 (defknown pathname-version (pathname-designator)
1230 pathname-version (flushable))
1232 (defknown (namestring file-namestring directory-namestring host-namestring)
1233 (pathname-designator) (or simple-string null)
1234 (unsafely-flushable))
1236 (defknown enough-namestring (pathname-designator &optional pathname-designator)
1238 (unsafely-flushable))
1240 (defknown user-homedir-pathname (&optional t) pathname (flushable))
1243 (pathname-designator &key
1244 (:direction (member :input :output :io :probe))
1245 (:element-type type-specifier)
1246 (:if-exists (member :error :new-version :rename
1247 :rename-and-delete :overwrite
1248 :append :supersede nil))
1249 (:if-does-not-exist (member :error :create nil))
1250 (:external-format external-format-designator))
1253 (defknown rename-file (pathname-designator filename)
1254 (values pathname pathname pathname))
1255 (defknown delete-file (pathname-designator) t)
1256 (defknown probe-file (pathname-designator) (or pathname null) ())
1257 (defknown file-write-date (pathname-designator) (or unsigned-byte null)
1259 (defknown file-author (pathname-designator) (or simple-string null)
1262 (defknown file-position (stream &optional
1263 (or unsigned-byte (member :start :end)))
1264 (or unsigned-byte (member t nil)))
1265 (defknown file-length (stream) (or unsigned-byte null) (unsafely-flushable))
1268 ((or filename stream)
1272 (:if-does-not-exist t)
1273 (:external-format external-format-designator))
1276 (defknown directory (pathname-designator &key (:resolve-symlinks t))
1279 ;;;; from the "Conditions" chapter:
1281 (defknown error (t &rest t) nil)
1282 (defknown cerror (format-control t &rest t) null)
1283 (defknown invalid-method-error (t format-control &rest t) *) ; FIXME: first arg is METHOD
1284 (defknown method-combination-error (format-control &rest t) *)
1285 (defknown signal (t &rest t) null)
1286 (defknown warn (t &rest t) null)
1287 (defknown invoke-debugger (condition) nil)
1288 (defknown break (&optional format-control &rest t) null)
1289 (defknown make-condition (type-specifier &rest t) condition)
1290 (defknown compute-restarts (&optional (or condition null)) list)
1291 (defknown find-restart (restart-designator &optional (or condition null))
1293 (defknown invoke-restart (restart-designator &rest t) *)
1294 (defknown invoke-restart-interactively (restart-designator) *)
1295 (defknown restart-name (restart) symbol)
1296 (defknown (abort muffle-warning) (&optional (or condition null)) nil)
1297 (defknown continue (&optional (or condition null)) null)
1298 (defknown (store-value use-value) (t &optional (or condition null))
1301 ;;; and analogous SBCL extension:
1302 (defknown sb!impl::%failed-aver (t) nil)
1303 (defknown bug (t &rest t) nil) ; never returns
1306 ;;;; from the "Miscellaneous" Chapter:
1308 (defknown compile ((or symbol cons) &optional (or list function null))
1309 (values (or function symbol cons) boolean boolean))
1311 (defknown compile-file
1312 (pathname-designator
1316 (:output-file (or pathname-designator
1318 ;; FIXME: This last case is a non-ANSI hack.
1322 (:external-format external-format-designator)
1328 (values (or pathname null) boolean boolean))
1330 ;; FIXME: consider making (OR CALLABLE CONS) something like
1331 ;; EXTENDED-FUNCTION-DESIGNATOR
1332 (defknown disassemble ((or callable cons) &key
1333 (:stream stream) (:use-labels t))
1336 (defknown describe (t &optional (or stream (member t nil))) (values))
1337 (defknown inspect (t) (values))
1338 (defknown room (&optional (member t nil :default)) (values))
1339 (defknown ed (&optional (or symbol cons filename))
1341 (defknown dribble (&optional filename &key (:if-exists t)) (values))
1343 (defknown apropos (string-designator &optional package-designator t) (values))
1344 (defknown apropos-list (string-designator &optional package-designator t) list
1347 (defknown get-decoded-time ()
1348 (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1349 (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1352 (defknown get-universal-time () unsigned-byte (flushable))
1354 (defknown decode-universal-time
1355 (unsigned-byte &optional (or null (rational -24 24)))
1356 (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1357 (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1360 (defknown encode-universal-time
1361 ((integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1362 (integer 1 12) unsigned-byte &optional (or null (rational -24 24)))
1366 (defknown (get-internal-run-time get-internal-real-time)
1367 () internal-time (flushable))
1369 (defknown sleep ((or (rational 0) (float 0.0))) null)
1371 ;;; Even though ANSI defines LISP-IMPLEMENTATION-TYPE and
1372 ;;; LISP-IMPLEMENTATION-VERSION to possibly punt and return NIL, we
1373 ;;; know that there's no valid reason for our implementations to ever
1374 ;;; do so, so we can safely guarantee that they'll return strings.
1375 (defknown (lisp-implementation-type lisp-implementation-version)
1376 () simple-string (flushable))
1378 ;;; For any of these functions, meaningful information might not be
1379 ;;; available, so -- unlike the related LISP-IMPLEMENTATION-FOO
1380 ;;; functions -- these really can return NIL.
1381 (defknown (machine-type machine-version machine-instance
1382 software-type software-version
1383 short-site-name long-site-name)
1384 () (or simple-string null) (flushable))
1386 (defknown identity (t) t (movable foldable flushable unsafe)
1387 :derive-type #'result-type-first-arg)
1389 (defknown constantly (t) function (movable flushable))
1390 (defknown complement (function) function (movable flushable))
1392 ;;;; miscellaneous extensions
1394 (defknown symbol-global-value (symbol) t ())
1395 (defknown set-symbol-global-value (symbol t) t ())
1397 (defknown get-bytes-consed () unsigned-byte (flushable))
1398 (defknown mask-signed-field ((integer 0 *) integer) integer
1399 (movable flushable foldable))
1401 (defknown array-storage-vector (array) (simple-array * (*))
1404 ;;;; magical compiler frobs
1406 (defknown %values-list-or-context (t t t) * (always-translatable))
1408 (defknown %unary-truncate/single-float (single-float) integer (movable foldable flushable))
1409 (defknown %unary-truncate/double-float (double-float) integer (movable foldable flushable))
1411 ;;; We can't fold this in general because of SATISFIES. There is a
1412 ;;; special optimizer anyway.
1413 (defknown %typep (t (or type-specifier ctype)) boolean
1414 (movable flushable explicit-check))
1415 (defknown %instance-typep (t (or type-specifier ctype)) boolean
1416 (movable flushable explicit-check always-translatable))
1418 (defknown %cleanup-point () t)
1419 (defknown %special-bind (t t) t)
1420 (defknown %special-unbind (t) t)
1421 (defknown %listify-rest-args (t index) list (flushable))
1422 (defknown %more-arg-context (t t) (values t index) (flushable))
1423 (defknown %more-arg (t index) t)
1424 #!+stack-grows-downward-not-upward
1425 ;;; FIXME: The second argument here should really be NEGATIVE-INDEX, but doing that
1426 ;;; breaks the build, and I cannot seem to figure out why. --NS 2006-06-29
1427 (defknown %more-kw-arg (t fixnum) (values t t))
1428 (defknown %more-arg-values (t index index) * (flushable))
1429 (defknown %verify-arg-count (index index) (values))
1430 (defknown %arg-count-error (t) nil)
1431 (defknown %unknown-values () *)
1432 (defknown %catch (t t) t)
1433 (defknown %unwind-protect (t t) t)
1434 (defknown (%catch-breakup %unwind-protect-breakup) () t)
1435 (defknown %lexical-exit-breakup (t) t)
1436 (defknown %continue-unwind (t t t) nil)
1437 (defknown %throw (t &rest t) nil) ; This is MV-called.
1438 (defknown %nlx-entry (t) *)
1439 (defknown %%primitive (t t &rest t) *)
1440 (defknown %pop-values (t) t)
1441 (defknown %nip-values (t t &rest t) (values))
1442 (defknown %allocate-closures (t) *)
1443 (defknown %type-check-error (t t) nil)
1445 ;; FIXME: This function does not return, but due to the implementation
1446 ;; of FILTER-LVAR we cannot write it here.
1447 (defknown %compile-time-type-error (t t t t) *)
1448 (defknown sb!kernel::case-failure (t t t) nil)
1450 (defknown %odd-key-args-error () nil)
1451 (defknown %unknown-key-arg-error (t) nil)
1452 (defknown (%ldb %mask-field) (bit-index bit-index integer) unsigned-byte
1453 (movable foldable flushable explicit-check))
1454 (defknown (%dpb %deposit-field) (integer bit-index bit-index integer) integer
1455 (movable foldable flushable explicit-check))
1456 (defknown %negate (number) number (movable foldable flushable explicit-check))
1457 (defknown %check-bound (array index fixnum) index (movable foldable flushable))
1458 (defknown data-vector-ref (simple-array index) t
1459 (foldable explicit-check always-translatable))
1460 (defknown data-vector-ref-with-offset (simple-array index fixnum) t
1461 (foldable explicit-check always-translatable))
1462 (defknown data-vector-set (array index t) t
1463 (unsafe explicit-check always-translatable))
1464 (defknown data-vector-set-with-offset (array index fixnum t) t
1465 (unsafe explicit-check always-translatable))
1466 (defknown hairy-data-vector-ref (array index) t
1467 (foldable explicit-check))
1468 (defknown hairy-data-vector-set (array index t) t (unsafe explicit-check))
1469 (defknown hairy-data-vector-ref/check-bounds (array index) t
1470 (foldable explicit-check))
1471 (defknown hairy-data-vector-set/check-bounds (array index t)
1473 (unsafe explicit-check))
1474 (defknown %caller-frame () t (flushable))
1475 (defknown %caller-pc () system-area-pointer (flushable))
1476 (defknown %with-array-data (array index (or index null))
1477 (values (simple-array * (*)) index index index)
1478 (foldable flushable))
1479 (defknown %with-array-data/fp (array index (or index null))
1480 (values (simple-array * (*)) index index index)
1481 (foldable flushable))
1482 (defknown %set-symbol-package (symbol t) t (unsafe))
1483 (defknown %coerce-name-to-fun ((or symbol cons)) function (flushable))
1484 (defknown %coerce-callable-to-fun (callable) function (flushable))
1485 (defknown array-bounding-indices-bad-error (t t t) nil)
1486 (defknown sequence-bounding-indices-bad-error (t t t) nil)
1487 (defknown %find-position
1488 (t sequence t index sequence-end function function)
1489 (values t (or index null))
1491 (defknown (%find-position-if %find-position-if-not)
1492 (function sequence t index sequence-end function)
1493 (values t (or index null))
1495 (defknown effective-find-position-test (callable callable)
1497 (flushable foldable))
1498 (defknown effective-find-position-key (callable)
1500 (flushable foldable))
1502 (defknown %adjoin (t list) list (explicit-check foldable flushable))
1503 (defknown %adjoin-key (t list function) list (explicit-check foldable flushable call))
1504 (defknown %assoc (t list) list (explicit-check foldable flushable))
1505 (defknown %assoc-key (t list function) list (explicit-check foldable flushable call))
1506 (defknown %member (t list) list (explicit-check foldable flushable))
1507 (defknown %member-key (t list function) list (explicit-check foldable flushable call))
1508 (defknown %rassoc (t list) list (explicit-check foldable flushable))
1509 (defknown %rassoc-key (t list function) list (explicit-check foldable flushable call))
1511 (defknown %check-vector-sequence-bounds (vector index sequence-end)
1514 ;;; FIXME: including this information here is probably necessary to
1515 ;;; get efficient compilation of the inline expansion of
1516 ;;; %FIND-POSITION-IF, so it should maybe be in a more
1517 ;;; compiler-friendly package (SB-INT?)
1518 (defknown sb!impl::signal-bounding-indices-bad-error
1519 (sequence index sequence-end)
1520 nil) ; never returns
1523 (defknown arg-count-error (t t t t t t) nil (unsafe))
1527 (defknown %aset (array &rest t) t (unsafe)
1528 :destroyed-constant-args (nth-constant-args 1))
1529 (defknown %set-row-major-aref (array index t) t (unsafe)
1530 :destroyed-constant-args (nth-constant-args 1))
1531 (defknown (%rplaca %rplacd) (cons t) t (unsafe)
1532 :destroyed-constant-args (nth-constant-args 1))
1533 (defknown %put (symbol t t) t (unsafe))
1534 (defknown %setelt (sequence index t) t (unsafe)
1535 :destroyed-constant-args (nth-constant-args 1))
1536 (defknown %svset (simple-vector index t) t (unsafe)
1537 :destroyed-constant-args (nth-constant-args 1))
1538 (defknown %bitset ((array bit) &rest index) bit (unsafe)
1539 :destroyed-constant-args (nth-constant-args 1))
1540 (defknown %sbitset ((simple-array bit) &rest index) bit (unsafe)
1541 :destroyed-constant-args (nth-constant-args 1))
1542 (defknown %charset (string index character) character (unsafe)
1543 :destroyed-constant-args (nth-constant-args 1))
1544 (defknown %scharset (simple-string index character) character (unsafe)
1545 :destroyed-constant-args (nth-constant-args 1))
1546 (defknown %set-symbol-value (symbol t) t (unsafe))
1547 (defknown (setf symbol-function) (function symbol) function (unsafe))
1548 (defknown %set-symbol-plist (symbol list) list (unsafe))
1549 (defknown %setnth (unsigned-byte list t) t (unsafe)
1550 :destroyed-constant-args (nth-constant-args 2))
1551 (defknown %set-fill-pointer (complex-vector index) index
1552 (unsafe explicit-check)
1553 :destroyed-constant-args (nth-constant-args 1))
1555 ;;;; ALIEN and call-out-to-C stuff
1557 ;; Used by WITH-PINNED-OBJECTS
1559 (defknown sb!vm::touch-object (t) (values)
1560 (unsafe always-translatable))
1563 (defknown foreign-symbol-dataref-sap (simple-string)
1565 (movable flushable))
1567 (defknown foreign-symbol-sap (simple-string &optional boolean)
1569 (movable flushable))
1571 (defknown foreign-symbol-address (simple-string &optional boolean)
1572 (values integer boolean)
1573 (movable flushable))
1575 ;;;; miscellaneous internal utilities
1577 (defknown %fun-name (function) t (flushable))
1578 (defknown (setf %fun-name) (t function) t (unsafe))
1580 (defknown policy-quality (policy symbol) policy-quality
1583 (defknown compiler-error (t &rest t) nil ())
1584 (defknown (compiler-warn compiler-style-warn) (t &rest t) (values) ())
1585 (defknown (compiler-notify maybe-compiler-notify) ((or string symbol) &rest t)
1588 (defknown style-warn (t &rest t) null ())
1591 ;;;; memory barriers
1593 (defknown sb!vm:%compiler-barrier () (values) ())
1594 (defknown sb!vm:%memory-barrier () (values) ())
1595 (defknown sb!vm:%read-barrier () (values) ())
1596 (defknown sb!vm:%write-barrier () (values) ())
1597 (defknown sb!vm:%data-dependency-barrier () (values) ())
1601 (defknown %compare-and-swap-svref (simple-vector index t t) t
1603 (defknown %compare-and-swap-instance-ref (instance index t t) t
1605 (defknown %compare-and-swap-symbol-value (symbol t t) t
1607 (defknown spin-loop-hint () (values)
1608 (always-translatable))