src/compiler/fndb.lisp

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