src/compiler/fndb.lisp

   1 ;;;; This file defines all the standard functions to be known
   2 ;;;; functions. Each function has type and side-effect information,
   3 ;;;; and may also have IR1 optimizers.
   4
   5 ;;;; This software is part of the SBCL system. See the README file for
   6 ;;;; more information.
   7 ;;;;
   8 ;;;; This software is derived from the CMU CL system, which was
   9 ;;;; written at Carnegie Mellon University and released into the
  10 ;;;; public domain. The software is in the public domain and is
  11 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  12 ;;;; files for more information.
  13
  14 (in-package "SB!C")
  15 \f
  16 ;;;; information for known functions:
  17
  18 (defknown coerce (t type-specifier) t
  19     ;; Note:
  20     ;; This is not FLUSHABLE because it's defined to signal errors.
  21     (movable)
  22   ;; :DERIVE-TYPE RESULT-TYPE-SPEC-NTH-ARG 2 ? Nope... (COERCE 1 'COMPLEX)
  23   ;; returns REAL/INTEGER, not COMPLEX.
  24   )
  25 (defknown list-to-vector* (list type-specifier) vector)
  26 (defknown vector-to-vector* (vector type-specifier) vector)
  27
  28 (defknown type-of (t) t (foldable flushable))
  29
  30 ;;; These can be affected by type definitions, so they're not FOLDABLE.
  31 (defknown (sb!xc:upgraded-complex-part-type sb!xc:upgraded-array-element-type)
  32     (type-specifier &optional lexenv-designator) type-specifier
  33     (unsafely-flushable))
  34 \f
  35 ;;;; from the "Predicates" chapter:
  36
  37 ;;; FIXME: Is it right to have TYPEP (and TYPE-OF, elsewhere; and
  38 ;;; perhaps SPECIAL-OPERATOR-P and others) be FOLDABLE in the
  39 ;;; cross-compilation host? After all, some type relationships (e.g.
  40 ;;; FIXNUMness) might be different between host and target. Perhaps
  41 ;;; this property should be protected by #-SB-XC-HOST? Perhaps we need
  42 ;;; 3-stage bootstrapping after all? (Ugh! It's *so* slow already!)
  43 (defknown typep (t type-specifier &optional lexenv-designator) t
  44    ;; Unlike SUBTYPEP or UPGRADED-ARRAY-ELEMENT-TYPE and friends, this
  45    ;; seems to be FOLDABLE. Like SUBTYPEP, it's affected by type
  46    ;; definitions, but unlike SUBTYPEP, there should be no way to make
  47    ;; a TYPEP expression with constant arguments which doesn't return
  48    ;; an error before the type declaration (because of undefined
  49    ;; type). E.g. you can do
  50    ;;   (SUBTYPEP 'INTEGER 'FOO) => NIL, NIL
  51    ;;   (DEFTYPE FOO () T)
  52    ;;   (SUBTYPEP 'INTEGER 'FOO) => T, T
  53    ;; but the analogous
  54    ;;   (TYPEP 12 'FOO)
  55    ;;   (DEFTYPE FOO () T)
  56    ;;   (TYPEP 12 'FOO)
  57    ;; doesn't work because the first call is an error.
  58    ;;
  59    ;; (UPGRADED-ARRAY-ELEMENT-TYPE and UPGRADED-COMPLEX-PART-TYPE have
  60    ;; behavior like SUBTYPEP in this respect, not like TYPEP.)
  61    (foldable))
  62 (defknown subtypep (type-specifier type-specifier &optional lexenv-designator)
  63   (values boolean boolean)
  64   ;; This is not FOLDABLE because its value is affected by type
  65   ;; definitions.
  66   ;;
  67   ;; FIXME: Is it OK to fold this when the types have already been
  68   ;; defined? Does the code inherited from CMU CL already do this?
  69   (unsafely-flushable))
  70
  71 (defknown (null symbolp atom consp listp numberp integerp rationalp floatp
  72                 complexp characterp stringp bit-vector-p vectorp
  73                 simple-vector-p simple-string-p simple-bit-vector-p arrayp
  74                 sb!xc:packagep functionp compiled-function-p not)
  75   (t) boolean (movable foldable flushable))
  76
  77 (defknown (eq eql) (t t) boolean (movable foldable flushable))
  78 (defknown (equal equalp) (t t) boolean (foldable flushable recursive))
  79 \f
  80 ;;;; classes
  81
  82 (sb!xc:deftype name-for-class () t)
  83 (defknown classoid-name (classoid) symbol (flushable))
  84 (defknown find-classoid (name-for-class &optional t)
  85   (or classoid null) ())
  86 (defknown classoid-of (t) classoid (flushable))
  87 (defknown layout-of (t) layout (flushable))
  88 (defknown copy-structure (structure-object) structure-object
  89   (flushable unsafe))
  90 \f
  91 ;;;; from the "Control Structure" chapter:
  92
  93 ;;; This is not FLUSHABLE, since it's required to signal an error if
  94 ;;; unbound.
  95 (defknown (symbol-value) (symbol) t ())
  96 ;;; From CLHS, "If the symbol is globally defined as a macro or a
  97 ;;; special operator, an object of implementation-dependent nature and
  98 ;;; identity is returned. If the symbol is not globally defined as
  99 ;;; either a macro or a special operator, and if the symbol is fbound,
 100 ;;; a function object is returned".  Our objects of
 101 ;;; implementation-dependent nature happen to be functions.
 102 (defknown (symbol-function) (symbol) function ())
 103
 104 (defknown boundp (symbol) boolean (flushable))
 105 (defknown fboundp ((or symbol cons)) boolean (unsafely-flushable explicit-check))
 106 (defknown special-operator-p (symbol) t
 107   ;; The set of special operators never changes.
 108   (movable foldable flushable))
 109 (defknown set (symbol t) t (unsafe)
 110   :derive-type #'result-type-last-arg)
 111 (defknown fdefinition ((or symbol cons)) function (unsafe explicit-check))
 112 (defknown %set-fdefinition ((or symbol cons) function) function
 113   (unsafe explicit-check))
 114 (defknown makunbound (symbol) symbol)
 115 (defknown fmakunbound ((or symbol cons)) (or symbol cons)
 116   (unsafe explicit-check))
 117 (defknown 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 unsafe))
 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))
 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 unsafe)
 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 ;;; unsafe for :INITIAL-VALUE...
 487 (defknown reduce (callable sequence &rest t &key (:from-end t) (:start index)
 488                   (:end sequence-end) (:initial-value t) (:key callable))
 489   t
 490   (foldable flushable call unsafe))
 491
 492 (defknown fill (sequence t &rest t &key
 493                          (:start index) (:end sequence-end)) sequence
 494   (unsafe)
 495   :derive-type #'result-type-first-arg
 496   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
 497   :result-arg 0)
 498
 499 (defknown replace (sequence sequence &rest t &key (:start1 index)
 500                    (:end1 sequence-end) (:start2 index) (:end2 sequence-end))
 501   sequence ()
 502   :derive-type #'result-type-first-arg
 503   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1)
 504   :result-arg 0)
 505
 506 (defknown remove
 507   (t sequence &rest t &key (:from-end t) (:test callable)
 508      (:test-not callable) (:start index) (:end sequence-end)
 509      (:count sequence-count) (:key callable))
 510   consed-sequence
 511   (flushable call)
 512   :derive-type (sequence-result-nth-arg 2))
 513
 514 (defknown substitute
 515   (t t sequence &rest t &key (:from-end t) (:test callable)
 516      (:test-not callable) (:start index) (:end sequence-end)
 517      (:count sequence-count) (:key callable))
 518   consed-sequence
 519   (flushable call)
 520   :derive-type (sequence-result-nth-arg 3))
 521
 522 (defknown (remove-if remove-if-not)
 523   (callable sequence &rest t &key (:from-end t) (:start index)
 524             (:end sequence-end) (:count sequence-count) (:key callable))
 525   consed-sequence
 526   (flushable call)
 527   :derive-type (sequence-result-nth-arg 2))
 528
 529 (defknown (substitute-if substitute-if-not)
 530   (t callable sequence &rest t &key (:from-end t) (:start index)
 531      (:end sequence-end) (:count sequence-count) (:key callable))
 532   consed-sequence
 533   (flushable call)
 534   :derive-type (sequence-result-nth-arg 3))
 535
 536 (defknown delete
 537   (t sequence &rest t &key (:from-end t) (:test callable)
 538      (:test-not callable) (:start index) (:end sequence-end)
 539      (:count sequence-count) (:key callable))
 540   sequence
 541   (flushable call important-result)
 542   :derive-type (sequence-result-nth-arg 2)
 543   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
 544
 545 (defknown nsubstitute
 546   (t t sequence &rest t &key (:from-end t) (:test callable)
 547      (:test-not callable) (:start index) (:end sequence-end)
 548      (:count sequence-count) (:key callable))
 549   sequence
 550   (flushable call)
 551   :derive-type (sequence-result-nth-arg 3)
 552   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
 553
 554 (defknown (delete-if delete-if-not)
 555   (callable sequence &rest t &key (:from-end t) (:start index)
 556             (:end sequence-end) (:count sequence-count) (:key callable))
 557   sequence
 558   (flushable call important-result)
 559   :derive-type (sequence-result-nth-arg 2)
 560   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
 561
 562 (defknown (nsubstitute-if nsubstitute-if-not)
 563   (t callable sequence &rest t &key (:from-end t) (:start index)
 564      (:end sequence-end) (:count sequence-count) (:key callable))
 565   sequence
 566   (flushable call)
 567   :derive-type (sequence-result-nth-arg 3)
 568   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
 569
 570 (defknown remove-duplicates
 571   (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
 572             (:from-end t) (:end sequence-end) (:key callable))
 573   consed-sequence
 574   (unsafely-flushable call)
 575   :derive-type (sequence-result-nth-arg 1))
 576
 577 (defknown delete-duplicates
 578   (sequence &rest t &key (:test callable) (:test-not callable) (:start index)
 579             (:from-end t) (:end sequence-end) (:key callable))
 580   sequence
 581   (unsafely-flushable call important-result)
 582   :derive-type (sequence-result-nth-arg 1)
 583   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
 584
 585 (defknown find (t sequence &rest t &key (:test callable)
 586                 (:test-not callable) (:start index) (:from-end t)
 587                 (:end sequence-end) (:key callable))
 588   t
 589   (foldable flushable call))
 590
 591 (defknown (find-if find-if-not)
 592   (callable sequence &rest t &key (:from-end t) (:start index)
 593    (:end sequence-end) (:key callable))
 594   t
 595   (foldable flushable call))
 596
 597 (defknown position (t sequence &rest t &key (:test callable)
 598                     (:test-not callable) (:start index) (:from-end t)
 599                     (:end sequence-end) (:key callable))
 600   (or index null)
 601   (foldable flushable call))
 602
 603 (defknown (position-if position-if-not)
 604   (callable sequence &rest t &key (:from-end t) (:start index)
 605    (:end sequence-end) (:key callable))
 606   (or index null)
 607   (foldable flushable call))
 608
 609 (defknown count (t sequence &rest t &key
 610                    (:test callable) (:test-not callable) (:start index)
 611                    (:from-end t) (:end sequence-end) (:key callable))
 612   index
 613   (foldable flushable call))
 614
 615 (defknown (count-if count-if-not)
 616   (callable sequence &rest t &key
 617             (:from-end t) (:start index) (:end sequence-end) (:key callable))
 618   index
 619   (foldable flushable call))
 620
 621 (defknown (mismatch search)
 622   (sequence sequence &rest t &key (:from-end t) (:test callable)
 623    (:test-not callable) (:start1 index) (:end1 sequence-end)
 624    (:start2 index) (:end2 sequence-end) (:key callable))
 625   (or index null)
 626   (foldable flushable call))
 627
 628 ;;; not FLUSHABLE, since vector sort guaranteed in-place...
 629 (defknown (stable-sort sort) (sequence callable &rest t &key (:key callable))
 630   sequence
 631   (call)
 632   :derive-type (sequence-result-nth-arg 1)
 633   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
 634 (defknown sb!impl::stable-sort-list (list function function) list
 635   (call important-result)
 636   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
 637 (defknown sb!impl::sort-vector (vector index index function (or function null))
 638   * ; SORT-VECTOR works through side-effect
 639   (call)
 640   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
 641
 642 (defknown merge (type-specifier sequence sequence callable
 643                                 &key (:key callable))
 644   sequence
 645   (call important-result)
 646   :derive-type (creation-result-type-specifier-nth-arg 1)
 647   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2 3))
 648
 649 ;;; not FLUSHABLE, despite what CMU CL's DEFKNOWN said..
 650 (defknown read-sequence (sequence stream
 651                                   &key
 652                                   (:start index)
 653                                   (:end sequence-end))
 654   (index)
 655   ())
 656
 657 (defknown write-sequence (sequence stream
 658                                    &key
 659                                    (:start index)
 660                                    (:end sequence-end))
 661   sequence
 662   ()
 663   :derive-type (sequence-result-nth-arg 1))
 664 \f
 665 ;;;; from the "Manipulating List Structure" chapter:
 666 (defknown (car cdr first rest)
 667   (list)
 668   t
 669   (foldable flushable))
 670
 671 ;; Correct argument type restrictions for these functions are
 672 ;; complicated, so we just declare them to accept LISTs and suppress
 673 ;; flushing is safe code.
 674 (defknown (caar cadr cdar cddr
 675                 caaar caadr cadar caddr cdaar cdadr cddar cdddr
 676                 caaaar caaadr caadar caaddr cadaar cadadr caddar cadddr
 677                 cdaaar cdaadr cdadar cdaddr cddaar cddadr cdddar cddddr
 678                 second third fourth fifth sixth seventh eighth ninth tenth)
 679   (list)
 680   t
 681   (foldable unsafely-flushable))
 682
 683 (defknown cons (t t) cons (movable flushable unsafe))
 684
 685 (defknown tree-equal (t t &key (:test callable) (:test-not callable)) boolean
 686   (foldable flushable call))
 687 (defknown endp (list) boolean (foldable flushable movable))
 688 (defknown list-length (list) (or index null) (foldable unsafely-flushable))
 689 (defknown nth (unsigned-byte list) t (foldable flushable))
 690 (defknown nthcdr (unsigned-byte list) t (foldable unsafely-flushable))
 691
 692 (defknown last (list &optional unsigned-byte) t (foldable flushable))
 693 (defknown %last0 (list) t (foldable flushable))
 694 (defknown %last1 (list) t (foldable flushable))
 695 (defknown %lastn/fixnum (list (and unsigned-byte fixnum)) t (foldable flushable))
 696 (defknown %lastn/bignum (list (and unsigned-byte bignum)) t (foldable flushable))
 697
 698 (defknown list (&rest t) list (movable flushable unsafe))
 699 (defknown list* (t &rest t) t (movable flushable unsafe))
 700 (defknown make-list (index &key (:initial-element t)) list
 701   (movable flushable unsafe))
 702
 703 ;;; All but last must be of type LIST, but there seems to be no way to
 704 ;;; express that in this syntax.
 705 (defknown append (&rest t) t (flushable))
 706
 707 (defknown copy-list (list) list (flushable))
 708 (defknown copy-alist (list) list (flushable))
 709 (defknown copy-tree (t) t (flushable recursive))
 710 (defknown revappend (list t) t (flushable))
 711
 712 ;;; All but last must be of type LIST, but there seems to be no way to
 713 ;;; express that in this syntax. The result must be LIST, but we do
 714 ;;; not check it now :-).
 715 (defknown nconc (&rest t) t ()
 716   :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
 717 (defknown sb!impl::nconc2 (list t) t ()
 718   :destroyed-constant-args (remove-non-constants-and-nils #'butlast))
 719
 720 (defknown nreconc (list t) t (important-result)
 721   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
 722 (defknown butlast (list &optional unsigned-byte) list (flushable))
 723 (defknown nbutlast (list &optional unsigned-byte) list ()
 724   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
 725
 726 (defknown ldiff (list t) list (flushable))
 727 (defknown (rplaca rplacd) (cons t) list (unsafe)
 728   :destroyed-constant-args (nth-constant-args 1))
 729
 730 (defknown subst (t t t &key (:key callable) (:test callable)
 731                    (:test-not callable))
 732   t (flushable unsafe call))
 733 (defknown nsubst (t t t &key (:key callable) (:test callable)
 734                     (:test-not callable))
 735   t (unsafe call)
 736   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
 737
 738 (defknown (subst-if subst-if-not)
 739           (t callable t &key (:key callable))
 740   t (flushable unsafe call))
 741 (defknown (nsubst-if nsubst-if-not)
 742           (t callable t &key (:key callable))
 743   t (unsafe call)
 744   :destroyed-constant-args (nth-constant-nonempty-sequence-args 3))
 745
 746 (defknown sublis (list t &key (:key callable) (:test callable)
 747                        (:test-not callable))
 748   t (flushable unsafe call))
 749 (defknown nsublis (list t &key (:key callable) (:test callable)
 750                         (:test-not callable))
 751   t (flushable unsafe call)
 752   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
 753
 754 (defknown member (t list &key (:key callable) (:test callable)
 755                     (:test-not callable))
 756   list (foldable flushable call))
 757 (defknown (member-if member-if-not) (callable list &key (:key callable))
 758   list (foldable flushable call))
 759
 760 (defknown tailp (t list) boolean (foldable flushable))
 761
 762 (defknown adjoin (t list &key (:key callable) (:test callable)
 763                     (:test-not callable))
 764   list (foldable flushable unsafe call))
 765
 766 (defknown (union intersection set-difference set-exclusive-or)
 767   (list list &key (:key callable) (:test callable) (:test-not callable))
 768   list
 769   (foldable flushable call))
 770
 771 (defknown (nunion nintersection nset-difference nset-exclusive-or)
 772   (list list &key (:key callable) (:test callable) (:test-not callable))
 773   list
 774   (foldable flushable call important-result)
 775   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1 2))
 776
 777 (defknown subsetp
 778   (list list &key (:key callable) (:test callable) (:test-not callable))
 779   boolean
 780   (foldable flushable call))
 781
 782 (defknown acons (t t t) list (movable flushable unsafe))
 783 (defknown pairlis (t t &optional t) list (flushable unsafe))
 784
 785 (defknown (rassoc assoc)
 786           (t list &key (:key callable) (:test callable) (:test-not callable))
 787   list (foldable flushable call))
 788 (defknown (assoc-if-not assoc-if rassoc-if rassoc-if-not)
 789           (callable list &key (:key callable)) list (foldable flushable call))
 790
 791 (defknown (memq assq) (t list) list (foldable flushable unsafe))
 792 (defknown delq (t list) list (flushable unsafe)
 793   :destroyed-constant-args (nth-constant-nonempty-sequence-args 2))
 794 \f
 795 ;;;; from the "Hash Tables" chapter:
 796
 797 (defknown make-hash-table
 798   (&key (:test callable) (:size unsigned-byte)
 799         (:rehash-size (or (integer 1) (float (1.0))))
 800         (:rehash-threshold (real 0 1))
 801         (:hash-function (or null callable))
 802         (:weakness (member nil :key :value :key-and-value :key-or-value))
 803         (:synchronized t))
 804   hash-table
 805   (flushable unsafe))
 806 (defknown hash-table-p (t) boolean (movable foldable flushable))
 807 (defknown gethash (t hash-table &optional t) (values t boolean)
 808   (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
 809 (defknown sb!impl::gethash2 (t hash-table) (values t boolean)
 810   (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
 811 (defknown sb!impl::gethash3 (t hash-table t) (values t boolean)
 812   (flushable unsafe)) ; not FOLDABLE, since hash table contents can change
 813 (defknown %puthash (t hash-table t) t (unsafe)
 814   :destroyed-constant-args (nth-constant-args 2))
 815 (defknown remhash (t hash-table) boolean ()
 816   :destroyed-constant-args (nth-constant-args 2))
 817 (defknown maphash (callable hash-table) null (flushable call))
 818 (defknown clrhash (hash-table) hash-table ()
 819   :destroyed-constant-args (nth-constant-args 2))
 820 (defknown hash-table-count (hash-table) index (flushable))
 821 (defknown hash-table-rehash-size (hash-table) (or index (single-float (1.0)))
 822   (foldable flushable))
 823 (defknown hash-table-rehash-threshold (hash-table) (single-float (0.0) 1.0)
 824   (foldable flushable))
 825 (defknown hash-table-size (hash-table) index (flushable))
 826 (defknown hash-table-test (hash-table) symbol (foldable flushable))
 827 (defknown sxhash (t) hash (#-sb-xc-host foldable flushable))
 828 (defknown psxhash (t &optional t) hash (#-sb-xc-host foldable flushable))
 829 \f
 830 ;;;; from the "Arrays" chapter
 831
 832 (defknown make-array ((or index list)
 833                       &key
 834                       (:element-type type-specifier)
 835                       (:initial-element t)
 836                       (:initial-contents t)
 837                       (:adjustable t)
 838                       (:fill-pointer t)
 839                       (:displaced-to (or array null))
 840                       (:displaced-index-offset index))
 841   array (flushable unsafe))
 842
 843 (defknown vector (&rest t) simple-vector (flushable unsafe))
 844
 845 (defknown aref (array &rest index) t (foldable))
 846 (defknown row-major-aref (array index) t (foldable))
 847
 848 (defknown array-element-type (array)
 849   type-specifier
 850   (foldable flushable recursive))
 851 (defknown array-rank (array) array-rank (foldable flushable))
 852 (defknown array-dimension (array array-rank) index (foldable flushable))
 853 (defknown array-dimensions (array) list (foldable flushable))
 854 (defknown array-in-bounds-p (array &rest integer) boolean (foldable flushable))
 855 (defknown array-row-major-index (array &rest index) array-total-size
 856   (foldable flushable))
 857 (defknown array-total-size (array) array-total-size (foldable flushable))
 858 (defknown adjustable-array-p (array) boolean (movable foldable flushable))
 859
 860 (defknown svref (simple-vector index) t (foldable flushable))
 861 (defknown bit ((array bit) &rest index) bit (foldable flushable))
 862 (defknown sbit ((simple-array bit) &rest index) bit (foldable flushable))
 863
 864 ;;; FIXME: :DESTROYED-CONSTANT-ARGS for these is complicated.
 865 (defknown (bit-and bit-ior bit-xor bit-eqv bit-nand bit-nor bit-andc1 bit-andc2
 866                    bit-orc1 bit-orc2)
 867   ((array bit) (array bit) &optional (or (array bit) (member t nil)))
 868   (array bit)
 869   ()
 870   #|:derive-type #'result-type-last-arg|#)
 871
 872 (defknown bit-not ((array bit) &optional (or (array bit) (member t nil)))
 873   (array bit)
 874   ()
 875   #|:derive-type #'result-type-last-arg|#)
 876
 877 (defknown bit-vector-= (bit-vector bit-vector) boolean
 878   (movable foldable flushable))
 879
 880 (defknown array-has-fill-pointer-p (array) boolean
 881   (movable foldable flushable))
 882 (defknown fill-pointer (complex-vector) index
 883     (unsafely-flushable explicit-check))
 884 (defknown vector-push (t complex-vector) (or index null)
 885     (explicit-check)
 886   :destroyed-constant-args (nth-constant-args 2))
 887 (defknown vector-push-extend (t complex-vector &optional (and index (integer 1))) index
 888     (explicit-check)
 889   :destroyed-constant-args (nth-constant-args 2))
 890 (defknown vector-pop (complex-vector) t
 891     (explicit-check)
 892   :destroyed-constant-args (nth-constant-args 1))
 893
 894 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
 895 ;;; Also, an important-result warning could be provided if the array
 896 ;;; is known to be not expressly adjustable.
 897 (defknown adjust-array
 898   (array (or index list) &key (:element-type type-specifier)
 899          (:initial-element t) (:initial-contents t)
 900          (:fill-pointer t) (:displaced-to (or array null))
 901          (:displaced-index-offset index))
 902   array (unsafe))
 903 ;  :derive-type 'result-type-arg1) Not even close...
 904 \f
 905 ;;;; from the "Strings" chapter:
 906
 907 (defknown char (string index) character (foldable flushable))
 908 (defknown schar (simple-string index) character (foldable flushable))
 909
 910 (defknown (string= string-equal)
 911   (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
 912               (:start2 index) (:end2 sequence-end))
 913   boolean
 914   (foldable flushable))
 915
 916 (defknown (string< string> string<= string>= string/= string-lessp
 917                    string-greaterp string-not-lessp string-not-greaterp
 918                    string-not-equal)
 919   (string-designator string-designator &key (:start1 index) (:end1 sequence-end)
 920               (:start2 index) (:end2 sequence-end))
 921   (or index null)
 922   (foldable flushable))
 923
 924 (defknown make-string (index &key (:element-type type-specifier)
 925                        (:initial-element character))
 926   simple-string (flushable))
 927
 928 (defknown (string-trim string-left-trim string-right-trim)
 929   (sequence string-designator) string (flushable))
 930
 931 (defknown (string-upcase string-downcase string-capitalize)
 932   (string-designator &key (:start index) (:end sequence-end))
 933   simple-string (flushable))
 934
 935 (defknown (nstring-upcase nstring-downcase nstring-capitalize)
 936   (string &key (:start index) (:end sequence-end))
 937   string ()
 938   :destroyed-constant-args (nth-constant-nonempty-sequence-args 1))
 939
 940 (defknown string (string-designator) string
 941   (flushable explicit-check))
 942 \f
 943 ;;;; internal non-keyword versions of string predicates:
 944
 945 (defknown (string<* string>* string<=* string>=* string/=*)
 946   (string-designator string-designator index sequence-end index sequence-end)
 947   (or index null)
 948   (foldable flushable))
 949
 950 (defknown string=*
 951   (string-designator string-designator index sequence-end index sequence-end)
 952   boolean
 953   (foldable flushable))
 954 \f
 955 ;;;; from the "Eval" chapter:
 956
 957 (defknown eval (t) * (recursive))
 958 (defknown constantp (t &optional lexenv-designator) boolean
 959   (foldable flushable))
 960 \f
 961 ;;;; from the "Streams" chapter:
 962
 963 (defknown make-synonym-stream (symbol) stream (flushable))
 964 (defknown make-broadcast-stream (&rest stream) stream (unsafely-flushable))
 965 (defknown make-concatenated-stream (&rest stream) stream (unsafely-flushable))
 966 (defknown make-two-way-stream (stream stream) stream (unsafely-flushable))
 967 (defknown make-echo-stream (stream stream) stream (flushable))
 968 (defknown make-string-input-stream (string &optional index sequence-end)
 969   stream
 970   (flushable unsafe))
 971 (defknown make-string-output-stream
 972     (&key (:element-type type-specifier))
 973     string-output-stream
 974   (flushable))
 975 (defknown get-output-stream-string (stream) simple-string ())
 976 (defknown streamp (t) boolean (movable foldable flushable))
 977 (defknown stream-element-type (stream) type-specifier
 978   (movable foldable flushable))
 979 (defknown (output-stream-p input-stream-p) (stream) boolean
 980   (movable foldable flushable))
 981 (defknown close (stream &key (:abort t)) (eql t) ())
 982 \f
 983 ;;;; from the "Input/Output" chapter:
 984
 985 ;;; (The I/O functions are given effects ANY under the theory that
 986 ;;; code motion over I/O operations is particularly confusing and not
 987 ;;; very important for efficiency.)
 988
 989 (defknown copy-readtable (&optional (or readtable null) (or readtable null))
 990   readtable
 991   ())
 992 (defknown readtablep (t) boolean (movable foldable flushable))
 993
 994 (defknown set-syntax-from-char
 995   (character character &optional readtable (or readtable null)) (eql t)
 996   ())
 997
 998 (defknown set-macro-character (character callable &optional t (or readtable null))
 999   (eql t)
1000   (unsafe))
1001 (defknown get-macro-character (character &optional (or readtable null))
1002   (values callable boolean) (flushable))
1003
1004 (defknown make-dispatch-macro-character (character &optional t readtable)
1005   (eql t) ())
1006 (defknown set-dispatch-macro-character
1007   (character character callable &optional (or readtable null)) (eql t)
1008   (unsafe))
1009 (defknown get-dispatch-macro-character
1010   (character character &optional (or readtable null)) (or callable null)
1011   ())
1012
1013 (defknown copy-pprint-dispatch
1014   (&optional (or sb!pretty:pprint-dispatch-table null))
1015   sb!pretty:pprint-dispatch-table
1016   ())
1017 (defknown pprint-dispatch
1018   (t &optional (or sb!pretty:pprint-dispatch-table null))
1019   (values callable boolean)
1020   ())
1021 (defknown (pprint-fill pprint-linear)
1022   (stream-designator t &optional t t)
1023   null
1024   ())
1025 (defknown pprint-tabular
1026   (stream-designator t &optional t t unsigned-byte)
1027   null
1028   ())
1029 (defknown pprint-indent
1030   ((member :block :current) real &optional stream-designator)
1031   null
1032   ())
1033 (defknown pprint-newline
1034   ((member :linear :fill :miser :mandatory) &optional stream-designator)
1035   null
1036   ())
1037 (defknown pprint-tab
1038   ((member :line :section :line-relative :section-relative)
1039    unsigned-byte unsigned-byte &optional stream-designator)
1040   null
1041   ())
1042 (defknown set-pprint-dispatch
1043   (type-specifier (or null callable)
1044    &optional real sb!pretty:pprint-dispatch-table)
1045   null
1046   ())
1047
1048 ;;; may return any type due to eof-value...
1049 (defknown (read read-preserving-whitespace read-char-no-hang read-char)
1050   (&optional stream-designator t t t) t (explicit-check))
1051
1052 (defknown read-delimited-list (character &optional stream-designator t) list
1053   (explicit-check))
1054 (defknown read-line (&optional stream-designator t t t) (values t boolean)
1055   (explicit-check))
1056 (defknown unread-char (character &optional stream-designator) t
1057   (explicit-check))
1058 (defknown peek-char (&optional (or character (member nil t))
1059                                stream-designator t t t)
1060   t
1061   (explicit-check))
1062 (defknown listen (&optional stream-designator) boolean (flushable explicit-check))
1063
1064 (defknown clear-input (&optional stream-designator) null (explicit-check))
1065
1066 (defknown read-from-string
1067   (string &optional t t
1068           &key
1069           (:start index)
1070           (:end sequence-end)
1071           (:preserve-whitespace t))
1072   (values t index))
1073 (defknown parse-integer
1074   (string &key
1075           (:start index)
1076           (:end sequence-end)
1077           (:radix (integer 2 36))
1078           (:junk-allowed t))
1079   (values (or integer null ()) index))
1080
1081 (defknown read-byte (stream &optional t t) t (explicit-check))
1082
1083 (defknown write
1084   (t &key
1085      (:stream stream-designator)
1086      (:escape t)
1087      (:radix t)
1088      (:base (integer 2 36))
1089      (:circle t)
1090      (:pretty t)
1091      (:level (or unsigned-byte null))
1092      (:readably t)
1093      (:length (or unsigned-byte null))
1094      (:case t)
1095      (:array t)
1096      (:gensym t)
1097      (:lines (or unsigned-byte null))
1098      (:right-margin (or unsigned-byte null))
1099      (:miser-width (or unsigned-byte null))
1100      (:pprint-dispatch t))
1101   t
1102   (any explicit-check)
1103   :derive-type #'result-type-first-arg)
1104
1105 (defknown (prin1 print princ) (t &optional stream-designator)
1106   t
1107   (any explicit-check)
1108   :derive-type #'result-type-first-arg)
1109
1110 ;;; xxx-TO-STRING functions are not foldable because they depend on
1111 ;;; the dynamic environment, the state of the pretty printer dispatch
1112 ;;; table, and probably other run-time factors.
1113 (defknown write-to-string
1114   (t &key (:escape t) (:radix t) (:base (integer 2 36)) (:readably t)
1115      (:circle t) (:pretty t) (:level (or unsigned-byte null))
1116      (:length (or unsigned-byte null)) (:case t) (:array t) (:gensym t)
1117      (:lines (or unsigned-byte null)) (:right-margin (or unsigned-byte null))
1118      (:miser-width (or unsigned-byte null)) (:pprint-dispatch t))
1119   simple-string
1120   (flushable explicit-check))
1121
1122 (defknown (prin1-to-string princ-to-string) (t) simple-string (flushable))
1123
1124 (defknown write-char (character &optional stream-designator) character
1125   (explicit-check))
1126 (defknown (write-string write-line)
1127   (string &optional stream-designator &key (:start index) (:end sequence-end))
1128   string
1129   (explicit-check))
1130
1131 (defknown (terpri finish-output force-output clear-output)
1132   (&optional stream-designator) null
1133   (explicit-check))
1134
1135 (defknown fresh-line (&optional stream-designator) boolean
1136   (explicit-check))
1137
1138 (defknown write-byte (integer stream) integer
1139   (explicit-check))
1140
1141 ;;; FIXME: complicated :DESTROYED-CONSTANT-ARGS
1142 (defknown format ((or (member nil t) stream string)
1143                   (or string function) &rest t)
1144   (or string null)
1145   (explicit-check))
1146
1147 (defknown (y-or-n-p yes-or-no-p) (&optional string &rest t) boolean
1148   (explicit-check))
1149 \f
1150 ;;;; from the "File System Interface" chapter:
1151
1152 ;;; (No pathname functions are FOLDABLE because they all potentially
1153 ;;; depend on *DEFAULT-PATHNAME-DEFAULTS*, e.g. to provide a default
1154 ;;; host when parsing a namestring. They are not FLUSHABLE because
1155 ;;; parsing of a PATHNAME-DESIGNATOR might signal an error.)
1156
1157 (defknown wild-pathname-p (pathname-designator
1158                            &optional
1159                            (member nil :host :device
1160                                    :directory :name
1161                                    :type :version))
1162   generalized-boolean
1163   ())
1164 (defknown pathname-match-p (pathname-designator pathname-designator)
1165   generalized-boolean
1166   ())
1167 (defknown translate-pathname (pathname-designator
1168                               pathname-designator
1169                               pathname-designator &key)
1170   pathname
1171   ())
1172
1173 (defknown logical-pathname (pathname-designator) logical-pathname ())
1174 (defknown translate-logical-pathname (pathname-designator &key) pathname
1175   (recursive))
1176 (defknown load-logical-pathname-translations (string) t ())
1177 (defknown logical-pathname-translations (logical-host-designator) list ())
1178
1179 (defknown pathname (pathname-designator) pathname ())
1180 (defknown truename (pathname-designator) pathname ())
1181
1182 (defknown parse-namestring
1183   (pathname-designator &optional
1184                        (or list host string (member :unspecific))
1185                        pathname-designator
1186                        &key
1187                        (:start index)
1188                        (:end sequence-end)
1189                        (:junk-allowed t))
1190   (values (or pathname null) sequence-end)
1191   ())
1192
1193 (defknown merge-pathnames
1194   (pathname-designator &optional pathname-designator pathname-version)
1195   pathname
1196   ())
1197
1198 (defknown make-pathname
1199  (&key (:defaults pathname-designator)
1200        (:host (or string pathname-host))
1201        (:device (or string pathname-device))
1202        (:directory (or pathname-directory string (member :wild)))
1203        (:name (or pathname-name string (member :wild)))
1204        (:type (or pathname-type string (member :wild)))
1205        (:version pathname-version) (:case (member :local :common)))
1206   pathname (unsafely-flushable))
1207
1208 (defknown pathnamep (t) boolean (movable flushable))
1209
1210 (defknown pathname-host (pathname-designator
1211                          &key (:case (member :local :common)))
1212   pathname-host (flushable))
1213 (defknown pathname-device (pathname-designator
1214                            &key (:case (member :local :common)))
1215   pathname-device (flushable))
1216 (defknown pathname-directory (pathname-designator
1217                               &key (:case (member :local :common)))
1218   pathname-directory (flushable))
1219 (defknown pathname-name (pathname-designator
1220                          &key (:case (member :local :common)))
1221   pathname-name (flushable))
1222 (defknown pathname-type (pathname-designator
1223                          &key (:case (member :local :common)))
1224   pathname-type (flushable))
1225 (defknown pathname-version (pathname-designator)
1226   pathname-version (flushable))
1227
1228 (defknown (namestring file-namestring directory-namestring host-namestring)
1229   (pathname-designator) (or simple-string null)
1230   (unsafely-flushable))
1231
1232 (defknown enough-namestring (pathname-designator &optional pathname-designator)
1233   simple-string
1234   (unsafely-flushable))
1235
1236 (defknown user-homedir-pathname (&optional t) pathname (flushable))
1237
1238 (defknown open
1239   (pathname-designator &key
1240                        (:direction (member :input :output :io :probe))
1241                        (:element-type type-specifier)
1242                        (:if-exists (member :error :new-version :rename
1243                                            :rename-and-delete :overwrite
1244                                            :append :supersede nil))
1245                        (:if-does-not-exist (member :error :create nil))
1246                        (:external-format external-format-designator))
1247   (or stream null))
1248
1249 (defknown rename-file (pathname-designator filename)
1250   (values pathname pathname pathname))
1251 (defknown delete-file (pathname-designator) t)
1252 (defknown probe-file (pathname-designator) (or pathname null) ())
1253 (defknown file-write-date (pathname-designator) (or unsigned-byte null)
1254   ())
1255 (defknown file-author (pathname-designator) (or simple-string null)
1256   ())
1257
1258 (defknown file-position (stream &optional
1259                                 (or unsigned-byte (member :start :end)))
1260   (or unsigned-byte (member t nil)))
1261 (defknown file-length (stream) (or unsigned-byte null) (unsafely-flushable))
1262
1263 (defknown load
1264   ((or filename stream)
1265    &key
1266    (:verbose t)
1267    (:print t)
1268    (:if-does-not-exist t)
1269    (:external-format external-format-designator))
1270   t)
1271
1272 (defknown directory (pathname-designator &key (:resolve-symlinks t))
1273   list ())
1274 \f
1275 ;;;; from the "Conditions" chapter:
1276
1277 (defknown error (t &rest t) nil)
1278 (defknown cerror (format-control t &rest t) null)
1279 (defknown invalid-method-error (t format-control &rest t) *) ; FIXME: first arg is METHOD
1280 (defknown method-combination-error (format-control &rest t) *)
1281 (defknown signal (t &rest t) null)
1282 (defknown warn (t &rest t) null)
1283 (defknown invoke-debugger (condition) nil)
1284 (defknown break (&optional format-control &rest t) null)
1285 (defknown make-condition (type-specifier &rest t) condition)
1286 (defknown compute-restarts (&optional (or condition null)) list)
1287 (defknown find-restart (restart-designator &optional (or condition null))
1288   (or restart null))
1289 (defknown invoke-restart (restart-designator &rest t) *)
1290 (defknown invoke-restart-interactively (restart-designator) *)
1291 (defknown restart-name (restart) symbol)
1292 (defknown (abort muffle-warning) (&optional (or condition null)) nil)
1293 (defknown continue (&optional (or condition null)) null)
1294 (defknown (store-value use-value) (t &optional (or condition null))
1295   null)
1296
1297 ;;; and analogous SBCL extension:
1298 (defknown sb!impl::%failed-aver (t) nil)
1299 (defknown bug (t &rest t) nil) ; never returns
1300
1301 \f
1302 ;;;; from the "Miscellaneous" Chapter:
1303
1304 (defknown compile ((or symbol cons) &optional (or list function null))
1305   (values (or function symbol cons) boolean boolean))
1306
1307 (defknown compile-file
1308   (pathname-designator
1309    &key
1310
1311    ;; ANSI options
1312    (:output-file (or pathname-designator
1313                      null
1314                      ;; FIXME: This last case is a non-ANSI hack.
1315                      (member t)))
1316    (:verbose t)
1317    (:print t)
1318    (:external-format external-format-designator)
1319
1320    ;; extensions
1321    (:trace-file t)
1322    (:block-compile t)
1323    (:emit-cfasl t))
1324   (values (or pathname null) boolean boolean))
1325
1326 ;; FIXME: consider making (OR CALLABLE CONS) something like
1327 ;; EXTENDED-FUNCTION-DESIGNATOR
1328 (defknown disassemble ((or callable cons) &key
1329                        (:stream stream) (:use-labels t))
1330   null)
1331
1332 (defknown describe (t &optional (or stream (member t nil))) (values))
1333 (defknown inspect (t) (values))
1334 (defknown room (&optional (member t nil :default)) (values))
1335 (defknown ed (&optional (or symbol cons filename))
1336   t)
1337 (defknown dribble (&optional filename &key (:if-exists t)) (values))
1338
1339 (defknown apropos      (string-designator &optional package-designator t) (values))
1340 (defknown apropos-list (string-designator &optional package-designator t) list
1341   (flushable))
1342
1343 (defknown get-decoded-time ()
1344   (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1345           (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1346   (flushable))
1347
1348 (defknown get-universal-time () unsigned-byte (flushable))
1349
1350 (defknown decode-universal-time
1351           (unsigned-byte &optional (or null (rational -24 24)))
1352   (values (integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1353           (integer 1 12) unsigned-byte (integer 0 6) boolean (rational -24 24))
1354   (flushable))
1355
1356 (defknown encode-universal-time
1357   ((integer 0 59) (integer 0 59) (integer 0 23) (integer 1 31)
1358    (integer 1 12) unsigned-byte &optional (or null (rational -24 24)))
1359   unsigned-byte
1360   (flushable))
1361
1362 (defknown (get-internal-run-time get-internal-real-time)
1363   () internal-time (flushable))
1364
1365 (defknown sleep ((or (rational 0) (float 0.0))) null)
1366
1367 ;;; Even though ANSI defines LISP-IMPLEMENTATION-TYPE and
1368 ;;; LISP-IMPLEMENTATION-VERSION to possibly punt and return NIL, we
1369 ;;; know that there's no valid reason for our implementations to ever
1370 ;;; do so, so we can safely guarantee that they'll return strings.
1371 (defknown (lisp-implementation-type lisp-implementation-version)
1372   () simple-string (flushable))
1373
1374 ;;; For any of these functions, meaningful information might not be
1375 ;;; available, so -- unlike the related LISP-IMPLEMENTATION-FOO
1376 ;;; functions -- these really can return NIL.
1377 (defknown (machine-type machine-version machine-instance
1378            software-type software-version
1379            short-site-name long-site-name)
1380   () (or simple-string null) (flushable))
1381
1382 (defknown identity (t) t (movable foldable flushable unsafe)
1383   :derive-type #'result-type-first-arg)
1384
1385 (defknown constantly (t) function (movable flushable))
1386 (defknown complement (function) function (movable flushable))
1387 \f
1388 ;;;; miscellaneous extensions
1389
1390 (defknown symbol-global-value (symbol) t ())
1391 (defknown set-symbol-global-value (symbol t) t ())
1392
1393 (defknown get-bytes-consed () unsigned-byte (flushable))
1394 (defknown mask-signed-field ((integer 0 *) integer) integer
1395           (movable flushable foldable))
1396
1397 (defknown array-storage-vector (array) (simple-array * (*))
1398     (any))
1399 \f
1400 ;;;; magical compiler frobs
1401
1402 (defknown %values-list-or-context (t t t) * (always-translatable))
1403
1404 (defknown %unary-truncate/single-float (single-float) integer (movable foldable flushable))
1405 (defknown %unary-truncate/double-float (double-float) integer (movable foldable flushable))
1406
1407 ;;; We can't fold this in general because of SATISFIES. There is a
1408 ;;; special optimizer anyway.
1409 (defknown %typep (t (or type-specifier ctype)) boolean
1410   (movable flushable explicit-check))
1411 (defknown %instance-typep (t (or type-specifier ctype)) boolean
1412   (movable flushable explicit-check always-translatable))
1413
1414 (defknown %cleanup-point () t)
1415 (defknown %special-bind (t t) t)
1416 (defknown %special-unbind (t) t)
1417 (defknown %listify-rest-args (t index) list (flushable))
1418 (defknown %more-arg-context (t t) (values t index) (flushable))
1419 (defknown %more-arg (t index) t)
1420 #!+stack-grows-downward-not-upward
1421 ;;; FIXME: The second argument here should really be NEGATIVE-INDEX, but doing that
1422 ;;; breaks the build, and I cannot seem to figure out why. --NS 2006-06-29
1423 (defknown %more-kw-arg (t fixnum) (values t t))
1424 (defknown %more-arg-values (t index index) * (flushable))
1425 (defknown %verify-arg-count (index index) (values))
1426 (defknown %arg-count-error (t) nil)
1427 (defknown %unknown-values () *)
1428 (defknown %catch (t t) t)
1429 (defknown %unwind-protect (t t) t)
1430 (defknown (%catch-breakup %unwind-protect-breakup) () t)
1431 (defknown %lexical-exit-breakup (t) t)
1432 (defknown %continue-unwind (t t t) nil)
1433 (defknown %throw (t &rest t) nil) ; This is MV-called.
1434 (defknown %nlx-entry (t) *)
1435 (defknown %%primitive (t t &rest t) *)
1436 (defknown %pop-values (t) t)
1437 (defknown %nip-values (t t &rest t) (values))
1438 (defknown %allocate-closures (t) *)
1439 (defknown %type-check-error (t t) nil)
1440
1441 ;; FIXME: This function does not return, but due to the implementation
1442 ;; of FILTER-LVAR we cannot write it here.
1443 (defknown %compile-time-type-error (t t t t) *)
1444 (defknown sb!kernel::case-failure (t t t) nil)
1445
1446 (defknown %odd-key-args-error () nil)
1447 (defknown %unknown-key-arg-error (t) nil)
1448 (defknown (%ldb %mask-field) (bit-index bit-index integer) unsigned-byte
1449   (movable foldable flushable explicit-check))
1450 (defknown (%dpb %deposit-field) (integer bit-index bit-index integer) integer
1451   (movable foldable flushable explicit-check))
1452 (defknown %negate (number) number (movable foldable flushable explicit-check))
1453 (defknown %check-bound (array index fixnum) index (movable foldable flushable))
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   (unsafe explicit-check always-translatable))
1460 (defknown data-vector-set-with-offset (array index fixnum t) t
1461   (unsafe 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 (unsafe 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   (unsafe 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 (unsafe))
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 (unsafe))
1520 \f
1521 ;;;; SETF inverses
1522
1523 (defknown %aset (array &rest t) t (unsafe)
1524   :destroyed-constant-args (nth-constant-args 1))
1525 (defknown %set-row-major-aref (array index t) t (unsafe)
1526   :destroyed-constant-args (nth-constant-args 1))
1527 (defknown (%rplaca %rplacd) (cons t) t (unsafe)
1528   :destroyed-constant-args (nth-constant-args 1))
1529 (defknown %put (symbol t t) t (unsafe))
1530 (defknown %setelt (sequence index t) t (unsafe)
1531   :destroyed-constant-args (nth-constant-args 1))
1532 (defknown %svset (simple-vector index t) t (unsafe)
1533   :destroyed-constant-args (nth-constant-args 1))
1534 (defknown %bitset ((array bit) &rest index) bit (unsafe)
1535   :destroyed-constant-args (nth-constant-args 1))
1536 (defknown %sbitset ((simple-array bit) &rest index) bit (unsafe)
1537   :destroyed-constant-args (nth-constant-args 1))
1538 (defknown %charset (string index character) character (unsafe)
1539   :destroyed-constant-args (nth-constant-args 1))
1540 (defknown %scharset (simple-string index character) character (unsafe)
1541   :destroyed-constant-args (nth-constant-args 1))
1542 (defknown %set-symbol-value (symbol t) t (unsafe))
1543 (defknown (setf symbol-function) (function symbol) function (unsafe))
1544 (defknown %set-symbol-plist (symbol list) list (unsafe))
1545 (defknown %setnth (unsigned-byte list t) t (unsafe)
1546   :destroyed-constant-args (nth-constant-args 2))
1547 (defknown %set-fill-pointer (complex-vector index) index
1548     (unsafe 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     (unsafe 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 (unsafe))
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
1587 ;;;; memory barriers
1588
1589 (defknown sb!vm:%compiler-barrier () (values) ())
1590 (defknown sb!vm:%memory-barrier () (values) ())
1591 (defknown sb!vm:%read-barrier () (values) ())
1592 (defknown sb!vm:%write-barrier () (values) ())
1593 (defknown sb!vm:%data-dependency-barrier () (values) ())
1594
1595
1596 ;;;; atomic ops
1597 (defknown %compare-and-swap-svref (simple-vector index t t) t
1598     (unsafe))
1599 (defknown %compare-and-swap-instance-ref (instance index t t) t
1600     (unsafe))
1601 (defknown %compare-and-swap-symbol-value (symbol t t) t
1602     (unsafe unwind))
1603 (defknown spin-loop-hint () (values)
1604     (always-translatable))