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