3 .\" Author: [see the "Author" section]
4 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
6 .\" Manual: ccache Manual
7 .\" Source: ccache 3.3.5
10 .TH "CCACHE" "1" "01/13/2018" "ccache 3\&.3\&.5" "ccache Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 ccache \- a fast C/C++ compiler cache
35 \fBccache\fR [\fIoptions\fR]
36 \fBccache\fR \fIcompiler\fR [\fIcompiler options\fR]
37 \fIcompiler\fR [\fIcompiler options\fR] (via symbolic link)
41 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++\&.
43 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 CAVEATS\&. If you ever discover an undocumented case where ccache changes the output of your compiler, please let us know\&.
54 Keeps statistics on hits/misses\&.
65 Automatic cache size management\&.
76 Can cache compilations that generate warnings\&.
109 Optionally uses hard links where possible to avoid copies\&.
120 Optionally compresses files in the cache to reduce disk space\&.
132 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\&.
143 Only works with GCC and compilers that behave similar enough\&.
154 Some compiler flags are not supported\&. If such a flag is detected, ccache will silently fall back to running the real compiler\&.
158 There are two ways to use ccache\&. You can either prefix your compilation commands with \fBccache\fR 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\&.
160 To use the first method, just make sure that \fBccache\fR is in your \fBPATH\fR\&.
162 To use the symlinks method, do something like this:
168 cp ccache /usr/local/bin/
169 ln \-s ccache /usr/local/bin/gcc
170 ln \-s ccache /usr/local/bin/g++
171 ln \-s ccache /usr/local/bin/cc
172 ln \-s ccache /usr/local/bin/c++
178 And so forth\&. This will work as long as the directory with symlinks comes before the path to the compiler (which is usually in /usr/bin)\&. After installing you may wish to run \(lqwhich gcc\(rq to make sure that the correct link is being used\&.
184 .nr an-no-space-flag 1
192 The technique of letting ccache masquerade as the compiler works well, but currently doesn\(cqt interact well with other tools that do the same thing\&. See USING CCACHE WITH OTHER COMPILER WRAPPERS\&.
200 .nr an-no-space-flag 1
208 Do not use a hard link, use a symbolic link\&. A hard link will cause \(lqinteresting\(rq problems\&.
213 These options only apply when you invoke ccache as \(lqccache\(rq\&. 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\(cqs documentation\&.
215 \fB\-c, \-\-cleanup\fR
217 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, there is no need 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\&.
222 Clear the entire cache, removing all cached files, but keeping the configuration file\&.
225 \fB\-F, \-\-max\-files\fR=\fIN\fR
227 Set the maximum number of files allowed in the cache\&. Use 0 for no limit\&. The value is stored in a configuration file in the cache directory and applies to all future compilations\&.
232 Print an options summary page\&.
235 \fB\-M, \-\-max\-size\fR=\fISIZE\fR
237 Set the maximum size of the files stored in the cache\&.
239 should be a number followed by an optional suffix: k, M, G, T (decimal), Ki, Mi, Gi or Ti (binary)\&. The default suffix is G\&. Use 0 for no limit\&. The value is stored in a configuration file in the cache directory and applies to all future compilations\&.
242 \fB\-o, \-\-set\-config\fR=\fIKEY=VALUE\fR
249 for more information\&.
252 \fB\-p, \-\-print\-config\fR
254 Print current configuration options and from where they originate (environment variable, configuration file or compile\-time default)\&.
257 \fB\-s, \-\-show\-stats\fR
259 Print the current statistics summary for the cache\&.
262 \fB\-V, \-\-version\fR
264 Print version and copyright information\&.
267 \fB\-z, \-\-zero\-stats\fR
269 Zero the cache statistics (but not the configuration options)\&.
273 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 \fB\-\-ccache\-skip\fR\&. 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\&.
279 .nr an-no-space-flag 1
287 \fB\-\-ccache\-skip\fR currently only tells ccache not to interpret the next option as a special compiler option \(em the option will still be included in the direct mode hash\&.
291 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 \fB\-\-ccache\-skip\fR 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\&.
293 Another case where \fB\-\-ccache\-skip\fR can be useful is if ccache interprets an option specially but shouldn\(cqt, since the option has another meaning for your compiler than what ccache thinks\&.
296 ccache\(cqs default behavior can be overridden by configuration file settings, which in turn can be overridden by environment variables with names starting with \fBCCACHE_\fR\&. ccache normally reads configuration from two files: first a system\-level configuration file and secondly a cache\-specific configuration file\&. The priority of configuration settings is as follows (where 1 is highest):
306 Environment variables\&.
317 The cache\-specific configuration file
318 \fB<ccachedir>/ccache\&.conf\fR
320 \fB$HOME/\&.ccache/ccache\&.conf\fR)\&.
331 The system\-wide configuration file
332 \fB<sysconfdir>/ccache\&.conf\fR
334 \fB/etc/ccache\&.conf\fR
336 \fB/usr/local/etc/ccache\&.conf\fR)\&.
347 Compile\-time defaults\&.
350 As a special case, if the environment variable \fBCCACHE_CONFIGPATH\fR is set, ccache reads configuration from the specified path instead of the default paths\&.
351 .SS "Configuration file syntax"
353 Configuration files are in a simple \(lqkey = value\(rq format, one setting per line\&. Lines starting with a hash sign are comments\&. Blank lines are ignored, as is whitespace surrounding keys and values\&. Example:
359 # Set maximum cache size to 10 GB:
367 Some settings are boolean values (i\&.e\&. truth values)\&. In a configuration file, such values must be set to the string \fBtrue\fR or \fBfalse\fR\&. For the corresponding environment variables, the semantics are a bit different: a set environment variable means \(lqtrue\(rq regardless of the value (even if set to the empty string), and an unset environment variable means \(lqfalse\(rq\&. Each boolean environment variable also has a negated form starting with \fBCCACHE_NO\fR\&. For example, \fBCCACHE_COMPRESS\fR can be set to force compression and \fBCCACHE_NOCOMPRESS\fR can be set to force no compression\&.
368 .SS "Configuration settings"
370 Below is a list of available configuration settings\&. The corresponding environment variable name is indicated in parentheses after each configuration setting key\&.
372 \fBbase_dir\fR (\fBCCACHE_BASEDIR\fR)
374 This setting should be an absolute path to a directory\&. ccache then rewrites absolute paths into relative paths before computing the hash that identifies the compilation, but only for paths under the specified directory\&. If set to the empty string (which is the default), no rewriting is done\&. See also the discussion under
375 COMPILING IN DIFFERENT DIRECTORIES\&. If using GCC or newer versions of Clang, you might want to look into the
376 \fB\-fdebug\-prefix\-map=old=new\fR
377 option for relocating debug info to a common prefix (mapping prefix with old=new)\&.
380 \fBcache_dir\fR (\fBCCACHE_DIR\fR)
382 This setting specifies where ccache will keep its cached compiler outputs\&. It will only take effect if set in the system\-wide configuration file or as an environment variable\&. The default is
383 \fB$HOME/\&.ccache\fR\&.
386 \fBcache_dir_levels\fR (\fBCCACHE_NLEVELS\fR)
388 This setting allows you to choose the number of directory levels in the cache directory\&. The default is 2\&. The minimum is 1 and the maximum is 8\&.
391 \fBcompiler\fR (\fBCCACHE_CC\fR)
393 This setting can be used to force the name of the compiler to use\&. If set to the empty string (which is the default), ccache works it out from the command line\&.
396 \fBcompiler_check\fR (\fBCCACHE_COMPILERCHECK\fR)
398 By default, ccache includes the modification time (\(lqmtime\(rq) and size of the compiler in the hash to ensure that results retrieved from the cache are accurate\&. This setting can be used to select another strategy\&. Possible values are:
402 Hash the content of the compiler binary\&. This makes ccache very slightly slower compared to the
404 setting, but makes it cope better with compiler upgrades during a build bootstrapping process\&.
409 Hash the compiler\(cqs mtime and size, which is fast\&. This is the default\&.
414 Don\(cqt hash anything\&. This may be good for situations where you can safely use the cached results even though the compiler\(cqs mtime or size has changed (e\&.g\&. if the compiler is built as part of your build system and the compiler\(cqs source has not changed, or if the compiler only has changes that don\(cqt affect code generation)\&. You should only use the
416 setting if you know what you are doing\&.
423 as the string to calculate hash from\&. This can be the compiler revision number you retrieved earlier and set here via environment variable\&.
426 \fIa command string\fR
428 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
430 will be replaced with the path to the compiler\&. Several commands can be specified with semicolon as separator\&. Examples:
446 %compiler% \-dumpmachine; %compiler% \-dumpversion
452 You should make sure that the specified command is as fast as possible since it will be run once for each ccache invocation\&.
454 Identifying the compiler using a command is useful if you want to avoid cache misses when the compiler has been rebuilt but not changed\&.
456 Another case is when the compiler (as seen by ccache) actually isn\(cqt the real compiler but another compiler wrapper \(em in that case, the default
458 method will hash the mtime and size of the other compiler wrapper, which means that ccache won\(cqt be able to detect a compiler upgrade\&. Using a suitable command to identify the compiler is thus safer, but it\(cqs also slower, so you should consider continue using the
460 method in combination with the
462 setting if possible\&. See
463 USING CCACHE WITH OTHER COMPILER WRAPPERS\&.
467 \fBcompression\fR (\fBCCACHE_COMPRESS\fR or \fBCCACHE_NOCOMPRESS\fR, see Boolean values above)
469 If true, 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\&. The default is false\&.
472 \fBcompression_level\fR (\fBCCACHE_COMPRESSLEVEL\fR)
474 This setting determines the level at which ccache will compress object files\&. It only has effect if
476 is enabled\&. The value defaults to 6, and must be no lower than 1 (fastest, worst compression) and no higher than 9 (slowest, best compression)\&.
479 \fBcpp_extension\fR (\fBCCACHE_EXTENSION\fR)
481 This setting can be used to force a certain extension for the intermediate preprocessed file\&. The default is to automatically determine the extension to use for intermediate preprocessor files based on the type of file being compiled, but that sometimes doesn\(cqt work\&. For example, when using the \(lqaCC\(rq compiler on HP\-UX, set the cpp extension to
485 \fBdirect_mode\fR (\fBCCACHE_DIRECT\fR or \fBCCACHE_NODIRECT\fR, see Boolean values above)
487 If true, the direct mode will be used\&. The default is true\&. See
491 \fBdisable\fR (\fBCCACHE_DISABLE\fR or \fBCCACHE_NODISABLE\fR, see Boolean values above)
493 When true, ccache will just call the real compiler, bypassing the cache completely\&. The default is false\&.
496 \fBextra_files_to_hash\fR (\fBCCACHE_EXTRAFILES\fR)
498 This setting is a list of paths to files that ccache will include in the the hash sum that identifies the build\&. The list separator is semicolon on Windows systems and colon on other systems\&.
501 \fBhard_link\fR (\fBCCACHE_HARDLINK\fR or \fBCCACHE_NOHARDLINK\fR, see Boolean values above)
503 If true, 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 \(lqmake\(rq 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 enable compression if you want to use hard links\&. The default is false\&.
506 \fBhash_dir\fR (\fBCCACHE_HASHDIR\fR or \fBCCACHE_NOHASHDIR\fR, see Boolean values above)
508 If true (which is the default), ccache will include the current working directory (CWD) in the hash that is used to distinguish two compilations when generating debug info (compiler option
510 with variations)\&. Exception: The CWD will not be included in the hash if
512 is set (and matches the CWD) and the compiler option
513 \fB\-fdebug\-prefix\-map\fR
516 The reason for including the CWD in the hash by default is to prevent a problem with the storage of the current working directory in the debug info of an object file, which can lead ccache to return a cached object file that has the working directory in the debug info set incorrectly\&.
518 You can disable this setting to get cache hits when compiling the same source code in different directories if you don\(cqt mind that CWD in the debug info might be incorrect\&.
521 \fBignore_headers_in_manifest\fR (\fBCCACHE_IGNOREHEADERS\fR)
523 This setting is a list of paths to files (or directories with headers) that ccache will
525 include in the manifest list that makes up the direct mode\&. Note that this can cause stale cache hits if those headers do indeed change\&. The list separator is semicolon on Windows systems and colon on other systems\&.
528 \fBkeep_comments_cpp\fR (\fBCCACHE_COMMENTS\fR or \fBCCACHE_NOCOMMENTS\fR, see Boolean values above)
530 If true, ccache will not discard the comments before hashing preprocessor output\&. This can be used to check documentation with
531 \fB\-Wdocumentation\fR\&.
534 \fBlimit_multiple\fR (\fBCCACHE_LIMIT_MULTIPLE\fR)
536 Sets the limit when cleaning up\&. Files are deleted (in LRU order) until the levels are below the limit\&. The default is 0\&.8 (= 80%)\&. See
538 for more information\&.
541 \fBlog_file\fR (\fBCCACHE_LOGFILE\fR)
543 If set to a file path, ccache will write information on what it is doing to the specified file\&. This is useful for tracking down problems\&.
546 \fBmax_files\fR (\fBCCACHE_MAXFILES\fR)
548 This option specifies the maximum number of files to keep in the cache\&. Use 0 for no limit (which is the default)\&. See also
549 CACHE SIZE MANAGEMENT\&.
552 \fBmax_size\fR (\fBCCACHE_MAXSIZE\fR)
554 This option specifies the maximum size of the cache\&. Use 0 for no limit\&. The default value is 5G\&. Available suffixes: k, M, G, T (decimal) and Ki, Mi, Gi, Ti (binary)\&. The default suffix is "G"\&. See also
555 CACHE SIZE MANAGEMENT\&.
558 \fBpath\fR (\fBCCACHE_PATH\fR)
560 If set, ccache will search directories in this list when looking for the real compiler\&. The list separator is semicolon on Windows systems and colon on other systems\&. If not set, ccache will look for the first executable matching the compiler name in the normal
562 that isn\(cqt a symbolic link to ccache itself\&.
565 \fBprefix_command\fR (\fBCCACHE_PREFIX\fR)
567 This option adds a list of prefixes (separated by space) to the command line that ccache uses when invoking the compiler\&. See also
568 USING CCACHE WITH OTHER COMPILER WRAPPERS\&.
571 \fBprefix_command_cpp\fR (\fBCCACHE_PREFIX_CPP\fR)
573 This option adds a list of prefixes (separated by space) to the command line that ccache uses when invoking the preprocessor\&.
576 \fBread_only\fR (\fBCCACHE_READONLY\fR or \fBCCACHE_NOREADONLY\fR, see Boolean values above)
578 If true, ccache will attempt to use existing cached object files, but it will not to try to add anything new to the cache\&. If you are using this because your ccache directory is read\-only, then you need to set
580 as otherwise ccache will fail to create temporary files\&.
583 \fBread_only_direct\fR (\fBCCACHE_READONLY_DIRECT\fR or \fBCCACHE_NOREADONLY_DIRECT\fR, see Boolean values above)
587 except that ccache will only try to retrieve results from the cache using the direct mode, not the preprocessor mode\&. See documentation for
589 regarding using a read\-only ccache directory\&.
592 \fBrecache\fR (\fBCCACHE_RECACHE\fR or \fBCCACHE_NORECACHE\fR, see Boolean values above)
594 If true, ccache will not use any previously stored result\&. New results will still be cached, possibly overwriting any pre\-existing results\&.
597 \fBrun_second_cpp\fR (\fBCCACHE_CPP2\fR or \fBCCACHE_NOCPP2\fR, see Boolean values above)
599 If true, ccache will first run the preprocessor to preprocess the source code (see
600 THE PREPROCESSOR MODE) and then on a cache miss run the compiler on the source code to get hold of the object file\&. This is the default\&.
602 If false, ccache will first run preprocessor to preprocess the source code and then on a cache miss run the compiler on the
603 \fIpreprocessed source code\fR
604 instead of the original source code\&. This makes cache misses slightly faster since the source code only has to be preprocessed once\&. The downside is that some compilers won\(cqt produce the same result (for instance diagnostics warnings) when compiling preprocessed source code\&.
607 \fBsloppiness\fR (\fBCCACHE_SLOPPINESS\fR)
609 By default, ccache tries to give as few false cache hits as possible\&. However, in certain situations it\(cqs possible that you know things that ccache can\(cqt take for granted\&. This setting 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:
615 being present in the source\&.
618 \fBfile_stat_matches\fR
620 ccache normally examines a file\(cqs contents to determine whether it matches the cached version\&. With this option set, ccache will consider a file as matching its cached version if the mtimes and ctimes match\&.
623 \fBinclude_file_ctime\fR
625 By default, ccache also will not cache a file if it includes a header whose ctime is too new\&. This option disables that check\&.
628 \fBinclude_file_mtime\fR
630 By default, ccache will not cache a file if it includes a header whose mtime is too new\&. This option disables that check\&.
633 \fBno_system_headers\fR
635 By default, ccache will also include all system headers in the manifest\&. With this option set, ccache will only include system headers in the hash but not add the system header files to the list of include files\&.
641 \fB#define\fRs when precompiling a header file\&. See
643 for more information\&.
652 being present in the source code\&.
655 See the discussion under
657 for more information\&.
660 \fBstats\fR (\fBCCACHE_STATS\fR or \fBCCACHE_NOSTATS\fR, see Boolean values above)
662 If true, ccache will update the statistics counters on each compilation\&. The default is true\&.
665 \fBtemporary_dir\fR (\fBCCACHE_TEMPDIR\fR)
667 This setting specifies where ccache will put temporary files\&. The default is
668 \fB<cache_dir>/tmp\fR\&.
674 .nr an-no-space-flag 1
681 In previous versions of ccache,
683 had to be on the same filesystem as the
685 path, but this requirement has been relaxed\&.)
690 \fBumask\fR (\fBCCACHE_UMASK\fR)
692 This setting specifies 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\&.
695 \fBunify\fR (\fBCCACHE_UNIFY\fR or \fBCCACHE_NOUNIFY\fR, see Boolean values above)
697 If true, ccache will use a C/C++ unifier when hashing the preprocessor output if the
699 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 enabling the unifier changes the hash, so cached compilations produced when the unifier is enabled cannot be reused when the unifier is disabled, and vice versa\&. Enabling the unifier may result in incorrect line number information in compiler warning messages and expansions of the
701 macro\&. Also note that enabling the unifier implies turning off the direct mode\&.
703 .SH "CACHE SIZE MANAGEMENT"
705 By default, ccache has a 5 GB limit on the total size of files in the cache and no limit on the number of files\&. You can set different limits using the \fB\-M\fR/\fB\-\-max\-size\fR and \fB\-F\fR/\fB\-\-max\-files\fR options\&. Use \fBccache \-s/\-\-show\-stats\fR to see the cache size and the currently configured limits (in addition to other various statistics)\&.
707 Cleanup can be triggered in two different ways: automatic and manual\&.
708 .SS "Automatic cleanup"
710 ccache maintains counters for various statistics about the cache, including the size and number of all cached files\&. In order to improve performance and reduce issues with concurrent ccache invocations, there is one statistics file for each of the sixteen subdirectories in the cache\&.
712 After a new compilation result has been written to the cache, ccache will update the size and file number statistics for the subdirectory (one of sixteen) to which the result was written\&. Then, if the size counter for said subdirectory is greater than \fBmax_size / 16\fR or the file number counter is greater than \fBmax_files / 16\fR, automatic cleanup is triggered\&.
714 When automatic cleanup is triggered for a subdirectory in the cache, ccache will:
724 Count all files in the subdirectory and compute their aggregated size\&.
735 Remove files in LRU (least recently used) order until the size is at most
736 \fBlimit_multiple * max_size / 16\fR
737 and the number of files is at most
738 \fBlimit_multiple * max_files / 16\fR, where
739 \fBlimit_multiple\fR,
743 are configuration settings\&.
754 Set the size and file number counters to match the files that were kept\&.
757 The reason for removing more files than just those needed to not exceed the max limits is that a cleanup is a fairly slow operation, so it would not be a good idea to trigger it often, like after each cache miss\&.
760 You can run \fBccache \-c/\-\-cleanup\fR to force cleanup of the whole cache, i\&.e\&. all of the sixteen subdirectories\&. This will recalculate the statistics counters and make sure that the \fBmax_size\fR and \fBmax_files\fR settings are not exceeded\&. Note that \fBlimit_multiple\fR is not taken into account for manual cleanup\&.
761 .SH "CACHE COMPRESSION"
763 ccache can optionally compress all files it puts into the cache using the compression library zlib\&. While this may involve a tiny performance slowdown, it increases the number of files that fit in the cache\&. You can turn on compression with the \fBcompression\fR configuration setting and you can also tweak the compression level with \fBcompression_level\fR\&.
764 .SH "CACHE STATISTICS"
766 \fBccache \-s/\-\-show\-stats\fR can show the following statistics:
806 autoconf compile/link
809 Uncachable compilation or linking by an autoconf test\&.
813 bad compiler arguments
816 Malformed compiler argument, e\&.g\&. missing a value for an option that requires an argument or failure to read a file specified by an option argument\&.
823 A file was unexpectedly missing from the cache\&. This only happens in rare situations, e\&.g\&. if one ccache instance is about to get a file from the cache while another instance removed the file as part of cache cleanup\&.
830 A result was successfully found using the direct mode\&.
834 cache hit (preprocessed)
837 A result was successfully found using the preprocessor mode\&.
844 No result was found\&.
851 Current size of the cache\&.
858 The compiler was called for linking, not compiling\&.
862 called for preprocessing
865 The compiler was called for preprocessing, not compiling\&.
869 can\(cqt use precompiled header
872 Preconditions for using precompiled headers were not fulfilled\&.
876 ccache internal error
879 Unexpected failure, e\&.g\&. due to problems reading/writing the cache\&.
886 Number of cleanups performed, either implicitly due to the cache size limit being reached or due to explicit \fBccache \-c/\-\-cleanup\fR calls\&.
893 The compilation failed\&. No result stored in the cache\&.
897 compiler check failed
900 A compiler check program specified by \fBcompiler_check\fR (\fBCCACHE_COMPILERCHECK\fR) failed\&.
904 compiler produced empty output
907 The compiler\(cqs output file (typically an object file) was empty after compilation\&.
911 compiler produced no output
914 The compiler\(cqs output file (typically an object file) was missing after compilation\&.
918 compiler produced stdout
921 The compiler wrote data to standard output\&. This is something that compilers normally never do, so ccache is not designed to store such output in the cache\&.
925 couldn\(cqt find the compiler
928 The compiler to execute could not be found\&.
932 error hashing extra file
935 Failure reading a file specified by \fBextra_files_to_hash\fR (\fBCCACHE_EXTRAFILES\fR)\&.
942 Current number of files in the cache\&.
946 multiple source files
949 The compiler was called to compile multiple source files in one go\&. This is not supported by ccache\&.
956 No input file was specified to the compiler\&.
960 output to a non\-regular file
963 The output path specified with \fB\-o\fR is not a file (e\&.g\&. a directory or a device node)\&.
970 The compiler was instructed to write its output to standard output using \fB\-o \-\fR\&. This is not supported by ccache\&.
977 Preprocessing the source code using the compiler\(cqs \fB\-E\fR option failed\&.
981 unsupported code directive
984 Code like the assembler \(lq\&.incbin\(rq directive was found\&. This is not supported by ccache\&.
988 unsupported compiler option
991 A compiler option not supported by ccache was found\&.
995 unsupported source language
998 A source language e\&.g\&. specified with \fB\-x\fR was unsupported by ccache\&.
1002 .SH "HOW CCACHE WORKS"
1004 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\&.
1006 ccache has two ways of doing the detection:
1010 \h'-04'\(bu\h'+03'\c
1017 \fBdirect mode\fR, where ccache hashes the source code and include files directly
1022 \h'-04'\(bu\h'+03'\c
1029 \fBpreprocessor mode\fR, where ccache runs the preprocessor on the source code and hashes the result
1032 The direct mode is generally faster since running the preprocessor has some overhead\&.
1033 .SS "Common hashed information"
1035 For both modes, the following information is included in the hash:
1039 \h'-04'\(bu\h'+03'\c
1045 the extension used by the compiler for a file with preprocessor output (normally
1054 \h'-04'\(bu\h'+03'\c
1060 the compiler\(cqs size and modification time (or other compiler\-specific information specified by the
1061 \fBcompiler_check\fR
1067 \h'-04'\(bu\h'+03'\c
1073 the name of the compiler
1078 \h'-04'\(bu\h'+03'\c
1084 the current directory (if the
1091 \h'-04'\(bu\h'+03'\c
1097 contents of files specified by the
1098 \fBextra_files_to_hash\fR
1101 .SS "The direct mode"
1103 In the direct mode, the hash is formed of the common information and:
1107 \h'-04'\(bu\h'+03'\c
1113 the input source file
1118 \h'-04'\(bu\h'+03'\c
1124 the command line options
1127 Based on the hash, a data structure called \(lqmanifest\(rq is looked up in the cache\&. The manifest contains:
1131 \h'-04'\(bu\h'+03'\c
1137 references to cached compilation results (object file, dependency file, etc) that were produced by previous compilations that matched the hash
1142 \h'-04'\(bu\h'+03'\c
1148 paths to the include files that were read at the time the compilation results were stored in the cache
1153 \h'-04'\(bu\h'+03'\c
1159 hash sums of the include files at the time the compilation results were stored in the cache
1162 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\&.
1164 There is a catch with the direct mode: header files that were used by the compiler are recorded, but header files that were \fBnot\fR used, but would have been used if they existed, are not\&. So, when ccache checks if a result can be taken from the cache, it currently can\(cqt check if the existence of a new header file should invalidate the result\&. In practice, the direct mode is safe to use in the absolute majority of cases\&.
1166 The direct mode will be disabled if any of the following holds:
1170 \h'-04'\(bu\h'+03'\c
1176 the configuration setting
1183 \h'-04'\(bu\h'+03'\c
1189 a modification time of one of the include files is too new (needed to avoid a race condition)
1194 \h'-04'\(bu\h'+03'\c
1200 the unifier is enabled (the configuration setting
1207 \h'-04'\(bu\h'+03'\c
1213 a compiler option not supported by the direct mode is used:
1217 \h'-04'\(bu\h'+03'\c
1224 \fB\-Wp,\fR\fB\fIX\fR\fR
1225 compiler option other than
1226 \fB\-Wp,\-MD,\fR\fB\fIpath\fR\fR,
1227 \fB\-Wp,\-MMD,\fR\fB\fIpath\fR\fR
1229 \fB\-Wp,\-D_define_\fR
1234 \h'-04'\(bu\h'+03'\c
1240 \fB\-Xpreprocessor\fR
1246 \h'-04'\(bu\h'+03'\c
1252 the string \(lq__TIME__\(rq is present in the source code
1254 .SS "The preprocessor mode"
1256 In the preprocessor mode, the hash is formed of the common information and:
1260 \h'-04'\(bu\h'+03'\c
1266 the preprocessor output from running the compiler with
1272 \h'-04'\(bu\h'+03'\c
1278 the command line options except options that affect include files (\fB\-I\fR,
1280 \fB\-D\fR, etc; the theory is that these options will change the preprocessor output if they have any effect at all)
1285 \h'-04'\(bu\h'+03'\c
1291 any standard error output generated by the preprocessor
1294 Based on the hash, the cached compilation result can be looked up directly in the cache\&.
1295 .SH "COMPILING IN DIFFERENT DIRECTORIES"
1297 Some information included in the hash that identifies a unique compilation may contain absolute paths:
1301 \h'-04'\(bu\h'+03'\c
1307 The preprocessed source code may contain absolute paths to include files if the compiler option
1309 is used or if absolute paths are given to
1311 and similar compiler options\&.
1316 \h'-04'\(bu\h'+03'\c
1322 Paths specified by compiler options (such as
1324 \fB\-MF\fR, etc) may be absolute\&.
1329 \h'-04'\(bu\h'+03'\c
1335 The source code file path may be absolute, and that path may substituted for
1337 macros in the source code or included in warnings emitted to standard error by the preprocessor\&.
1340 This means that if you compile the same code in different locations, you can\(cqt 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 \(lqbase directory\(rq in the configuration setting \fBbase_dir\fR 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\(cqt use / as the base directory since that will make ccache also rewrite paths to system header files, which doesn\(cqt gain anything\&.)
1342 The drawbacks of using a base directory are:
1346 \h'-04'\(bu\h'+03'\c
1352 If you specify an absolute path to the source code file,
1354 macros will be expanded to a relative path instead\&.
1359 \h'-04'\(bu\h'+03'\c
1365 If you specify an absolute path to the source code file and compile with
1366 \fB\-g\fR, 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 \(lqcd\(rq command in GDB\&.
1368 .SH "PRECOMPILED HEADERS"
1370 ccache has support for GCC\(cqs precompiled headers\&. However, you have to do some things to make it work properly:
1374 \h'-04'\(bu\h'+03'\c
1383 \fBpch_defines,time_macros\fR\&. The reason is that ccache can\(cqt tell whether
1387 is used when using a precompiled header\&. Further, it can\(cqt detect changes in
1388 \fB#define\fRs in the source code because of how preprocessing works in combination with precompiled headers\&.
1393 \h'-04'\(bu\h'+03'\c
1403 \h'-04'\(bu\h'+03'\c
1411 compiler option to include the precompiled header (i\&.e\&., don\(cqt use
1413 in the source code to include the header); or
1418 \h'-04'\(bu\h'+03'\c
1424 (for the Clang compiler) use the
1425 \fB\-include\-pch\fR
1426 compiler option to include the PCH file generated from the precompiled header; or
1431 \h'-04'\(bu\h'+03'\c
1438 \fB\-fpch\-preprocess\fR
1439 compiler option when compiling\&.
1442 If you don\(cqt 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 \(lqpreprocessor error\(rq (if the non\-precompiled header file is not available)\&.
1444 .SH "SHARING A CACHE"
1446 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:
1450 \h'-04'\(bu\h'+03'\c
1456 Use the same cache directory\&.
1461 \h'-04'\(bu\h'+03'\c
1467 Make sure that the configuration setting
1469 is false (which is the default)\&.
1474 \h'-04'\(bu\h'+03'\c
1480 Make sure that all users are in the same group\&.
1485 \h'-04'\(bu\h'+03'\c
1491 Set the configuration setting
1493 to 002\&. This ensures that cached files are accessible to everyone in the group\&.
1498 \h'-04'\(bu\h'+03'\c
1504 Make sure that all users have write permission in the entire cache directory (and that you trust all users of the shared cache)\&.
1509 \h'-04'\(bu\h'+03'\c
1515 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 following command might be useful for this:
1521 find $CCACHE_DIR \-type d | xargs chmod g+s
1528 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\(cqs 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\&.
1530 You may also want to make sure that a base directory is set appropriately, as discussed in a previous section\&.
1531 .SH "SHARING A CACHE ON NFS"
1533 It is possible to put the cache directory on an NFS filesystem (or similar filesystems), but keep in mind that:
1537 \h'-04'\(bu\h'+03'\c
1543 Having the cache on NFS may slow down compilation\&. Make sure to do some benchmarking to see if it\(cqs worth it\&.
1548 \h'-04'\(bu\h'+03'\c
1554 ccache hasn\(cqt been tested very thoroughly on NFS\&.
1557 A tip is to set \fBtemporary_dir\fR to a directory on the local host to avoid NFS traffic for temporary files\&.
1558 .SH "USING CCACHE WITH OTHER COMPILER WRAPPERS"
1560 The recommended way of combining ccache with another compiler wrapper (such as \(lqdistcc\(rq) is by letting ccache execute the compiler wrapper\&. This is accomplished by defining the configuration setting \fBprefix_command\fR, for example by setting the environment variable \fBCCACHE_PREFIX\fR to the name of the wrapper (e\&.g\&. \fBdistcc\fR)\&. ccache will then prefix the command line with the specified command when running the compiler\&. To specify several prefix commands, set \fBprefix_command\fR to a colon\-separated list of commands\&.
1562 Unless you set \fBcompiler_check\fR to a suitable command (see the description of that configuration option), it is not recommended to use the form \fBccache anotherwrapper compiler args\fR as the compilation command\&. It\(cqs 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:
1566 \h'-04'\(bu\h'+03'\c
1572 Compiler upgrades will not be detected properly\&.
1577 \h'-04'\(bu\h'+03'\c
1583 The cached results will not be shared between compilations with and without the other wrapper\&.
1586 Another minor thing is that if \fBprefix_command\fR is used, ccache will not invoke the other wrapper when running the preprocessor, which increases performance\&. You can use the \fBprefix_command_cpp\fR configuration setting if you also want to invoke the other wrapper when doing preprocessing (normally by adding \fB\-E\fR)\&.
1591 \h'-04'\(bu\h'+03'\c
1597 The direct mode fails to pick up new header files in some rare scenarios\&. See
1601 .SH "TROUBLESHOOTING"
1604 A general tip for getting information about what ccache is doing is to enable debug logging by setting \fBlog_file\fR\&. 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 \fBccache \-s\fR\&.
1607 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\&.
1609 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 preferable\&.
1611 A good way of monitoring how well ccache works is to run \fBccache \-s\fR 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:
1615 \h'-04'\(bu\h'+03'\c
1621 If \(lqcache hit (preprocessed)\(rq has been incremented instead of \(lqcache hit (direct)\(rq, ccache has fallen back to preprocessor mode, which is generally slower\&. Some possible reasons are:
1625 \h'-04'\(bu\h'+03'\c
1631 The source code has been modified in such a way that the preprocessor output is not affected\&.
1636 \h'-04'\(bu\h'+03'\c
1642 Compiler arguments that are hashed in the direct mode but not in the preprocessor mode have changed (\fB\-I\fR,
1644 \fB\-D\fR, etc) and they didn\(cqt affect the preprocessor output\&.
1649 \h'-04'\(bu\h'+03'\c
1656 \fB\-Xpreprocessor\fR
1658 \fB\-Wp,\fR\fB\fIX\fR\fR
1660 \fB\-Wp,\-MD,\fR\fB\fIpath\fR\fR,
1661 \fB\-Wp,\-MMD,\fR\fB\fIpath\fR\fR, and
1662 \fB\-Wp,\-D_define_\fR) is used\&.
1667 \h'-04'\(bu\h'+03'\c
1673 This was the first compilation with a new value of the base directory setting\&.
1678 \h'-04'\(bu\h'+03'\c
1684 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
1687 \fBinclude_file_mtime\fR
1688 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\(cqs output, which contains data from the old header file; the wrong object file is stored in the cache\&.)
1693 \h'-04'\(bu\h'+03'\c
1701 preprocessor macro is (potentially) being used\&. ccache turns off direct mode if \(lq__TIME__\(rq is present in the source code\&. This is done as a safety measure since the string indicates that a
1705 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
1707 isn\(cqt used in practise, or don\(cqt care if ccache produces objects where
1709 is expanded to something in the past, you can set
1712 \fBtime_macros\fR\&.
1717 \h'-04'\(bu\h'+03'\c
1725 preprocessor macro is (potentially) being used and the date has changed\&. This is similar to how
1727 is handled\&. If \(lq__DATE__\(rq is present in the source code, ccache hashes the current date in order to be able to produce the correct object file if the
1729 macro affects the output\&. If you know that
1731 isn\(cqt used in practise, or don\(cqt care if ccache produces objects where
1733 is expanded to something in the past, you can set
1736 \fBtime_macros\fR\&.
1741 \h'-04'\(bu\h'+03'\c
1749 preprocessor macro is (potentially) being used and the file path has changed\&. If \(lq__FILE__\(rq is present in the source code, ccache hashes the current input file path in order to be able to produce the correct object file if the
1751 macro affects the output\&. If you know that
1753 isn\(cqt used in practise, or don\(cqt care if ccache produces objects where
1755 is expanded to the wrong path, you can set
1764 \h'-04'\(bu\h'+03'\c
1770 If \(lqcache miss\(rq 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
1774 macros, or use of automatically generated code that contains a timestamp, build counter or other volatile information\&.
1779 \h'-04'\(bu\h'+03'\c
1785 If \(lqmultiple source files\(rq has been incremented, it\(cqs an indication that the compiler has been invoked on several source code files at once\&. ccache doesn\(cqt support that\&. Compile the source code files separately if possible\&.
1790 \h'-04'\(bu\h'+03'\c
1796 If \(lqunsupported compiler option\(rq has been incremented, enable debug logging and check which option was rejected\&.
1801 \h'-04'\(bu\h'+03'\c
1807 If \(lqpreprocessor error\(rq has been incremented, one possible reason is that precompiled headers are being used\&. See
1809 for how to remedy this\&.
1814 \h'-04'\(bu\h'+03'\c
1820 If \(lqcan\(cqt use precompiled header\(rq has been incremented, see
1821 PRECOMPILED HEADERS\&.
1823 .SS "Corrupt object files"
1825 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 \fBprefix_command\fR or compiler wrapper\&. If this happens, the easiest way of fixing it is this:
1835 Build so that the bad object file ends up in the build tree\&.
1846 Remove the bad object file from the build tree\&.
1858 \fBCCACHE_RECACHE\fR
1862 An alternative is to clear the whole cache with \fBccache \-C\fR if you don\(cqt mind losing other cached results\&.
1864 There are no reported issues about ccache producing broken object files reproducibly\&. That doesn\(cqt mean it can\(cqt happen, so if you find a repeatable case, please report it\&.
1865 .SH "MORE INFORMATION"
1867 Credits, mailing list information, bug reporting instructions, source code, etc, can be found on ccache\(cqs web site: https://ccache\&.samba\&.org\&.
1870 ccache was originally written by Andrew Tridgell and is currently developed and maintained by Joel Rosdahl\&. See AUTHORS\&.txt or AUTHORS\&.html and https://ccache\&.samba\&.org/credits\&.html for a list of contributors\&.
projects / platform / upstream / ccache.git / blob