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