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::get2 (symbol t) t (flushable))
166 (defknown sb!impl::get3 (symbol t t) t (flushable))
167 (defknown remprop (symbol t) t)
168 (defknown symbol-plist (symbol) list (flushable))
169 (defknown getf (list t &optional t) t (foldable flushable))
170 (defknown get-properties (list list) (values t t list) (foldable flushable))
171 (defknown symbol-name (symbol) simple-string (movable foldable flushable))
172 (defknown make-symbol (string) symbol (flushable))
173 (defknown %make-symbol (simple-string) symbol (flushable))
174 (defknown copy-symbol (symbol &optional t) symbol (flushable))
175 (defknown gensym (&optional (or string unsigned-byte)) symbol ())
176 (defknown symbol-package (symbol) (or sb!xc:package null) (flushable))
177 (defknown keywordp (t) boolean (flushable)) ; If someone uninterns it...
179 ;;;; from the "Packages" chapter:
181 (defknown gentemp (&optional string package-designator) symbol)
183 (defknown make-package (string-designator &key
187 (:internal-symbols index)
188 (:external-symbols index))
190 (defknown find-package (package-designator) (or sb!xc:package null)
192 (defknown package-name (package-designator) (or simple-string null)
193 (unsafely-flushable))
194 (defknown package-nicknames (package-designator) list (unsafely-flushable))
195 (defknown rename-package (package-designator package-designator &optional list)
197 (defknown package-use-list (package-designator) list (unsafely-flushable))
198 (defknown package-used-by-list (package-designator) list (unsafely-flushable))
199 (defknown package-shadowing-symbols (package-designator) list (unsafely-flushable))
200 (defknown list-all-packages () list (flushable))
201 (defknown intern (string &optional package-designator)
202 (values symbol (member :internal :external :inherited nil))
204 (defknown find-symbol (string &optional package-designator)
205 (values symbol (member :internal :external :inherited nil))
207 (defknown (export import) (symbols-designator &optional package-designator)
209 (defknown unintern (symbol &optional package-designator) boolean)
210 (defknown unexport (symbols-designator &optional package-designator) (eql t))
211 (defknown shadowing-import (symbols-designator &optional package-designator)
213 (defknown shadow ((or symbol character string list) &optional package-designator)
215 (defknown (use-package unuse-package)
216 ((or list package-designator) &optional package-designator) (eql t))
217 (defknown find-all-symbols (string-designator) list (flushable))
219 ;;;; from the "Numbers" chapter:
221 (defknown zerop (number) boolean (movable foldable flushable explicit-check))
222 (defknown (plusp minusp) (real) boolean
223 (movable foldable flushable explicit-check))
224 (defknown (oddp evenp) (integer) boolean
225 (movable foldable flushable explicit-check))
226 (defknown (= /=) (number &rest number) boolean
227 (movable foldable flushable explicit-check))
228 (defknown (< > <= >=) (real &rest real) boolean
229 (movable foldable flushable explicit-check))
230 (defknown (max min) (real &rest real) real
231 (movable foldable flushable explicit-check))
233 (defknown + (&rest number) number
234 (movable foldable flushable explicit-check))
235 (defknown - (number &rest number) number
236 (movable foldable flushable explicit-check))
237 (defknown * (&rest number) number
238 (movable foldable flushable explicit-check))
239 (defknown / (number &rest number) number
240 (movable foldable unsafely-flushable explicit-check))
241 (defknown (1+ 1-) (number) number
242 (movable foldable flushable explicit-check))
244 (defknown conjugate (number) number
245 (movable foldable flushable explicit-check))
247 (defknown gcd (&rest integer) unsigned-byte
248 (movable foldable flushable explicit-check)
249 #|:derive-type 'boolean-result-type|#)
250 (defknown lcm (&rest integer) unsigned-byte
251 (movable foldable flushable explicit-check))
253 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
254 (defknown exp (number) irrational
255 (movable foldable flushable explicit-check recursive)
256 :derive-type #'result-type-float-contagion)
258 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
259 (defknown exp (number) irrational
260 (movable foldable flushable explicit-check recursive))
262 (defknown expt (number number) number
263 (movable foldable flushable explicit-check recursive))
264 (defknown log (number &optional real) irrational
265 (movable foldable flushable explicit-check recursive))
266 (defknown sqrt (number) irrational
267 (movable foldable flushable explicit-check))
268 (defknown isqrt (unsigned-byte) unsigned-byte
269 (movable foldable flushable explicit-check recursive))
271 (defknown (abs phase signum) (number) number
272 (movable foldable flushable explicit-check))
273 (defknown cis (real) (complex float)
274 (movable foldable flushable explicit-check))
276 #+sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
278 (defknown (sin cos) (number)
279 (or (float -1.0 1.0) (complex float))
280 (movable foldable flushable explicit-check recursive)
281 :derive-type #'result-type-float-contagion)
284 (number &optional real) irrational
285 (movable foldable unsafely-flushable explicit-check recursive)
286 :derive-type #'result-type-float-contagion)
288 (defknown (tan sinh cosh tanh asinh)
289 (number) irrational (movable foldable flushable explicit-check recursive)
290 :derive-type #'result-type-float-contagion)
293 #-sb-xc-host ; (See CROSS-FLOAT-INFINITY-KLUDGE.)
295 (defknown (sin cos) (number)
296 (or (float -1.0 1.0) (complex float))
297 (movable foldable flushable explicit-check recursive))
300 (number &optional real) irrational
301 (movable foldable unsafely-flushable explicit-check recursive))
303 (defknown (tan sinh cosh tanh asinh)
304 (number) irrational (movable foldable flushable explicit-check recursive))
307 (defknown (asin acos acosh atanh)
309 (movable foldable flushable explicit-check recursive))
311 (defknown float (real &optional float) float
312 (movable foldable flushable explicit-check))
314 (defknown (rational) (real) rational
315 (movable foldable flushable explicit-check))
317 (defknown (rationalize) (real) rational
318 (movable foldable flushable explicit-check recursive))
320 (defknown (numerator denominator) (rational) integer
321 (movable foldable flushable))
323 (defknown (floor ceiling round)
324 (real &optional real) (values integer real)
325 (movable foldable flushable explicit-check))
328 (real &optional real) (values integer real)
329 (movable foldable flushable explicit-check recursive))
331 (defknown %multiply-high (word word) word
332 (movable foldable flushable))
334 (defknown (%floor %ceiling)
335 (real real) (values integer real)
336 (movable foldable flushable explicit-check))
338 (defknown (mod rem) (real real) real
339 (movable foldable flushable explicit-check))
341 (defknown (ffloor fceiling fround ftruncate)
342 (real &optional real) (values float real)
343 (movable foldable flushable explicit-check))
345 (defknown decode-float (float) (values float float-exponent float)
346 (movable foldable unsafely-flushable explicit-check))
347 (defknown scale-float (float integer) float
348 (movable foldable unsafely-flushable explicit-check))
349 (defknown float-radix (float) float-radix
350 (movable foldable unsafely-flushable))
351 (defknown float-sign (float &optional float) float
352 (movable foldable unsafely-flushable explicit-check))
353 (defknown (float-digits float-precision) (float) float-digits
354 (movable foldable unsafely-flushable explicit-check))
355 (defknown integer-decode-float (float)
356 (values integer float-int-exponent (member -1 1))
357 (movable foldable unsafely-flushable explicit-check))
359 (defknown complex (real &optional real) number
360 (movable foldable flushable explicit-check))
362 (defknown (realpart imagpart) (number) real (movable foldable flushable))
364 (defknown (logior logxor logand logeqv) (&rest integer) integer
365 (movable foldable flushable explicit-check))
367 (defknown (lognand lognor logandc1 logandc2 logorc1 logorc2)
368 (integer integer) integer
369 (movable foldable flushable explicit-check))
371 (defknown boole (boole-code integer integer) integer
372 (movable foldable flushable))
374 (defknown lognot (integer) integer (movable foldable flushable explicit-check))
375 (defknown logtest (integer integer) boolean (movable foldable flushable))
376 (defknown logbitp (unsigned-byte integer) boolean (movable foldable flushable))
377 (defknown ash (integer integer) integer
378 (movable foldable flushable explicit-check))
380 (defknown %ash/right ((or word sb!vm:signed-word) (mod #.sb!vm:n-word-bits))
381 (or word sb!vm:signed-word)
382 (movable foldable flushable always-translatable))
383 (defknown (logcount integer-length) (integer) bit-index
384 (movable foldable flushable explicit-check))
385 ;;; FIXME: According to the ANSI spec, it's legal to use any
386 ;;; nonnegative indices for BYTE arguments, not just BIT-INDEX. It's
387 ;;; hard to come up with useful ways to do this, but it is possible to
388 ;;; come up with *legal* ways to do this, so it would be nice
389 ;;; to fix this so we comply with the spec.
390 (defknown byte (bit-index bit-index) byte-specifier
391 (movable foldable flushable))
392 (defknown (byte-size byte-position) (byte-specifier) bit-index
393 (movable foldable flushable))
394 (defknown ldb (byte-specifier integer) integer (movable foldable flushable))
395 (defknown ldb-test (byte-specifier integer) boolean
396 (movable foldable flushable))
397 (defknown mask-field (byte-specifier integer) integer
398 (movable foldable flushable))
399 (defknown dpb (integer byte-specifier integer) integer
400 (movable foldable flushable))
401 (defknown deposit-field (integer byte-specifier integer) integer
402 (movable foldable flushable))
403 (defknown random ((or (float (0.0)) (integer 1)) &optional random-state)
404 (or (float 0.0) (integer 0))
406 (defknown make-random-state (&optional
407 (or (member nil t) random-state unsigned-byte
408 (simple-array (unsigned-byte 8) (*))
409 (simple-array (unsigned-byte 32) (*))))
410 random-state (flushable))
411 (defknown random-state-p (t) boolean (movable foldable flushable))
413 ;;;; from the "Characters" chapter:
414 (defknown (standard-char-p graphic-char-p alpha-char-p
415 upper-case-p lower-case-p both-case-p alphanumericp)
416 (character) boolean (movable foldable flushable))
418 (defknown digit-char-p (character &optional (integer 2 36))
419 (or (integer 0 35) null) (movable foldable flushable))
421 (defknown (char= char/= char< char> char<= char>= char-equal char-not-equal
422 char-lessp char-greaterp char-not-greaterp char-not-lessp)
423 (character &rest character) boolean (movable foldable flushable))
425 (defknown (two-arg-char-equal
426 two-arg-char-not-equal
428 two-arg-char-not-lessp
429 two-arg-char-greaterp
430 two-arg-char-not-greaterp)
431 (character character) boolean (movable foldable flushable))
433 (defknown char-equal-constant (character character character)
435 (movable foldable flushable explicit-check))
437 (defknown character (t) character (movable foldable unsafely-flushable))
438 (defknown char-code (character) char-code (movable foldable flushable))
439 (defknown (char-upcase char-downcase) (character) character
440 (movable foldable flushable))
441 (defknown digit-char (unsigned-byte &optional (integer 2 36))
442 (or character null) (movable foldable flushable))
443 (defknown char-int (character) char-code (movable foldable flushable))
444 (defknown char-name (character) (or simple-string null)
445 (movable foldable flushable))
446 (defknown name-char (string-designator) (or character null)
447 (movable foldable flushable))
448 (defknown code-char (char-code) character
449 ;; By suppressing constant folding on CODE-CHAR when the
450 ;; cross-compiler is running in the cross-compilation host vanilla
451 ;; ANSI Common Lisp, we can use CODE-CHAR expressions to delay until
452 ;; target Lisp run time the generation of CHARACTERs which aren't
453 ;; STANDARD-CHARACTERs. That way, we don't need to rely on the host
454 ;; Common Lisp being able to handle any characters other than those
455 ;; guaranteed by the ANSI spec.
456 (movable #-sb-xc-host foldable flushable))
458 ;;;; from the "Sequences" chapter:
460 (defknown elt (sequence index) t (foldable unsafely-flushable))
462 (defknown subseq (sequence index &optional sequence-end) consed-sequence
464 :derive-type (sequence-result-nth-arg 1))
466 (defknown copy-seq (sequence) consed-sequence (flushable)
467 :derive-type (sequence-result-nth-arg 1))
469 (defknown length (sequence) index (foldable flushable dx-safe))
471 (defknown reverse (sequence) consed-sequence (flushable)
472 :derive-type (sequence-result-nth-arg 1))
474 (defknown nreverse (sequence) sequence (important-result)
475 :derive-type #'result-type-first-arg
476 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
478 (defknown make-sequence (type-specifier index
480 (:initial-element t))
483 :derive-type (creation-result-type-specifier-nth-arg 1))
485 (defknown concatenate (type-specifier &rest sequence) consed-sequence
487 :derive-type (creation-result-type-specifier-nth-arg 1))
489 (defknown (map %map) (type-specifier callable sequence &rest sequence)
492 ; :DERIVE-TYPE 'TYPE-SPEC-ARG1 ? Nope... (MAP NIL ...) returns NULL, not NIL.
494 (defknown %map-to-list-arity-1 (callable sequence) list (flushable call))
495 (defknown %map-to-simple-vector-arity-1 (callable sequence) simple-vector
498 (defknown map-into (sequence callable &rest sequence)
501 :derive-type #'result-type-first-arg
502 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
504 ;;; returns the result from the predicate...
505 (defknown some (callable sequence &rest sequence) t
506 (foldable unsafely-flushable call))
508 (defknown (every notany notevery) (callable sequence &rest sequence) boolean
509 (foldable unsafely-flushable call))
511 (defknown reduce (callable sequence &rest t &key (:from-end t) (:start index)
512 (:end sequence-end) (:initial-value t) (:key callable))
514 (foldable flushable call))
516 (defknown fill (sequence t &rest t &key
517 (:start index) (:end sequence-end)) sequence
519 :derive-type #'result-type-first-arg
520 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
523 (defknown replace (sequence sequence &rest t &key (:start1 index)
524 (:end1 sequence-end) (:start2 index) (:end2 sequence-end))
526 :derive-type #'result-type-first-arg
527 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
531 (t sequence &rest t &key (:from-end t) (:test callable)
532 (:test-not callable) (:start index) (:end sequence-end)
533 (:count sequence-count) (:key callable))
536 :derive-type (sequence-result-nth-arg 2))
539 (t t sequence &rest t &key (:from-end t) (:test callable)
540 (:test-not callable) (:start index) (:end sequence-end)
541 (:count sequence-count) (:key callable))
544 :derive-type (sequence-result-nth-arg 3))
546 (defknown (remove-if remove-if-not)
547 (callable sequence &rest t &key (:from-end t) (:start index)
548 (:end sequence-end) (:count sequence-count) (:key callable))
551 :derive-type (sequence-result-nth-arg 2))
553 (defknown (substitute-if substitute-if-not)
554 (t callable sequence &rest t &key (:from-end t) (:start index)
555 (:end sequence-end) (:count sequence-count) (:key callable))
558 :derive-type (sequence-result-nth-arg 3))
561 (t sequence &rest t &key (:from-end t) (:test callable)
562 (:test-not callable) (:start index) (:end sequence-end)
563 (:count sequence-count) (:key callable))
565 (flushable call important-result)
566 :derive-type (sequence-result-nth-arg 2)
567 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
569 (defknown nsubstitute
570 (t t sequence &rest t &key (:from-end t) (:test callable)
571 (:test-not callable) (:start index) (:end sequence-end)
572 (:count sequence-count) (:key callable))
575 :derive-type (sequence-result-nth-arg 3)
576 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
578 (defknown (delete-if delete-if-not)
579 (callable sequence &rest t &key (:from-end t) (:start index)
580 (:end sequence-end) (:count sequence-count) (:key callable))
582 (flushable call important-result)
583 :derive-type (sequence-result-nth-arg 2)
584 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
586 (defknown (nsubstitute-if nsubstitute-if-not)
587 (t callable sequence &rest t &key (:from-end t) (:start index)
588 (:end sequence-end) (:count sequence-count) (:key callable))
591 :derive-type (sequence-result-nth-arg 3)
592 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
594 (defknown remove-duplicates
595 (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
596 (:from-end t) (:end sequence-end) (:key callable))
598 (unsafely-flushable call)
599 :derive-type (sequence-result-nth-arg 1))
601 (defknown delete-duplicates
602 (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
603 (:from-end t) (:end sequence-end) (:key callable))
605 (unsafely-flushable call important-result)
606 :derive-type (sequence-result-nth-arg 1)
607 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
609 (defknown find (t sequence &rest t &key (:test callable)
610 (:test-not callable) (:start index) (:from-end t)
611 (:end sequence-end) (:key callable))
613 (foldable flushable call))
615 (defknown (find-if find-if-not)
616 (callable sequence &rest t &key (:from-end t) (:start index)
617 (:end sequence-end) (:key callable))
619 (foldable flushable call))
621 (defknown position (t sequence &rest t &key (:test callable)
622 (:test-not callable) (:start index) (:from-end t)
623 (:end sequence-end) (:key callable))
625 (foldable flushable call))
627 (defknown (position-if position-if-not)
628 (callable sequence &rest t &key (:from-end t) (:start index)
629 (:end sequence-end) (:key callable))
631 (foldable flushable call))
633 (defknown count (t sequence &rest t &key
634 (:test callable) (:test-not callable) (:start index)
635 (:from-end t) (:end sequence-end) (:key callable))
637 (foldable flushable call))
639 (defknown (count-if count-if-not)
640 (callable sequence &rest t &key
641 (:from-end t) (:start index) (:end sequence-end) (:key callable))
643 (foldable flushable call))
645 (defknown (mismatch search)
646 (sequence sequence &rest t &key (:from-end t) (:test callable)
647 (:test-not callable) (:start1 index) (:end1 sequence-end)
648 (:start2 index) (:end2 sequence-end) (:key callable))
650 (foldable flushable call))
652 ;;; not FLUSHABLE, since vector sort guaranteed in-place...
653 (defknown (stable-sort sort) (sequence callable &rest t &key (:key callable))
656 :derive-type (sequence-result-nth-arg 1)
657 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
658 (defknown sb!impl::stable-sort-list (list function function) list
659 (call important-result)
660 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
661 (defknown sb!impl::sort-vector (vector index index function (or function null))
662 * ; SORT-VECTOR works through side-effect
664 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
666 (defknown merge (type-specifier sequence sequence callable
667 &key (:key callable))
669 (call important-result)
670 :derive-type (creation-result-type-specifier-nth-arg 1)
671 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2 3))
673 (defknown read-sequence (sequence stream
680 (defknown write-sequence (sequence stream
686 :derive-type #'result-type-first-arg)
688 ;;;; from the "Manipulating List Structure" chapter:
689 (defknown (car cdr first rest)
692 (foldable flushable))
694 ;; Correct argument type restrictions for these functions are
695 ;; complicated, so we just declare them to accept LISTs and suppress
696 ;; flushing is safe code.
697 (defknown (caar cadr cdar cddr
698 caaar caadr cadar caddr cdaar cdadr cddar cdddr
699 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
700 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
701 second third fourth fifth sixth seventh eighth ninth tenth)
704 (foldable unsafely-flushable))
706 (defknown cons (t t) cons (movable flushable))
708 (defknown tree-equal (t t &key (:test callable) (:test-not callable)) boolean
709 (foldable flushable call))
710 (defknown endp (list) boolean (foldable flushable movable))
711 (defknown list-length (list) (or index null) (foldable unsafely-flushable))
712 (defknown nth (unsigned-byte list) t (foldable flushable))
713 (defknown nthcdr (unsigned-byte list) t (foldable unsafely-flushable))
715 (defknown last (list &optional unsigned-byte) t (foldable flushable))
716 (defknown %last0 (list) t (foldable flushable))
717 (defknown %last1 (list) t (foldable flushable))
718 (defknown %lastn/fixnum (list (and unsigned-byte fixnum)) t (foldable flushable))
719 (defknown %lastn/bignum (list (and unsigned-byte bignum)) t (foldable flushable))
721 (defknown list (&rest t) list (movable flushable))
722 (defknown list* (t &rest t) t (movable flushable))
723 (defknown make-list (index &key (:initial-element t)) list
726 (defknown sb!impl::backq-list (&rest t) list (movable flushable))
727 (defknown sb!impl::backq-list* (t &rest t) t (movable flushable))
728 (defknown sb!impl::backq-append (&rest t) t (flushable))
729 (defknown sb!impl::backq-nconc (&rest t) t ()
730 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
731 (defknown sb!impl::backq-cons (t t) cons (foldable movable flushable))
732 (defknown sb!impl::backq-vector (list) simple-vector
733 (foldable movable flushable))
735 ;;; All but last must be of type LIST, but there seems to be no way to
736 ;;; express that in this syntax.
737 (defknown append (&rest t) t (flushable))
738 (defknown sb!impl::append2 (list t) t (flushable))
740 (defknown copy-list (list) list (flushable))
741 (defknown copy-alist (list) list (flushable))
742 (defknown copy-tree (t) t (flushable recursive))
743 (defknown revappend (list t) t (flushable))
745 ;;; All but last must be of type LIST, but there seems to be no way to
746 ;;; express that in this syntax. The result must be LIST, but we do
747 ;;; not check it now :-).
748 (defknown nconc (&rest t) t ()
749 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
750 (defknown sb!impl::nconc2 (list t) t ()
751 :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
753 (defknown nreconc (list t) t (important-result)
754 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
755 (defknown butlast (list &optional unsigned-byte) list (flushable))
756 (defknown nbutlast (list &optional unsigned-byte) list ()
757 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
759 (defknown ldiff (list t) list (flushable))
760 (defknown (rplaca rplacd) (cons t) cons ()
761 :destroyed-constant-args (nth-constant-args 1))
763 (defknown subst (t t t &key (:key callable) (:test callable)
764 (:test-not callable))
766 (defknown nsubst (t t t &key (:key callable) (:test callable)
767 (:test-not callable))
769 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
771 (defknown (subst-if subst-if-not)
772 (t callable t &key (:key callable))
774 (defknown (nsubst-if nsubst-if-not)
775 (t callable t &key (:key callable))
777 :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
779 (defknown sublis (list t &key (:key callable) (:test callable)
780 (:test-not callable))
782 (defknown nsublis (list t &key (:key callable) (:test callable)
783 (:test-not callable))
785 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
787 (defknown member (t list &key (:key callable) (:test callable)
788 (:test-not callable))
789 list (foldable flushable call))
790 (defknown (member-if member-if-not) (callable list &key (:key callable))
791 list (foldable flushable call))
793 (defknown tailp (t list) boolean (foldable flushable))
795 (defknown adjoin (t list &key (:key callable) (:test callable)
796 (:test-not callable))
797 cons (flushable call))
799 (defknown (union intersection set-difference set-exclusive-or)
800 (list list &key (:key callable) (:test callable) (:test-not callable))
802 (foldable flushable call))
804 (defknown (nunion nintersection nset-difference nset-exclusive-or)
805 (list list &key (:key callable) (:test callable) (:test-not callable))
807 (foldable flushable call important-result)
808 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1 2))
811 (list list &key (:key callable) (:test callable) (:test-not callable))
813 (foldable flushable call))
815 (defknown acons (t t t) cons (movable flushable))
816 (defknown pairlis (t t &optional t) list (flushable))
818 (defknown (rassoc assoc)
819 (t list &key (:key callable) (:test callable) (:test-not callable))
820 list (foldable flushable call))
821 (defknown (assoc-if-not assoc-if rassoc-if rassoc-if-not)
822 (callable list &key (:key callable)) list (foldable flushable call))
824 (defknown (memq assq) (t list) list (foldable flushable))
825 (defknown delq (t list) list (flushable)
826 :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
828 ;;;; from the "Hash Tables" chapter:
830 (defknown make-hash-table
831 (&key (:test callable) (:size unsigned-byte)
832 (:rehash-size (or (integer 1) (float (1.0))))
833 (:rehash-threshold (real 0 1))
834 (:hash-function (or null callable))
835 (:weakness (member nil :key :value :key-and-value :key-or-value))
839 (defknown hash-table-p (t) boolean (movable foldable flushable))
840 (defknown gethash (t hash-table &optional t) (values t boolean)
841 (flushable)) ; not FOLDABLE, since hash table contents can change
842 (defknown sb!impl::gethash2 (t hash-table) (values t boolean)
843 (flushable)) ; not FOLDABLE, since hash table contents can change
844 (defknown sb!impl::gethash3 (t hash-table t) (values t boolean)
845 (flushable)) ; not FOLDABLE, since hash table contents can change
846 (defknown %puthash (t hash-table t) t ()
847 :destroyed-constant-args (nth-constant-args 2)
848 :derive-type #'result-type-last-arg)
849 (defknown remhash (t hash-table) boolean ()
850 :destroyed-constant-args (nth-constant-args 2))
851 (defknown maphash (callable hash-table) null (flushable call))
852 (defknown clrhash (hash-table) hash-table ()
853 :destroyed-constant-args (nth-constant-args 2))
854 (defknown hash-table-count (hash-table) index (flushable))
855 (defknown hash-table-rehash-size (hash-table) (or index (single-float (1.0)))
856 (foldable flushable))
857 (defknown hash-table-rehash-threshold (hash-table) (single-float (0.0) 1.0)
858 (foldable flushable))
859 (defknown hash-table-size (hash-table) index (flushable))
860 (defknown hash-table-test (hash-table) symbol (foldable flushable))
861 (defknown sxhash (t) hash (#-sb-xc-host foldable flushable))
862 (defknown psxhash (t &optional t) hash (#-sb-xc-host foldable flushable))
863 (defknown hash-table-equalp (hash-table hash-table) boolean (foldable flushable))
865 ;;;; from the "Arrays" chapter
867 (defknown make-array ((or index list)
869 (:element-type type-specifier)
871 (:initial-contents t)
874 (:displaced-to (or array null))
875 (:displaced-index-offset index))
878 (defknown vector (&rest t) simple-vector (flushable))
880 (defknown aref (array &rest index) t (foldable))
881 (defknown row-major-aref (array index) t (foldable))
883 (defknown array-element-type (array)
885 (foldable flushable recursive))
886 (defknown array-rank (array) array-rank (foldable flushable))
887 (defknown array-dimension (array array-rank) index (foldable flushable))
888 (defknown array-dimensions (array) list (foldable flushable))
889 (defknown array-in-bounds-p (array &rest integer) boolean (foldable flushable))
890 (defknown array-row-major-index (array &rest index) array-total-size
891 (foldable flushable))
892 (defknown array-total-size (array) array-total-size (foldable flushable))
893 (defknown adjustable-array-p (array) boolean (movable foldable flushable))
895 (defknown svref (simple-vector index) t (foldable flushable))
896 (defknown bit ((array bit) &rest index) bit (foldable flushable))
897 (defknown sbit ((simple-array bit) &rest index) bit (foldable flushable))
899 ;;; FIXME: :DESTROYED-CONSTANT-ARGS for these is complicated.
900 (defknown (bit-and bit-ior bit-xor bit-eqv bit-nand bit-nor bit-andc1 bit-andc2
902 ((array bit) (array bit) &optional (or (array bit) (member t nil)))
905 #|:derive-type #'result-type-last-arg|#)
907 (defknown bit-not ((array bit) &optional (or (array bit) (member t nil)))
910 #|:derive-type #'result-type-last-arg|#)
912 (defknown bit-vector-= (bit-vector bit-vector) boolean
913 (movable foldable flushable))
915 (defknown array-has-fill-pointer-p (array) boolean
916 (movable foldable flushable))
917 (defknown fill-pointer (complex-vector) index
918 (unsafely-flushable explicit-check))
919 (defknown vector-push (t complex-vector) (or index null)
921 :destroyed-constant-args (nth-constant-args 2))
922 (defknown vector-push-extend (t complex-vector &optional (and index (integer 1))) index
924 :destroyed-constant-args (nth-constant-args 2))
925 (defknown vector-pop (complex-vector) t
927 :destroyed-constant-args (nth-constant-args 1))
929 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
930 ;;; Also, an important-result warning could be provided if the array
931 ;;; is known to be not expressly adjustable.
932 (defknown adjust-array
933 (array (or index list) &key (:element-type type-specifier)
934 (:initial-element t) (:initial-contents t)
935 (:fill-pointer t) (:displaced-to (or array null))
936 (:displaced-index-offset index))
938 ; :derive-type 'result-type-arg1) Not even close...
940 ;;;; from the "Strings" chapter:
942 (defknown char (string index) character (foldable flushable))
943 (defknown schar (simple-string index) character (foldable flushable))
945 (defknown (string= string-equal)
946 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
947 (:start2 index) (:end2 sequence-end))
949 (foldable flushable))
951 (defknown (string< string> string<= string>= string/= string-lessp
952 string-greaterp string-not-lessp string-not-greaterp
954 (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
955 (:start2 index) (:end2 sequence-end))
957 (foldable flushable))
959 (defknown make-string (index &key (:element-type type-specifier)
960 (:initial-element character))
961 simple-string (flushable))
963 (defknown (string-trim string-left-trim string-right-trim)
964 (sequence string-designator) string (flushable))
966 (defknown (string-upcase string-downcase string-capitalize)
967 (string-designator &key (:start index) (:end sequence-end))
968 simple-string (flushable))
970 (defknown (nstring-upcase nstring-downcase nstring-capitalize)
971 (string &key (:start index) (:end sequence-end))
973 :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
975 (defknown string (string-designator) string
976 (flushable explicit-check))
978 ;;;; internal non-keyword versions of string predicates:
980 (defknown (string<* string>* string<=* string>=* string/=*)
981 (string-designator string-designator index sequence-end index sequence-end)
983 (foldable flushable))
986 (string-designator string-designator index sequence-end index sequence-end)
988 (foldable flushable))
990 ;;;; from the "Eval" chapter:
992 (defknown eval (t) * (recursive))
993 (defknown constantp (t &optional lexenv-designator) boolean
994 (foldable flushable))
996 ;;;; from the "Streams" chapter:
998 (defknown make-synonym-stream (symbol) stream (flushable))
999 (defknown make-broadcast-stream (&rest stream) stream (unsafely-flushable))
1000 (defknown make-concatenated-stream (&rest stream) stream (unsafely-flushable))
1001 (defknown make-two-way-stream (stream stream) stream (unsafely-flushable))
1002 (defknown make-echo-stream (stream stream) stream (flushable))
1003 (defknown make-string-input-stream (string &optional index sequence-end)
1006 (defknown make-string-output-stream
1007 (&key (:element-type type-specifier))
1008 string-output-stream
1010 (defknown get-output-stream-string (stream) simple-string ())
1011 (defknown streamp (t) boolean (movable foldable flushable))
1012 (defknown stream-element-type (stream) type-specifier
1013 (movable foldable flushable))
1014 (defknown (output-stream-p input-stream-p) (stream) boolean
1015 (movable foldable flushable))
1016 (defknown close (stream &key (:abort t)) (eql t) ())
1018 ;;;; from the "Input/Output" chapter:
1020 ;;; (The I/O functions are given effects ANY under the theory that
1021 ;;; code motion over I/O operations is particularly confusing and not
1022 ;;; very important for efficiency.)
1024 (defknown copy-readtable (&optional (or readtable null) (or readtable null))
1027 (defknown readtablep (t) boolean (movable foldable flushable))
1029 (defknown set-syntax-from-char
1030 (character character &optional readtable (or readtable null)) (eql t)
1033 (defknown set-macro-character (character callable &optional t (or readtable null))
1036 (defknown get-macro-character (character &optional (or readtable null))
1037 (values callable boolean) (flushable))
1039 (defknown make-dispatch-macro-character (character &optional t readtable)
1041 (defknown set-dispatch-macro-character
1042 (character character callable &optional (or readtable null)) (eql t)
1044 (defknown get-dispatch-macro-character
1045 (character character &optional (or readtable null)) (or callable null)
1048 (defknown copy-pprint-dispatch
1049 (&optional (or sb!pretty:pprint-dispatch-table null))
1050 sb!pretty:pprint-dispatch-table
1052 (defknown pprint-dispatch
1053 (t &optional (or sb!pretty:pprint-dispatch-table null))
1054 (values callable boolean)
1056 (defknown (pprint-fill pprint-linear)
1057 (stream-designator t &optional t t)
1060 (defknown pprint-tabular
1061 (stream-designator t &optional t t unsigned-byte)
1064 (defknown pprint-indent
1065 ((member :block :current) real &optional stream-designator)
1068 (defknown pprint-newline
1069 ((member :linear :fill :miser :mandatory) &optional stream-designator)
1072 (defknown pprint-tab
1073 ((member :line :section :line-relative :section-relative)
1074 unsigned-byte unsigned-byte &optional stream-designator)
1077 (defknown set-pprint-dispatch
1078 (type-specifier (or null callable)
1079 &optional real sb!pretty:pprint-dispatch-table)
1083 ;;; may return any type due to eof-value...
1084 (defknown (read read-preserving-whitespace read-char-no-hang read-char)
1085 (&optional stream-designator t t t) t (explicit-check))
1087 (defknown read-delimited-list (character &optional stream-designator t) list
1089 (defknown read-line (&optional stream-designator t t t) (values t boolean)
1091 (defknown unread-char (character &optional stream-designator) t
1093 (defknown peek-char (&optional (or character (member nil t))
1094 stream-designator t t t)
1097 (defknown listen (&optional stream-designator) boolean (flushable explicit-check))
1099 (defknown clear-input (&optional stream-designator) null (explicit-check))
1101 (defknown read-from-string
1102 (string &optional t t
1106 (:preserve-whitespace t))
1108 (defknown parse-integer
1112 (:radix (integer 2 36))
1114 (values (or integer null ()) index))
1116 (defknown read-byte (stream &optional t t) t (explicit-check))
1120 (:stream stream-designator)
1123 (:base (integer 2 36))
1126 (:level (or unsigned-byte null))
1128 (:length (or unsigned-byte null))
1132 (:lines (or unsigned-byte null))
1133 (:right-margin (or unsigned-byte null))
1134 (:miser-width (or unsigned-byte null))
1135 (:pprint-dispatch t)
1136 (:suppress-errors t))
1138 (any explicit-check)
1139 :derive-type #'result-type-first-arg)
1141 (defknown (prin1 print princ) (t &optional stream-designator)
1143 (any explicit-check)
1144 :derive-type #'result-type-first-arg)
1146 ;;; xxx-TO-STRING functions are not foldable because they depend on
1147 ;;; the dynamic environment, the state of the pretty printer dispatch
1148 ;;; table, and probably other run-time factors.
1149 (defknown write-to-string
1150 (t &key (:escape t) (:radix t) (:base (integer 2 36)) (:readably t)
1151 (:circle t) (:pretty t) (:level (or unsigned-byte null))
1152 (:length (or unsigned-byte null)) (:case t) (:array t) (:gensym t)
1153 (:lines (or unsigned-byte null)) (:right-margin (or unsigned-byte null))
1154 (:miser-width (or unsigned-byte null)) (:pprint-dispatch t))
1156 (flushable explicit-check))
1158 (defknown (prin1-to-string princ-to-string) (t) simple-string (flushable))
1160 (defknown write-char (character &optional stream-designator) character
1162 :derive-type #'result-type-first-arg)
1164 (defknown (write-string write-line)
1165 (string &optional stream-designator &key (:start index) (:end sequence-end))
1168 :derive-type #'result-type-first-arg)
1170 (defknown (terpri finish-output force-output clear-output)
1171 (&optional stream-designator) null
1174 (defknown fresh-line (&optional stream-designator) boolean
1177 (defknown write-byte (integer stream) integer
1179 :derive-type #'result-type-first-arg)
1181 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
1182 (defknown format ((or (member nil t) stream string)
1183 (or string function) &rest t)
1187 (defknown (y-or-n-p yes-or-no-p) (&optional string &rest t) boolean
1190 ;;;; from the "File System Interface" chapter:
1192 ;;; (No pathname functions are FOLDABLE because they all potentially
1193 ;;; depend on *DEFAULT-PATHNAME-DEFAULTS*, e.g. to provide a default
1194 ;;; host when parsing a namestring. They are not FLUSHABLE because
1195 ;;; parsing of a PATHNAME-DESIGNATOR might signal an error.)
1197 (defknown wild-pathname-p (pathname-designator
1199 (member nil :host :device
1205 (defknown pathname-match-p (pathname-designator pathname-designator)
1209 (defknown translate-pathname (pathname-designator
1211 pathname-designator &key)
1215 (defknown logical-pathname (pathname-designator) logical-pathname ())
1216 (defknown translate-logical-pathname (pathname-designator &key) pathname
1218 (defknown load-logical-pathname-translations (string) t ())
1219 (defknown logical-pathname-translations (logical-host-designator) list ())
1221 (defknown pathname (pathname-designator) pathname ())
1222 (defknown truename (pathname-designator) pathname ())
1224 (defknown parse-namestring
1225 (pathname-designator &optional
1226 (or list host string (member :unspecific))
1232 (values (or pathname null) sequence-end)
1235 (defknown merge-pathnames
1236 (pathname-designator &optional pathname-designator pathname-version)
1240 (defknown make-pathname
1241 (&key (:defaults pathname-designator)
1242 (:host (or string pathname-host))
1243 (:device (or string pathname-device))
1244 (:directory (or pathname-directory string (member :wild)))
1245 (:name (or pathname-name string (member :wild)))
1246 (:type (or pathname-type string (member :wild)))
1247 (:version pathname-version) (:case (member :local :common)))
1248 pathname (unsafely-flushable))
1250 (defknown pathnamep (t) boolean (movable flushable))
1252 (defknown pathname-host (pathname-designator
1253 &key (:case (member :local :common)))
1254 pathname-host (flushable))
1255 (defknown pathname-device (pathname-designator
1256 &key (:case (member :local :common)))
1257 pathname-device (flushable))
1258 (defknown pathname-directory (pathname-designator
1259 &key (:case (member :local :common)))
1260 pathname-directory (flushable))
1261 (defknown pathname-name (pathname-designator
1262 &key (:case (member :local :common)))
1263 pathname-name (flushable))
1264 (defknown pathname-type (pathname-designator
1265 &key (:case (member :local :common)))
1266 pathname-type (flushable))
1267 (defknown pathname-version (pathname-designator)
1268 pathname-version (flushable))
1270 (defknown pathname= (pathname pathname) boolean (movable foldable flushable))
1272 (defknown (namestring file-namestring directory-namestring host-namestring)
1273 (pathname-designator) (or simple-string null)
1274 (unsafely-flushable))
1276 (defknown enough-namestring (pathname-designator &optional pathname-designator)
1278 (unsafely-flushable))
1280 (defknown user-homedir-pathname (&optional t) pathname (flushable))
1283 (pathname-designator &key
1284 (:direction (member :input :output :io :probe))
1285 (:element-type type-specifier)
1286 (:if-exists (member :error :new-version :rename
1287 :rename-and-delete :overwrite
1288 :append :supersede nil))
1289 (:if-does-not-exist (member :error :create nil))
1290 (:external-format external-format-designator))
1293 (defknown rename-file (pathname-designator filename)
1294 (values pathname pathname pathname))
1295 (defknown delete-file (pathname-designator) (eql t))
1296 (defknown probe-file (pathname-designator) (or pathname null) ())
1297 (defknown file-write-date (pathname-designator) (or unsigned-byte null)
1299 (defknown file-author (pathname-designator) (or simple-string null)
1302 (defknown file-position (stream &optional
1303 (or unsigned-byte (member :start :end)))
1304 (or unsigned-byte (member t nil)))
1305 (defknown file-length (stream) (or unsigned-byte null) (unsafely-flushable))
1308 ((or filename stream)
1312 (:if-does-not-exist t)
1313 (:external-format external-format-designator))
1316 (defknown directory (pathname-designator &key (:resolve-symlinks t))
1319 ;;;; from the "Conditions" chapter:
1321 (defknown error (t &rest t) nil)
1322 (defknown cerror (format-control t &rest t) null)
1323 (defknown invalid-method-error (t format-control &rest t) *) ; FIXME: first arg is METHOD
1324 (defknown method-combination-error (format-control &rest t) *)
1325 (defknown signal (t &rest t) null)
1326 (defknown warn (t &rest t) null)
1327 (defknown invoke-debugger (condition) nil)
1328 (defknown break (&optional format-control &rest t) null)
1329 (defknown make-condition (type-specifier &rest t) condition)
1330 (defknown compute-restarts (&optional (or condition null)) list)
1331 (defknown find-restart (restart-designator &optional (or condition null))
1333 (defknown invoke-restart (restart-designator &rest t) *)
1334 (defknown invoke-restart-interactively (restart-designator) *)
1335 (defknown restart-name (restart) symbol)
1336 (defknown (abort muffle-warning) (&optional (or condition null)) nil)
1337 (defknown continue (&optional (or condition null)) null)
1338 (defknown (store-value use-value) (t &optional (or condition null))
1341 ;;; and analogous SBCL extension:
1342 (defknown sb!impl::%failed-aver (t) nil)
1343 (defknown bug (t &rest t) nil) ; never returns
1346 ;;;; from the "Miscellaneous" Chapter:
1348 (defknown compile ((or symbol cons) &optional (or list function null))
1349 (values (or function symbol cons) boolean boolean))
1351 (defknown compile-file
1352 (pathname-designator
1356 (:output-file (or pathname-designator
1358 ;; FIXME: This last case is a non-ANSI hack.
1362 (:external-format external-format-designator)
1368 (values (or pathname null) boolean boolean))
1370 ;; FIXME: consider making (OR CALLABLE CONS) something like
1371 ;; EXTENDED-FUNCTION-DESIGNATOR
1372 (defknown disassemble ((or callable cons) &key
1373 (:stream stream) (:use-labels t))
1376 (defknown describe (t &optional (or stream (member t nil))) (values))
1377 (defknown inspect (t) (values))
1378 (defknown room (&optional (member t nil :default)) (values))
1379 (defknown ed (&optional (or symbol cons filename))
1381 (defknown dribble (&optional filename &key (:if-exists t)) (values))
1383 (defknown apropos (string-designator &optional package-designator t) (values))
1384 (defknown apropos-list (string-designator &optional package-designator t) list
1385 (flushable recursive))
1387 (defknown get-decoded-time ()
1388 (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1389 (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1392 (defknown get-universal-time () unsigned-byte (flushable))
1394 (defknown decode-universal-time
1395 (unsigned-byte &optional (or null (rational -24 24)))
1396 (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1397 (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1400 (defknown encode-universal-time
1401 ((integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1402 (integer 1 12) unsigned-byte &optional (or null (rational -24 24)))
1406 (defknown (get-internal-run-time get-internal-real-time)
1407 () internal-time (flushable))
1409 (defknown sleep ((real 0)) null (explicit-check))
1411 ;;; Even though ANSI defines LISP-IMPLEMENTATION-TYPE and
1412 ;;; LISP-IMPLEMENTATION-VERSION to possibly punt and return NIL, we
1413 ;;; know that there's no valid reason for our implementations to ever
1414 ;;; do so, so we can safely guarantee that they'll return strings.
1415 (defknown (lisp-implementation-type lisp-implementation-version)
1416 () simple-string (flushable))
1418 ;;; For any of these functions, meaningful information might not be
1419 ;;; available, so -- unlike the related LISP-IMPLEMENTATION-FOO
1420 ;;; functions -- these really can return NIL.
1421 (defknown (machine-type machine-version machine-instance
1422 software-type software-version
1423 short-site-name long-site-name)
1424 () (or simple-string null) (flushable))
1426 (defknown identity (t) t (movable foldable flushable)
1427 :derive-type #'result-type-first-arg)
1429 (defknown constantly (t) function (movable flushable))
1430 (defknown complement (function) function (movable flushable))
1432 ;;;; miscellaneous extensions
1434 (defknown symbol-global-value (symbol) t ())
1435 (defknown set-symbol-global-value (symbol t) t ()
1436 :derive-type #'result-type-last-arg)
1438 (defknown get-bytes-consed () unsigned-byte (flushable))
1439 (defknown mask-signed-field ((integer 0 *) integer) integer
1440 (movable flushable foldable))
1442 (defknown array-storage-vector (array) (simple-array * (*))
1445 ;;;; magical compiler frobs
1447 (defknown %rest-values (t t t) * (always-translatable))
1448 (defknown %rest-ref (t t t t) * (always-translatable))
1449 (defknown %rest-length (t t t) * (always-translatable))
1450 (defknown %rest-null (t t t t) * (always-translatable))
1451 (defknown %rest-true (t t t) * (always-translatable))
1453 (defknown %unary-truncate/single-float (single-float) integer (movable foldable flushable))
1454 (defknown %unary-truncate/double-float (double-float) integer (movable foldable flushable))
1456 ;;; We can't fold this in general because of SATISFIES. There is a
1457 ;;; special optimizer anyway.
1458 (defknown %typep (t (or type-specifier ctype)) boolean
1459 (movable flushable explicit-check))
1460 (defknown %instance-typep (t (or type-specifier ctype)) boolean
1461 (movable flushable explicit-check always-translatable))
1463 (defknown %cleanup-point () t)
1464 (defknown %special-bind (t t) t)
1465 (defknown %special-unbind (t) t)
1466 (defknown %listify-rest-args (t index) list (flushable))
1467 (defknown %more-arg-context (t t) (values t index) (flushable))
1468 (defknown %more-arg (t index) t)
1469 #!+stack-grows-downward-not-upward
1470 ;;; FIXME: The second argument here should really be NEGATIVE-INDEX, but doing that
1471 ;;; breaks the build, and I cannot seem to figure out why. --NS 2006-06-29
1472 (defknown %more-kw-arg (t fixnum) (values t t))
1473 (defknown %more-arg-values (t index index) * (flushable))
1474 (defknown %verify-arg-count (index index) (values))
1475 (defknown %arg-count-error (t) nil)
1476 (defknown %unknown-values () *)
1477 (defknown %catch (t t) t)
1478 (defknown %unwind-protect (t t) t)
1479 (defknown (%catch-breakup %unwind-protect-breakup) () t)
1480 (defknown %lexical-exit-breakup (t) t)
1481 (defknown %continue-unwind (t t t) nil)
1482 (defknown %throw (t &rest t) nil) ; This is MV-called.
1483 (defknown %nlx-entry (t) *)
1484 (defknown %%primitive (t t &rest t) *)
1485 (defknown %pop-values (t) t)
1486 (defknown %nip-values (t t &rest t) (values))
1487 (defknown %allocate-closures (t) *)
1488 (defknown %type-check-error (t t) nil)
1490 ;; FIXME: This function does not return, but due to the implementation
1491 ;; of FILTER-LVAR we cannot write it here.
1492 (defknown %compile-time-type-error (t t t t) *)
1493 (defknown sb!kernel::case-failure (t t t) nil)
1495 (defknown %odd-key-args-error () nil)
1496 (defknown %unknown-key-arg-error (t) nil)
1497 (defknown (%ldb %mask-field) (bit-index bit-index integer) unsigned-byte
1498 (movable foldable flushable explicit-check))
1499 (defknown (%dpb %deposit-field) (integer bit-index bit-index integer) integer
1500 (movable foldable flushable explicit-check))
1501 (defknown %negate (number) number (movable foldable flushable explicit-check))
1502 (defknown %check-bound (array index fixnum) index
1503 (movable foldable flushable dx-safe))
1504 (defknown data-vector-ref (simple-array index) t
1505 (foldable unsafely-flushable explicit-check always-translatable))
1506 (defknown data-vector-ref-with-offset (simple-array fixnum fixnum) t
1507 (foldable unsafely-flushable explicit-check always-translatable))
1508 (defknown data-vector-set (array index t) t
1509 (explicit-check always-translatable))
1510 (defknown data-vector-set-with-offset (array fixnum fixnum t) t
1511 (explicit-check always-translatable))
1512 (defknown hairy-data-vector-ref (array index) t
1513 (foldable explicit-check))
1514 (defknown hairy-data-vector-set (array index t) t (explicit-check))
1515 (defknown hairy-data-vector-ref/check-bounds (array index) t
1516 (foldable explicit-check))
1517 (defknown hairy-data-vector-set/check-bounds (array index t)
1520 (defknown %caller-frame () t (flushable))
1521 (defknown %caller-pc () system-area-pointer (flushable))
1522 (defknown %with-array-data (array index (or index null))
1523 (values (simple-array * (*)) index index index)
1524 (foldable flushable))
1525 (defknown %with-array-data/fp (array index (or index null))
1526 (values (simple-array * (*)) index index index)
1527 (foldable flushable))
1528 (defknown %set-symbol-package (symbol t) t ())
1529 (defknown %coerce-name-to-fun ((or symbol cons)) function (flushable))
1530 (defknown %coerce-callable-to-fun (callable) function (flushable))
1531 (defknown array-bounding-indices-bad-error (t t t) nil)
1532 (defknown sequence-bounding-indices-bad-error (t t t) nil)
1533 (defknown %find-position
1534 (t sequence t index sequence-end function function)
1535 (values t (or index null))
1537 (defknown (%find-position-if %find-position-if-not)
1538 (function sequence t index sequence-end function)
1539 (values t (or index null))
1541 (defknown effective-find-position-test (callable callable)
1543 (flushable foldable))
1544 (defknown effective-find-position-key (callable)
1546 (flushable foldable))
1548 (defknown (%adjoin %adjoin-eq)
1551 (explicit-check flushable))
1553 (defknown (%member %member-eq
1554 %assoc %assoc-eq %rassoc %rassoc-eq)
1557 (explicit-check foldable flushable))
1559 (defknown (%adjoin-key %adjoin-key-eq)
1562 (explicit-check flushable call))
1564 (defknown (%member-key %member-key-eq
1565 %assoc-key %assoc-key-eq %rassoc-key %rassoc-key-eq)
1568 (explicit-check foldable flushable call))
1570 (defknown (%assoc-if %assoc-if-not %rassoc-if %rassoc-if-not
1571 %member-if %member-if-not)
1574 (explicit-check foldable flushable call))
1576 (defknown (%assoc-if-key %assoc-if-not-key %rassoc-if-key %rassoc-if-not-key
1577 %member-if-key %member-if-not-key)
1578 (function list function)
1580 (explicit-check foldable flushable call))
1582 (defknown (%adjoin-test %adjoin-test-not)
1585 (explicit-check flushable call))
1587 (defknown (%member-test %member-test-not
1588 %assoc-test %assoc-test-not
1589 %rassoc-test %rassoc-test-not)
1592 (explicit-check foldable flushable call))
1594 (defknown (%adjoin-key-test %adjoin-key-test-not)
1595 (t list function function)
1597 (explicit-check flushable call))
1599 (defknown (%member-key-test %member-key-test-not
1600 %assoc-key-test %assoc-key-test-not
1601 %rassoc-key-test %rassoc-key-test-not)
1602 (t list function function)
1604 (explicit-check foldable flushable call))
1606 (defknown %check-vector-sequence-bounds (vector index sequence-end)
1609 ;;; FIXME: including this information here is probably necessary to
1610 ;;; get efficient compilation of the inline expansion of
1611 ;;; %FIND-POSITION-IF, so it should maybe be in a more
1612 ;;; compiler-friendly package (SB-INT?)
1613 (defknown sb!impl::signal-bounding-indices-bad-error
1614 (sequence index sequence-end)
1615 nil) ; never returns
1618 (defknown arg-count-error (t t t t t t) nil ())
1622 (defknown %aset (array &rest t) t ()
1623 :destroyed-constant-args (nth-constant-args 1))
1624 (defknown %set-row-major-aref (array index t) t ()
1625 :destroyed-constant-args (nth-constant-args 1))
1626 (defknown (%rplaca %rplacd) (cons t) t ()
1627 :destroyed-constant-args (nth-constant-args 1)
1628 :derive-type #'result-type-last-arg)
1629 (defknown %put (symbol t t) t ())
1630 (defknown %setelt (sequence index t) t ()
1631 :destroyed-constant-args (nth-constant-args 1)
1632 :derive-type #'result-type-last-arg)
1633 (defknown %svset (simple-vector index t) t ()
1634 :destroyed-constant-args (nth-constant-args 1))
1635 (defknown %bitset ((array bit) &rest index) bit ()
1636 :destroyed-constant-args (nth-constant-args 1))
1637 (defknown %sbitset ((simple-array bit) &rest index) bit ()
1638 :destroyed-constant-args (nth-constant-args 1))
1639 (defknown %charset (string index character) character ()
1640 :destroyed-constant-args (nth-constant-args 1))
1641 (defknown %scharset (simple-string index character) character ()
1642 :destroyed-constant-args (nth-constant-args 1))
1643 (defknown %set-symbol-value (symbol t) t ())
1644 (defknown (setf symbol-function) (function symbol) function ())
1645 (defknown %set-symbol-plist (symbol list) list ()
1646 :derive-type #'result-type-last-arg)
1647 (defknown %setnth (unsigned-byte list t) t ()
1648 :destroyed-constant-args (nth-constant-args 2)
1649 :derive-type #'result-type-last-arg)
1650 (defknown %set-fill-pointer (complex-vector index) index
1652 :destroyed-constant-args (nth-constant-args 1)
1653 :derive-type #'result-type-last-arg)
1655 ;;;; ALIEN and call-out-to-C stuff
1657 ;; Used by WITH-PINNED-OBJECTS
1659 (defknown sb!vm::touch-object (t) (values)
1660 (always-translatable))
1663 (defknown foreign-symbol-dataref-sap (simple-string)
1665 (movable flushable))
1667 (defknown foreign-symbol-sap (simple-string &optional boolean)
1669 (movable flushable))
1671 (defknown foreign-symbol-address (simple-string &optional boolean)
1672 (values integer boolean)
1673 (movable flushable))
1675 ;;;; miscellaneous internal utilities
1677 (defknown %fun-name (function) t (flushable))
1678 (defknown (setf %fun-name) (t function) t ())
1680 (defknown policy-quality (policy symbol) policy-quality
1683 (defknown compiler-error (t &rest t) nil ())
1684 (defknown (compiler-warn compiler-style-warn) (t &rest t) (values) ())
1685 (defknown (compiler-notify maybe-compiler-notify) ((or string symbol) &rest t)
1688 (defknown style-warn (t &rest t) null ())
1690 (defknown coerce-to-condition ((or condition symbol string function)
1691 list type-specifier symbol)
1695 (defknown sc-number-or-lose (symbol) sc-number
1698 ;;;; memory barriers
1700 (defknown sb!vm:%compiler-barrier () (values) ())
1701 (defknown sb!vm:%memory-barrier () (values) ())
1702 (defknown sb!vm:%read-barrier () (values) ())
1703 (defknown sb!vm:%write-barrier () (values) ())
1704 (defknown sb!vm:%data-dependency-barrier () (values) ())
1707 ;;; Note: This known function does not have an out-of-line definition;
1708 ;;; and if such a definition were needed, it would not need to "call"
1709 ;;; itself inline, but could be a no-op, because the compiler inserts a
1710 ;;; use of the VOP in the function prologue anyway.
1711 (defknown sb!kernel::gc-safepoint () (values) ())
1714 (defknown %compare-and-swap-svref (simple-vector index t t) t
1716 (defknown %compare-and-swap-instance-ref (instance index t t) t
1718 (defknown %compare-and-swap-symbol-value (symbol t t) t
1720 (defknown spin-loop-hint () (values)
1721 (always-translatable))