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