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