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