src/compiler/fndb.lisp

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