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