src/compiler/fndb.lisp

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