src/compiler/fndb.lisp

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