[65b5ab]: src / compiler / fndb.lisp Maximize Restore History

Download this file

fndb.lisp    1597 lines (1352 with data), 62.3 kB

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