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