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
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.3" />
<title>CCACHE(1)</title>
<style type="text/css">
/* Sans-serif font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
div#toctitle,
span#author, span#revnumber, span#revdate, span#revremark,
div#footer {
font-family: Arial,Helvetica,sans-serif;
}
/* Serif font. */
div.sectionbody {
font-family: Georgia,"Times New Roman",Times,serif;
}
/* Monospace font. */
tt {
font-size: inherit;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
font-size: inherit;
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
}
div#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>CCACHE(1)</h1>
<span id="revnumber">version 3.1.6</span>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_name">Name</h2>
<div class="sectionbody">
<div class="paragraph"><p>ccache - a fast C/C++ compiler cache</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_synopsis">Synopsis</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><strong>ccache</strong> [<em>options</em>]
<strong>ccache</strong> <em>compiler</em> [<em>compiler options</em>]
<em>compiler</em> [<em>compiler options</em>] (via symbolic link)</pre>
<div class="attribution">
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>ccache is a compiler cache. It speeds up recompilation by caching the result of
previous compilations and detecting when the same compilation is being done
again. Supported languages are C, C++, Objective-C and Objective-C++.</p></div>
<div class="paragraph"><p>ccache has been carefully written to always produce exactly the same compiler
output that you would get without the cache. The only way you should be able to
tell that you are using ccache is the speed. Currently known exceptions to this
goal are listed under <a href="#_bugs">BUGS</a>. If you ever discover an undocumented case
where ccache changes the output of your compiler, please let us know.</p></div>
<div class="sect2">
<h3 id="_features">Features</h3>
<div class="ulist"><ul>
<li>
<p>
Keeps statistics on hits/misses.
</p>
</li>
<li>
<p>
Automatic cache size management.
</p>
</li>
<li>
<p>
Can cache compilations that generate warnings.
</p>
</li>
<li>
<p>
Easy installation.
</p>
</li>
<li>
<p>
Low overhead.
</p>
</li>
<li>
<p>
Optionally uses hard links where possible to avoid copies.
</p>
</li>
<li>
<p>
Optionally compresses files in the cache to reduce disk space.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_limitations">Limitations</h3>
<div class="ulist"><ul>
<li>
<p>
Only knows how to cache the compilation of a single
C/C++/Objective-C/Objective-C++ file. Other types of compilations
(multi-file compilation, linking, etc) will silently fall back to running the
real compiler.
</p>
</li>
<li>
<p>
Only works with GCC and compilers that behave similar enough.
</p>
</li>
<li>
<p>
Some compiler flags are not supported. If such a flag is detected, ccache
will silently fall back to running the real compiler.
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_run_modes">Run modes</h2>
<div class="sectionbody">
<div class="paragraph"><p>There are two ways to use ccache. You can either prefix your compilation
commands with <strong>ccache</strong> or you can let ccache masquerade as the compiler by
creating a symbolic link (named as the compiler) to ccache. The first method is
most convenient if you just want to try out ccache or wish to use it for some
specific projects. The second method is most useful for when you wish to use
ccache for all your compilations.</p></div>
<div class="paragraph"><p>To use the first method, just make sure that <strong>ccache</strong> is in your <strong>PATH</strong>.</p></div>
<div class="paragraph"><p>To use the symlinks method, do something like this:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>cp ccache /usr/local/bin/
ln -s ccache /usr/local/bin/gcc
ln -s ccache /usr/local/bin/g++
ln -s ccache /usr/local/bin/cc
ln -s ccache /usr/local/bin/c++</tt></pre>
</div></div>
<div class="paragraph"><p>And so forth. This will work as long as the directory with symlinks comes
before the path to the compiler (which is usually in <tt>/usr/bin</tt>). After
installing you may wish to run “which gcc” to make sure that the correct link
is being used.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">The technique of letting ccache masquerade as the compiler works well,
but currently doesn’t interact well with other tools that do the same thing.
See <a href="#_using_ccache_with_other_compiler_wrappers">USING CCACHE WITH OTHER COMPILER WRAPPERS</a>.</td>
</tr></table>
</div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Warning</div>
</td>
<td class="content">Do not use a hard link, use a symbolic link. A hard link will cause
“interesting” problems.</td>
</tr></table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_options">Options</h2>
<div class="sectionbody">
<div class="paragraph"><p>These options only apply when you invoke ccache as “ccache”. When invoked as
a compiler (via a symlink as described in the previous section), the normal
compiler options apply and you should refer to the compiler’s documentation.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>-c, --cleanup</strong>
</dt>
<dd>
<p>
Clean up the cache by removing old cached files until the specified file
number and cache size limits are not exceeded. This also recalculates the
cache file count and size totals. Normally, it’s not needed to initiate
cleanup manually as ccache keeps the cache below the specified limits at
runtime and keeps statistics up to date on each compilation. Forcing a
cleanup is mostly useful if you manually modify the cache contents or
believe that the cache size statistics may be inaccurate.
</p>
</dd>
<dt class="hdlist1">
<strong>-C, --clear</strong>
</dt>
<dd>
<p>
Clear the entire cache, removing all cached files.
</p>
</dd>
<dt class="hdlist1">
<strong>-F, --max-files</strong>=<em>N</em>
</dt>
<dd>
<p>
Set the maximum number of files allowed in the cache. The value is stored
inside the cache directory and applies to all future compilations. Due to
the way the value is stored the actual value used is always rounded down to
the nearest multiple of 16.
</p>
</dd>
<dt class="hdlist1">
<strong>-h, --help</strong>
</dt>
<dd>
<p>
Print an options summary page.
</p>
</dd>
<dt class="hdlist1">
<strong>-M, --max-size</strong>=<em>SIZE</em>
</dt>
<dd>
<p>
Set the maximum size of the files stored in the cache. You can specify a
value in gigabytes, megabytes or kilobytes by appending a G, M or K to the
value. The default is gigabytes. The actual value stored is rounded down to
the nearest multiple of 16 kilobytes.
</p>
</dd>
<dt class="hdlist1">
<strong>-s, --show-stats</strong>
</dt>
<dd>
<p>
Print the current statistics summary for the cache.
</p>
</dd>
<dt class="hdlist1">
<strong>-V, --version</strong>
</dt>
<dd>
<p>
Print version and copyright information.
</p>
</dd>
<dt class="hdlist1">
<strong>-z, --zero-stats</strong>
</dt>
<dd>
<p>
Zero the cache statistics (but not the configured limits).
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_extra_options">Extra options</h2>
<div class="sectionbody">
<div class="paragraph"><p>When run as a compiler, ccache usually just takes the same command line options
as the compiler you are using. The only exception to this is the option
<strong>--ccache-skip</strong>. That option can be used to tell ccache to avoid interpreting
the next option in any way and to pass it along to the compiler as-is.</p></div>
<div class="paragraph"><p>The reason this can be important is that ccache does need to parse the command
line and determine what is an input filename and what is a compiler option, as
it needs the input filename to determine the name of the resulting object file
(among other things). The heuristic ccache uses when parsing the command line
is that any argument that exists as a file is treated as an input file name. By
using <strong>--ccache-skip</strong> you can force an option to not be treated as an input
file name and instead be passed along to the compiler as a command line option.</p></div>
<div class="paragraph"><p>Another case where <strong>--ccache-skip</strong> can be useful is if ccache interprets an
option specially but shouldn’t, since the option has another meaning for your
compiler than what ccache thinks.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_environment_variables">Environment variables</h2>
<div class="sectionbody">
<div class="paragraph"><p>ccache uses a number of environment variables to control operation. In most
cases you won’t need any of these as the defaults will be fine.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>CCACHE_BASEDIR</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_BASEDIR</strong> to an absolute path to
a directory, ccache rewrites absolute paths into relative paths before
computing the hash that identifies the compilation, but only for paths
under the specified directory. See the discussion under
<a href="#_compiling_in_different_directories">COMPILING IN DIFFERENT DIRECTORIES</a>.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_CC</strong>
</dt>
<dd>
<p>
You can optionally set <strong>CCACHE_CC</strong> to force the name of the compiler to
use. If you don’t do this then ccache works it out from the command line.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_COMPILERCHECK</strong>
</dt>
<dd>
<p>
By default, ccache includes the modification time (“mtime”) and size of
the compiler in the hash to ensure that results retrieved from the cache
are accurate. The <strong>CCACHE_COMPILERCHECK</strong> environment variable can be used
to select another strategy. Possible values are:
</p>
<div class="openblock">
<div class="content">
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>content</strong>
</dt>
<dd>
<p>
Hash the content of the compiler binary. This makes ccache very slightly
slower compared to the <strong>mtime</strong> setting, but makes it cope better with
compiler upgrades during a build bootstrapping process.
</p>
</dd>
<dt class="hdlist1">
<strong>mtime</strong>
</dt>
<dd>
<p>
Hash the compiler’s mtime and size, which is fast. This is the default.
</p>
</dd>
<dt class="hdlist1">
<strong>none</strong>
</dt>
<dd>
<p>
Don’t hash anything. This may be good for situations where you can safely
use the cached results even though the compiler’s mtime or size has changed
(e.g. if the compiler is built as part of your build system and the
compiler’s source has not changed, or if the compiler only has changes that
don’t affect code generation). You should only use the <strong>none</strong> setting if
you know what you are doing.
</p>
</dd>
<dt class="hdlist1">
<em>a command string</em>
</dt>
<dd>
<p>
Hash the standard output and standard error output of the specified
command. The string will be split on whitespace to find out the command and
arguments to run. No other interpretation of the command string will be
done, except that the special word “%compiler%” will be replaced with the
path to the compiler. Several commands can be specified with semicolon as
separator. Examples:
</p>
<div class="openblock">
<div class="content">
<div class="ulist"><ul>
<li>
<p>
<tt>%compiler% -v</tt>
</p>
</li>
<li>
<p>
<tt>%compiler% -dumpmachine; %compiler% -dumpversion</tt>
</p>
</li>
</ul></div>
<div class="paragraph"><p>You should make sure that the specified command is as fast as possible since it
will be run once for each ccache invocation.</p></div>
<div class="paragraph"><p>Identifying the compiler using a command is useful if you want to avoid cache
misses when the compiler has been rebuilt but not changed.</p></div>
<div class="paragraph"><p>Another case is when the compiler (as seen by ccache) actually isn’t the real
compiler but another compiler wrapper — in that case, the default <strong>mtime</strong>
method will hash the mtime and size of the other compiler wrapper, which means
that ccache won’t be able to detect a compiler upgrade. Using a suitable
command to identify the compiler is thus safer, but it’s also slower, so you
should consider continue using the <strong>mtime</strong> method in combination with
<strong>CCACHE_PREFIX</strong> if possible. See
<a href="#_using_ccache_with_other_compiler_wrappers">USING CCACHE WITH OTHER COMPILER WRAPPERS</a>.</p></div>
</div></div>
</dd>
</dl></div>
</div></div>
</dd>
<dt class="hdlist1">
<strong>CCACHE_COMPRESS</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_COMPRESS</strong> then ccache will
compress object files and other compiler output it puts in the cache.
However, this setting has no effect on how files are retrieved from the
cache; compressed and uncompressed results will still be usable regardless
of this setting.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_CPP2</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_CPP2</strong> then ccache will not use
the optimisation of avoiding the second call to the preprocessor by
compiling the preprocessed output that was used for finding the hash in the
case of a cache miss. This is primarily a debugging option, although it is
possible that some unusual compilers will have problems with the
intermediate filename extensions used in this optimisation, in which case
this option could allow ccache to be used anyway.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_DETECT_SHEBANG</strong>
</dt>
<dd>
<p>
The <strong>CCACHE_DETECT_SHEBANG</strong> environment variable only has meaning on
Windows. It instructs ccache to open the executable file to detect the
<strong>#!/bin/sh</strong> string, in which case ccache will search for <strong>sh.exe</strong> in
<strong>PATH</strong> and use that to launch the executable.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_DIR</strong>
</dt>
<dd>
<p>
The <strong>CCACHE_DIR</strong> environment variable specifies where ccache will keep its
cached compiler output. The default is <strong>$HOME/.ccache</strong>.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_DISABLE</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_DISABLE</strong> then ccache will just
call the real compiler, bypassing the cache completely.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_EXTENSION</strong>
</dt>
<dd>
<p>
ccache tries to automatically determine the extension to use for
intermediate preprocessor files based on the type of file being compiled.
Unfortunately this sometimes doesn’t work, for example when using the
“aCC” compiler on HP-UX. On systems like this you can use the
<strong>CCACHE_EXTENSION</strong> option to override the default. On HP-UX set this
environment variable to <strong>i</strong> if you use the “aCC” compiler.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_EXTRAFILES</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_EXTRAFILES</strong> to a list of paths
then ccache will include the contents of those files when calculating the
hash sum. The list separator is semicolon in Windows systems and colon on
other systems.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_HARDLINK</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_HARDLINK</strong> then ccache will
attempt to use hard links from the cache directory when creating the
compiler output rather than using a file copy. Using hard links may be
slightly faster in some situations, but can confuse programs like “make”
that rely on modification times. Another thing to keep in mind is that if
the resulting object file is modified in any way, this corrupts the cached
object file as well. Hard links are never made for compressed cache files.
This means that you should not set the <strong>CCACHE_COMPRESS</strong> variable if you
want to use hard links.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_HASHDIR</strong>
</dt>
<dd>
<p>
This tells ccache to hash the current working directory when calculating
the hash that is used to distinguish two compilations. This prevents a
problem with the storage of the current working directory in the debug info
of a object file, which can lead ccache to give a cached object file that
has the working directory in the debug info set incorrectly. This option is
off by default as the incorrect setting of this debug info rarely causes
problems. If you strike problems with GDB not using the correct directory
then enable this option.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_LOGFILE</strong>
</dt>
<dd>
<p>
If you set the <strong>CCACHE_LOGFILE</strong> environment variable then ccache will write
information on what it is doing to the specified file. This is useful for
tracking down problems.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_NLEVELS</strong>
</dt>
<dd>
<p>
The environment variable <strong>CCACHE_NLEVELS</strong> allows you to choose the number
of levels of hash in the cache directory. The default is 2. The minimum is
1 and the maximum is 8.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_NODIRECT</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_NODIRECT</strong> then ccache will not
use the direct mode.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_NOSTATS</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_NOSTATS</strong> then ccache will not
update the statistics files on each compilation.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_PATH</strong>
</dt>
<dd>
<p>
You can optionally set <strong>CCACHE_PATH</strong> to a colon-separated path where ccache
will look for the real compilers. If you don’t do this then ccache will
look for the first executable matching the compiler name in the normal
<strong>PATH</strong> that isn’t a symbolic link to ccache itself.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_PREFIX</strong>
</dt>
<dd>
<p>
This option adds a prefix to the command line that ccache runs when
invoking the compiler. Also see the section below on using ccache with
“distcc”.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_READONLY</strong>
</dt>
<dd>
<p>
The <strong>CCACHE_READONLY</strong> environment variable tells ccache to attempt to use
existing cached object files, but not to try to add anything new to the
cache. If you are using this because your <strong>CCACHE_DIR</strong> is read-only, then
you may find that you also need to set <strong>CCACHE_TEMPDIR</strong> as otherwise ccache
will fail to create temporary files.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_RECACHE</strong>
</dt>
<dd>
<p>
This forces ccache to not use any cached results, even if it finds them.
New results are still cached, but existing cache entries are ignored.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_SLOPPINESS</strong>
</dt>
<dd>
<p>
By default, ccache tries to give as few false cache hits as possible.
However, in certain situations it’s possible that you know things that
ccache can’t take for granted. The <strong>CCACHE_SLOPPINESS</strong> environment variable
makes it possible to tell ccache to relax some checks in order to increase
the hit rate. The value should be a comma-separated string with options.
Available options are:
</p>
<div class="openblock">
<div class="content">
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>file_macro</strong>
</dt>
<dd>
<p>
Ignore <strong>__FILE__</strong> being present in the source.
</p>
</dd>
<dt class="hdlist1">
<strong>include_file_mtime</strong>
</dt>
<dd>
<p>
Don’t check the modification time of include files in the direct mode.
</p>
</dd>
<dt class="hdlist1">
<strong>time_macros</strong>
</dt>
<dd>
<p>
Ignore <strong>__DATE__</strong> and <strong>__TIME__</strong> being present in the source code.
</p>
</dd>
</dl></div>
</div></div>
<div class="paragraph"><p>See the discussion under <a href="#_troubleshooting">TROUBLESHOOTING</a> for more
information.</p></div>
</dd>
<dt class="hdlist1">
<strong>CCACHE_TEMPDIR</strong>
</dt>
<dd>
<p>
The <strong>CCACHE_TEMPDIR</strong> environment variable specifies where ccache will put
temporary files. The default is <strong>$CCACHE_DIR/tmp</strong>.
</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">In previous versions of ccache, <strong>CCACHE_TEMPDIR</strong> had to be on the same
filesystem as the <strong>CCACHE_DIR</strong> path, but this requirement has been
relaxed.)</td>
</tr></table>
</div>
</dd>
<dt class="hdlist1">
<strong>CCACHE_UMASK</strong>
</dt>
<dd>
<p>
This sets the umask for ccache and all child processes (such as the
compiler). This is mostly useful when you wish to share your cache with
other users. Note that this also affects the file permissions set on the
object files created from your compilations.
</p>
</dd>
<dt class="hdlist1">
<strong>CCACHE_UNIFY</strong>
</dt>
<dd>
<p>
If you set the environment variable <strong>CCACHE_UNIFY</strong> then ccache will use a
C/C++ unifier when hashing the preprocessor output if the <strong>-g</strong> option is
not used. The unifier is slower than a normal hash, so setting this
environment variable loses a little bit of speed, but it means that ccache
can take advantage of not recompiling when the changes to the source code
consist of reformatting only. Note that using <strong>CCACHE_UNIFY</strong> changes the
hash, so cached compilations with <strong>CCACHE_UNIFY</strong> set cannot be used when
<strong>CCACHE_UNIFY</strong> is not set and vice versa. The reason the unifier is off by
default is that it can give incorrect line number information in compiler
warning messages. Also note that enabling the unifier implies turning off
the direct mode.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_cache_size_management">Cache size management</h2>
<div class="sectionbody">
<div class="paragraph"><p>By default ccache has a one gigabyte limit on the total size of files in the
cache and no maximum number of files. You can set different limits using the
<strong>-M</strong>/<strong>--max-size</strong> and <strong>-F</strong>/<strong>--max-files</strong> options. Use <strong>ccache -s/--show-stats</strong>
to see the cache size and the currently configured limits (in addition to other
various statistics).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_cache_compression">Cache compression</h2>
<div class="sectionbody">
<div class="paragraph"><p>ccache can optionally compress all files it puts into the cache using the
compression library zlib. While this involves a negligible performance
slowdown, it significantly increases the number of files that fit in the cache.
You can turn on compression by setting the <strong>CCACHE_COMPRESS</strong> environment
variable.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_how_ccache_works">How ccache works</h2>
<div class="sectionbody">
<div class="paragraph"><p>The basic idea is to detect when you are compiling exactly the same code a
second time and reuse the previously produced output. The detection is done by
hashing different kinds of information that should be unique for the
compilation and then using the hash sum to identify the cached output. ccache
uses MD4, a very fast cryptographic hash algorithm, for the hashing. (MD4 is
nowadays too weak to be useful in cryptographic contexts, but it should be safe
enough to be used to identify recompilations.) On a cache hit, ccache is able
to supply all of the correct compiler outputs (including all warnings,
dependency file, etc) from the cache.</p></div>
<div class="paragraph"><p>ccache has two ways of doing the detection:</p></div>
<div class="ulist"><ul>
<li>
<p>
the <strong>direct mode</strong>, where ccache hashes the source code and include files
directly
</p>
</li>
<li>
<p>
the <strong>preprocessor mode</strong>, where ccache runs the preprocessor on the source
code and hashes the result
</p>
</li>
</ul></div>
<div class="paragraph"><p>The direct mode is generally faster since running the preprocessor has some
overhead.</p></div>
<div class="sect2">
<h3 id="_common_hashed_information">Common hashed information</h3>
<div class="paragraph"><p>For both modes, the following information is included in the hash:</p></div>
<div class="ulist"><ul>
<li>
<p>
the extension used by the compiler for a file with preprocessor output
(normally <strong>.i</strong> for C code and <strong>.ii</strong> for C++ code)
</p>
</li>
<li>
<p>
the compiler’s size and modification time (or other compiler-specific
information specified by <strong>CCACHE_COMPILERCHECK</strong>)
</p>
</li>
<li>
<p>
the name of the compiler
</p>
</li>
<li>
<p>
the current directory (if <strong>CCACHE_HASHDIR</strong> is set)
</p>
</li>
<li>
<p>
contents of files specified by <strong>CCACHE_EXTRAFILES</strong> (if any)
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_the_direct_mode">The direct mode</h3>
<div class="paragraph"><p>In the direct mode, the hash is formed of the common information and:</p></div>
<div class="ulist"><ul>
<li>
<p>
the input source file
</p>
</li>
<li>
<p>
the command line options
</p>
</li>
</ul></div>
<div class="paragraph"><p>Based on the hash, a data structure called “manifest” is looked up in the
cache. The manifest contains:</p></div>
<div class="ulist"><ul>
<li>
<p>
references to cached compilation results (object file, dependency file, etc)
that were produced by previous compilations that matched the hash
</p>
</li>
<li>
<p>
paths to the include files that were read at the time the compilation results
were stored in the cache
</p>
</li>
<li>
<p>
hash sums of the include files at the time the compilation results were
stored in the cache
</p>
</li>
</ul></div>
<div class="paragraph"><p>The current contents of the include files are then hashed and compared to the
information in the manifest. If there is a match, ccache knows the result of
the compilation. If there is no match, ccache falls back to running the
preprocessor. The output from the preprocessor is parsed to find the include
files that were read. The paths and hash sums of those include files are then
stored in the manifest along with information about the produced compilation
result.</p></div>
<div class="paragraph"><p>The direct mode will be disabled if any of the following holds:</p></div>
<div class="ulist"><ul>
<li>
<p>
the environment variable <strong>CCACHE_NODIRECT</strong> is set
</p>
</li>
<li>
<p>
a modification time of one of the include files is too new (needed to avoid a
race condition)
</p>
</li>
<li>
<p>
the unifier is enabled (the environment variable <strong>CCACHE_UNIFY</strong> is set)
</p>
</li>
<li>
<p>
a compiler option not supported by the direct mode is used:
</p>
<div class="ulist"><ul>
<li>
<p>
a <strong>-Wp,<em>X</em></strong> compiler option other than <strong>-Wp,-MD,<em>path</em></strong> and
<strong>-Wp,-MMD,<em>path</em></strong>
</p>
</li>
<li>
<p>
<strong>-Xpreprocessor</strong>
</p>
</li>
</ul></div>
</li>
<li>
<p>
the string “__TIME__” is present outside comments and string literals in
the source code
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_the_preprocessor_mode">The preprocessor mode</h3>
<div class="paragraph"><p>In the preprocessor mode, the hash is formed of the common information and:</p></div>
<div class="ulist"><ul>
<li>
<p>
the preprocessor output from running the compiler with <strong>-E</strong>
</p>
</li>
<li>
<p>
the command line options except options that affect include files (<strong>-I</strong>,
<strong>-include</strong>, <strong>-D</strong>, etc; the theory is that these options will change the
preprocessor output if they have any effect at all)
</p>
</li>
<li>
<p>
any standard error output generated by the preprocessor
</p>
</li>
</ul></div>
<div class="paragraph"><p>Based on the hash, the cached compilation result can be looked up directly in
the cache.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_compiling_in_different_directories">Compiling in different directories</h2>
<div class="sectionbody">
<div class="paragraph"><p>Some information included in the hash that identifies a unique compilation may
contain absolute paths:</p></div>
<div class="ulist"><ul>
<li>
<p>
The preprocessed source code may contain absolute paths to include files if
the compiler option <strong>-g</strong> is used or if absolute paths are given to <strong>-I</strong> and
similar compiler options.
</p>
</li>
<li>
<p>
Paths specified by compiler options (such as <strong>-I</strong>, <strong>-MF</strong>, etc) may be
absolute.
</p>
</li>
<li>
<p>
The source code file path may be absolute, and that path may substituted for
<strong>__FILE__</strong> macros in the source code or included in warnings emitted to
standard error by the preprocessor.
</p>
</li>
</ul></div>
<div class="paragraph"><p>This means that if you compile the same code in different locations, you can’t
share compilation results between the different build directories since you get
cache misses because of the absolute build directory paths that are part of the
hash. To mitigate this problem, you can specify a “base directory” by setting
the <strong>CCACHE_BASEDIR</strong> variable to an absolute path to the directory. ccache will
then rewrite absolute paths that are under the base directory (i.e., paths that
have the base directory as a prefix) to relative paths when constructing the
hash. A typical path to use as the base directory is your home directory or
another directory that is a parent of your build directories. (Don’t use <tt>/</tt> as
the base directory since that will make ccache also rewrite paths to system
header files, which doesn’t gain anything.)</p></div>
<div class="paragraph"><p>The drawbacks of using <strong>CCACHE_BASEDIR</strong> are:</p></div>
<div class="ulist"><ul>
<li>
<p>
If you specify an absolute path to the source code file, <strong>__FILE__</strong> macros
will be expanded to a relative path instead.
</p>
</li>
<li>
<p>
If you specify an absolute path to the source code file and compile with
<strong>-g</strong>, the source code path stored in the object file may point to the wrong
directory, which may prevent debuggers like GDB from finding the source code.
Sometimes, a work-around is to change the directory explicitly with the
“cd” command in GDB.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_precompiled_headers">Precompiled headers</h2>
<div class="sectionbody">
<div class="paragraph"><p>ccache has support for GCC’s precompiled headers. However, you have to do some
things to make it work properly:</p></div>
<div class="ulist"><ul>
<li>
<p>
You must set <strong>CCACHE_SLOPPINESS</strong> to <strong>time_macros</strong>. The reason is that ccache
can’t tell whether <strong>__TIME__</strong> or <strong>__DATE__</strong> is used when using a
precompiled header.
</p>
</li>
<li>
<p>
You must either:
</p>
<div class="openblock">
<div class="content">
<div class="ulist"><ul>
<li>
<p>
use the <strong>-include</strong> compiler option to include the precompiled header
(i.e., don’t use <strong>#include</strong> in the source code to include the header); or
</p>
</li>
<li>
<p>
add the <strong>-fpch-preprocess</strong> compiler option when compiling.
</p>
</li>
</ul></div>
<div class="paragraph"><p>If you don’t do this, either the non-precompiled version of the header file
will be used (if available) or ccache will fall back to running the real
compiler and increase the statistics counter “preprocessor error” (if the
non-precompiled header file is not available).</p></div>
</div></div>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_sharing_a_cache">Sharing a cache</h2>
<div class="sectionbody">
<div class="paragraph"><p>A group of developers can increase the cache hit rate by sharing a cache
directory. To share a cache without unpleasant side effects, the following
conditions should to be met:</p></div>
<div class="ulist"><ul>
<li>
<p>
Use the same <strong>CCACHE_DIR</strong> environment variable setting.
</p>
</li>
<li>
<p>
Unset the <strong>CCACHE_HARDLINK</strong> environment variable.
</p>
</li>
<li>
<p>
Make sure everyone sets the <strong>CCACHE_UMASK</strong> environment variable to 002. This
ensures that cached files are accessible to everyone in the group.
</p>
</li>
<li>
<p>
Make sure that all users have write permission in the entire cache directory
(and that you trust all users of the shared cache).
</p>
</li>
<li>
<p>
Make sure that the setgid bit is set on all directories in the cache. This
tells the filesystem to inherit group ownership for new directories. The
command “find $CCACHE_DIR -type d | xargs chmod g+s” might be useful for
this.
</p>
</li>
</ul></div>
<div class="paragraph"><p>The reason to avoid the hard link mode is that the hard links cause unwanted
side effects, as all links to a cached file share the file’s modification
timestamp. This results in false dependencies to be triggered by
timestamp-based build systems whenever another user links to an existing file.
Typically, users will see that their libraries and binaries are relinked
without reason.</p></div>
<div class="paragraph"><p>You may also want to make sure that the developers have <strong>CCACHE_BASEDIR</strong> set
appropriately, as discussed in the previous section.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_sharing_a_cache_on_nfs">Sharing a cache on NFS</h2>
<div class="sectionbody">
<div class="paragraph"><p>It is possible to put the cache directory on an NFS filesystem (or similar
filesystems), but keep in mind that:</p></div>
<div class="ulist"><ul>
<li>
<p>
Having the cache on NFS may slow down compilation. Make sure to do some
benchmarking to see if it’s worth it.
</p>
</li>
<li>
<p>
ccache hasn’t been tested very thoroughly on NFS.
</p>
</li>
</ul></div>
<div class="paragraph"><p>A tip is to set <strong>CCACHE_TEMPDIR</strong> to a directory on the local host to avoid NFS
traffic for temporary files.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_using_ccache_with_other_compiler_wrappers">Using ccache with other compiler wrappers</h2>
<div class="sectionbody">
<div class="paragraph"><p>The recommended way of combining ccache with another compiler wrapper (such as
“distcc”) is by using the <strong>CCACHE_PREFIX</strong> option. You just need to set the
environment variable <strong>CCACHE_PREFIX</strong> to the name of the wrapper (e.g. <strong>distcc</strong>)
and ccache will prefix the command line with the specified command when running
the compiler.</p></div>
<div class="paragraph"><p>Unless you set <strong>CCACHE_COMPILERCHECK</strong> to a suitable command (see the
description of that configuration option), it is not recommended to use the
form <strong>ccache anotherwrapper compiler args</strong> as the compilation command. It’s
also not recommended to use the masquerading technique for the other compiler
wrapper. The reason is that by default, ccache will in both cases hash the
mtime and size of the other wrapper instead of the real compiler, which means
that:</p></div>
<div class="ulist"><ul>
<li>
<p>
Compiler upgrades will not be detected properly.
</p>
</li>
<li>
<p>
The cached results will not be shared between compilations with and without
the other wrapper.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Another minor thing is that if <strong>CCACHE_PREFIX</strong> is not used, ccache will
needlessly invoke the other wrapper when running the preprocessor.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_bugs">Bugs</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
ccache doesn’t handle the GNU Assembler’s <strong>.incbin</strong> directive correctly. This
directive can be embedded in the source code inside an <strong><em>asm</em></strong> statement in
order to include a file verbatim in the object file. If the included file is
modified, ccache doesn’t pick up the change since the inclusion isn’t done by
the preprocessor. A workaround of this problem is to set <strong>CCACHE_EXTRAFILES</strong>
to the path of the included file.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_troubleshooting">Troubleshooting</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_general">General</h3>
<div class="paragraph"><p>A general tip for getting information about what ccache is doing is to enable
debug logging by setting <strong>CCACHE_LOGFILE</strong>. The log contains executed commands,
important decisions that ccache makes, read and written files, etc. Another way
of keeping track of what is happening is to check the output of <strong>ccache -s</strong>.</p></div>
</div>
<div class="sect2">
<h3 id="_performance">Performance</h3>
<div class="paragraph"><p>ccache has been written to perform well out of the box, but sometimes you may
have to do some adjustments of how you use the compiler and ccache in order to
improve performance.</p></div>
<div class="paragraph"><p>Since ccache works best when I/O is fast, put the cache directory on a fast
storage device if possible. Having lots of free memory so that files in the
cache directory stay in the disk cache is also preferrable.</p></div>
<div class="paragraph"><p>A good way of monitoring how well ccache works is to run <strong>ccache -s</strong> before and
after your build and then compare the statistics counters. Here are some common
problems and what may be done to increase the hit rate:</p></div>
<div class="ulist"><ul>
<li>
<p>
If “cache hit (preprocessed)” has been incremented instead of “cache hit
(direct)”, ccache has fallen back to preprocessor mode, which is generally
slower. Some possible reasons are:
</p>
<div class="ulist"><ul>
<li>
<p>
The source code has been modified in such a way that the preprocessor output
is not affected.
</p>
</li>
<li>
<p>
Compiler arguments that are hashed in the direct mode but not in the
preprocessor mode have changed (<strong>-I</strong>, <strong>-include</strong>, <strong>-D</strong>, etc) and they didn’t
affect the preprocessor output.
</p>
</li>
<li>
<p>
The compiler option <strong>-Xpreprocessor</strong> or <strong>-Wp,<em>X</em></strong> (except <strong>-Wp,-MD,<em>path</em></strong>
and <strong>Wp,-MMD,<em>path</em></strong>) is used.
</p>
</li>
<li>
<p>
This was the first compilation with a new value of <strong>CCACHE_BASEDIR</strong>.
</p>
</li>
<li>
<p>
A modification time of one of the include files is too new (created the same
second as the compilation is being done). This check is made to avoid a race
condition. To fix this, create the include file earlier in the build
process, if possible, or set <strong>CCACHE_SLOPPINESS</strong> to <strong>include_file_mtime</strong> if
you are willing to take the risk. (The race condition consists of these
events: the preprocessor is run; an include file is modified by someone; the
new include file is hashed by ccache; the real compiler is run on the
preprocessor’s output, which contains data from the old header file; the
wrong object file is stored in the cache.)
</p>
</li>
<li>
<p>
The <strong>__TIME__</strong> preprocessor macro is (potentially) being used. ccache
turns off direct mode if “__TIME__” is present in the source code
outside comments and string literals. This is done as a safety measure since
the string indicates that a <strong>__TIME__</strong> macro <em>may</em> affect the output. (To
be sure, ccache would have to run the preprocessor, but the sole point of
the direct mode is to avoid that.) If you know that <strong>__TIME__</strong> isn’t used
in practise, or don’t care if ccache produces objects where <strong>__TIME__</strong> is
expanded to something in the past, you can set <strong>CCACHE_SLOPPINESS</strong> to
<strong>time_macros</strong>.
</p>
</li>
<li>
<p>
The <strong>__DATE__</strong> preprocessor macro is (potentially) being used and the
date has changed. This is similar to how <strong>__TIME__</strong> is handled. If
“__DATE__” is present in the source code outside comments and string
literals, ccache hashes the current date in order to be able to produce the
correct object file if the <strong>__DATE__</strong> macro affects the output. If you
know that <strong>__DATE__</strong> isn’t used in practise, or don’t care if ccache
produces objects where <strong>__DATE__</strong> is expanded to something in the past,
you can set <strong>CCACHE_SLOPPINESS</strong> to <strong>time_macros</strong>.
</p>
</li>
<li>
<p>
The <strong>__FILE__</strong> preprocessor macro is (potentially) being used and the
file path has changed. If “__FILE__” is present in the source code
outside comments and string literals, ccache hashes the current input file
path in order to be able to produce the correct object file if the
<strong>__FILE__</strong> macro affects the output. If you know that <strong>__FILE__</strong> isn’t
used in practise, or don’t care if ccache produces objects where
<strong>__FILE__</strong> is expanded to the wrong path, you can set <strong>CCACHE_SLOPPINESS</strong>
to <strong>file_macro</strong>.
</p>
</li>
</ul></div>
</li>
<li>
<p>
If “cache miss” has been incremented even though the same code has been
compiled and cached before, ccache has either detected that something has
changed anyway or a cleanup has been performed (either explicitly or
implicitly when a cache limit has been reached). Some perhaps unobvious
things that may result in a cache miss are usage of <strong>__TIME__</strong> or
<strong>__DATE__</strong> macros, or use of automatically generated code that contains a
timestamp, build counter or other volatile information.
</p>
</li>
<li>
<p>
If “multiple source files” has been incremented, it’s an indication that
the compiler has been invoked on several source code files at once. ccache
doesn’t support that. Compile the source code files separately if possible.
</p>
</li>
<li>
<p>
If “unsupported compiler option” has been incremented, enable debug logging
and check which option was rejected.
</p>
</li>
<li>
<p>
If “preprocessor error” has been incremented, one possible reason is that
precompiled headers are being used. See <a href="#_precompiled_headers">PRECOMPILED HEADERS</a> for how to remedy this.
</p>
</li>
<li>
<p>
If “can’t use precompiled header” has been incremented, see
<a href="#_precompiled_headers">PRECOMPILED HEADERS</a>.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_errors_when_compiling_with_ccache">Errors when compiling with ccache</h3>
<div class="paragraph"><p>If compilation doesn’t work with ccache, but it works without it, one possible
reason is that the compiler can’t compile preprocessed output correctly. A
workaround that may work is to set <strong>CCACHE_CPP2</strong>. This will make cache misses
slower, though, so it is better to find and fix the root cause.</p></div>
</div>
<div class="sect2">
<h3 id="_corrupt_object_files">Corrupt object files</h3>
<div class="paragraph"><p>It should be noted that ccache is susceptible to general storage problems. If a
bad object file sneaks into the cache for some reason, it will of course stay
bad. Some possible reasons for erroneous object files are bad hardware (disk
drive, disk controller, memory, etc), buggy drivers or file systems, a bad
<strong>CCACHE_PREFIX</strong> command or compiler wrapper. If this happens, you can either
find out which object file is broken by reading the debug log and then delete
the bad object file from the cache, or you can simply clear the whole cache
with <strong>ccache -C</strong> if you don’t mind losing other cached results.</p></div>
<div class="paragraph"><p>There are no reported issues about ccache producing broken object files
reproducibly. That doesn’t mean it can’t happen, so if you find a repeatable
case, please report it.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_more_information">More information</h2>
<div class="sectionbody">
<div class="paragraph"><p>Credits, mailing list information, bug reporting instructions, source code,
etc, can be found on ccache’s web site: <a href="http://ccache.samba.org">http://ccache.samba.org</a>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_author">Author</h2>
<div class="sectionbody">
<div class="paragraph"><p>ccache was originally written by Andrew Tridgell and is currently developed and
maintained by Joel Rosdahl. See AUTHORS.txt or AUTHORS.html and
<a href="http://ccache.samba.org/credits.html">http://ccache.samba.org/credits.html</a> for a list of contributors.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 3.1.6<br />
Last updated 2011-08-14 21:46:15 CEST
</div>
</div>
</body>
</html>
|
