src/compiler/fndb.lisp

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