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