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