src/compiler/fndb.lisp

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