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