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