3 .\" Author: [see the "Author" section]
4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
6 .\" Manual: ccache Manual
7 .\" Source: ccache 3.2.6
10 .TH "CCACHE" "1" "07/12/2016" "ccache 3\&.2\&.6" "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 BUGS\&. 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\&. \fBNote\fR: \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\&.
275 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\&.
277 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\&.
280 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):
290 Environment variables\&.
301 The cache\-specific configuration file
302 \fB<ccachedir>/ccache\&.conf\fR
304 \fB$HOME/\&.ccache/ccache\&.conf\fR)\&.
315 The system\-wide configuration file
316 \fB<sysconfdir>/ccache\&.conf\fR
318 \fB/etc/ccache\&.conf\fR
320 \fB/usr/local/etc/ccache\&.conf\fR)\&.
331 Compile\-time defaults\&.
334 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\&.
335 .SS "Configuration file syntax"
337 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:
343 # Set maximum cache size to 10 GB:
351 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\&.
352 .SS "Configuration settings"
354 Below is a list of available configuration settings\&. The corresponding environment variable name is indicated in parentheses after each configuration setting key\&.
356 \fBbase_dir\fR (\fBCCACHE_BASEDIR\fR)
358 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
359 COMPILING IN DIFFERENT DIRECTORIES\&.
362 \fBcache_dir\fR (\fBCCACHE_DIR\fR)
364 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
365 \fB$HOME/\&.ccache\fR\&.
368 \fBcache_dir_levels\fR (\fBCCACHE_NLEVELS\fR)
370 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\&.
373 \fBcompiler\fR (\fBCCACHE_CC\fR)
375 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\&.
378 \fBcompiler_check\fR (\fBCCACHE_COMPILERCHECK\fR)
380 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:
384 Hash the content of the compiler binary\&. This makes ccache very slightly slower compared to the
386 setting, but makes it cope better with compiler upgrades during a build bootstrapping process\&.
391 Hash the compiler\(cqs mtime and size, which is fast\&. This is the default\&.
396 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
398 setting if you know what you are doing\&.
405 as the string to calculate hash from\&. This can be the compiler revision number you retrieved earlier and set here via environment variable\&.
408 \fIa command string\fR
410 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
412 will be replaced with the path to the compiler\&. Several commands can be specified with semicolon as separator\&. Examples:
433 %compiler% \-dumpmachine; %compiler% \-dumpversion
436 You should make sure that the specified command is as fast as possible since it will be run once for each ccache invocation\&.
438 Identifying the compiler using a command is useful if you want to avoid cache misses when the compiler has been rebuilt but not changed\&.
440 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
442 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
444 method in combination with the
446 setting if possible\&. See
447 USING CCACHE WITH OTHER COMPILER WRAPPERS\&.
451 \fBcompression\fR (\fBCCACHE_COMPRESS\fR or \fBCCACHE_NOCOMPRESS\fR, see Boolean values above)
453 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\&.
456 \fBcompression_level\fR (\fBCCACHE_COMPRESSLEVEL\fR)
458 This setting determines the level at which ccache will compress object files\&. It only has effect if
460 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)\&.
463 \fBcpp_extension\fR (\fBCCACHE_EXTENSION\fR)
465 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
469 \fBdirect_mode\fR (\fBCCACHE_DIRECT\fR or \fBCCACHE_NODIRECT\fR, see Boolean values above)
471 If true, the direct mode will be used\&. The default is true\&. See
475 \fBdisable\fR (\fBCCACHE_DISABLE\fR or \fBCCACHE_NODISABLE\fR, see Boolean values above)
477 When true, ccache will just call the real compiler, bypassing the cache completely\&. The default is false\&.
480 \fBextra_files_to_hash\fR (\fBCCACHE_EXTRAFILES\fR)
482 This setting is a list of paths to files that ccache will include in the the hash sum that idetifies the build\&. The list separator is semicolon on Windows systems and colon on other systems\&.
485 \fBhard_link\fR (\fBCCACHE_HARDLINK\fR or \fBCCACHE_NOHARDLINK\fR, see Boolean values above)
487 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\&.
490 \fBhash_dir\fR (\fBCCACHE_HASHDIR\fR or \fBCCACHE_NOHASHDIR\fR, see Boolean values above)
492 If true, ccache will include the current working directory in 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 an 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\&.
495 \fBlog_file\fR (\fBCCACHE_LOGFILE\fR)
497 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\&.
500 \fBmax_files\fR (\fBCCACHE_MAXFILES\fR)
502 This option specifies the maximum number of files to keep in the cache\&. Use 0 for no limit (which is the default)\&.
505 \fBmax_size\fR (\fBCCACHE_MAXSIZE\fR)
507 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"\&.
510 \fBpath\fR (\fBCCACHE_PATH\fR)
512 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
514 that isn\(cqt a symbolic link to ccache itself\&.
517 \fBprefix_command\fR (\fBCCACHE_PREFIX\fR)
519 This option adds a list of prefixes (separated by space) to the command line that ccache uses when invoking the compiler\&. See also
520 USING CCACHE WITH OTHER COMPILER WRAPPERS\&.
523 \fBread_only\fR (\fBCCACHE_READONLY\fR or \fBCCACHE_NOREADONLY\fR, see Boolean values above)
525 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
527 as otherwise ccache will fail to create temporary files\&.
530 \fBread_only_direct\fR (\fBCCACHE_READONLY_DIRECT\fR or \fBCCACHE_NOREADONLY_DIRECT\fR, see Boolean values above)
534 except that ccache will only try to retrieve results from the cache using the direct mode, not the preprocessor mode\&. See documentation for
536 regarding using a read\-only ccache directory\&.
539 \fBrecache\fR (\fBCCACHE_RECACHE\fR or \fBCCACHE_NORECACHE\fR, see Boolean values above)
541 If true, ccache will not use any previously stored result\&. New results will still be cached, possibly overwriting any pre\-existing results\&.
544 \fBrun_second_cpp\fR (\fBCCACHE_CPP2\fR or \fBCCACHE_NOCPP2\fR, see Boolean values above)
546 If true, 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 compiling the preprocessed output, in which case this option could allow ccache to be used anyway\&.
549 \fBsloppiness\fR (\fBCCACHE_SLOPPINESS\fR)
551 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:
557 being present in the source\&.
560 \fBfile_stat_matches\fR
562 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 sizes, mtimes and ctimes match\&.
565 \fBinclude_file_ctime\fR
567 By default, ccache also will not cache a file if it includes a header whose ctime is too new\&. This option disables that check\&.
570 \fBinclude_file_mtime\fR
572 By default, ccache will not cache a file if it includes a header whose mtime is too new\&. This option disables that check\&.
577 Be sloppy about #defines when precompiling a header file\&. See
579 for more information\&.
588 being present in the source code\&.
591 See the discussion under
593 for more information\&.
596 \fBstats\fR (\fBCCACHE_STATS\fR or \fBCCACHE_NOSTATS\fR, see Boolean values above)
598 If true, ccache will update the statistics counters on each compilation\&. The default is true\&.
601 \fBtemporary_dir\fR (\fBCCACHE_TEMPDIR\fR)
603 This setting specifies where ccache will put temporary files\&. The default is
604 \fB<cache_dir>/tmp\fR\&.
610 .nr an-no-space-flag 1
617 In previous versions of ccache,
619 had to be on the same filesystem as the
621 path, but this requirement has been relaxed\&.)
626 \fBumask\fR (\fBCCACHE_UMASK\fR)
628 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\&.
631 \fBunify\fR (\fBCCACHE_UNIFY\fR or \fBCCACHE_NOUNIFY\fR, see Boolean values above)
633 If true, ccache will use a C/C++ unifier when hashing the preprocessor output if the
635 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
637 macro\&. Also note that enabling the unifier implies turning off the direct mode\&.
639 .SH "CACHE SIZE MANAGEMENT"
641 By default, ccache has a five gigabyte limit on the total size of files in the cache and no maximum 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)\&.
642 .SH "CACHE COMPRESSION"
644 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\&.
645 .SH "HOW CCACHE WORKS"
647 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\&.
649 ccache has two ways of doing the detection:
660 \fBdirect mode\fR, where ccache hashes the source code and include files directly
672 \fBpreprocessor mode\fR, where ccache runs the preprocessor on the source code and hashes the result
675 The direct mode is generally faster since running the preprocessor has some overhead\&.
676 .SS "Common hashed information"
678 For both modes, the following information is included in the hash:
688 the extension used by the compiler for a file with preprocessor output (normally
703 the compiler\(cqs size and modification time (or other compiler\-specific information specified by the
716 the name of the compiler
727 the current directory (if the
740 contents of files specified by the
741 \fBextra_files_to_hash\fR
744 .SS "The direct mode"
746 In the direct mode, the hash is formed of the common information and:
756 the input source file
767 the command line options
770 Based on the hash, a data structure called \(lqmanifest\(rq is looked up in the cache\&. The manifest contains:
780 references to cached compilation results (object file, dependency file, etc) that were produced by previous compilations that matched the hash
791 paths to the include files that were read at the time the compilation results were stored in the cache
802 hash sums of the include files at the time the compilation results were stored in the cache
805 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\&.
807 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\&.
809 The direct mode will be disabled if any of the following holds:
819 the configuration setting
832 a modification time of one of the include files is too new (needed to avoid a race condition)
843 the unifier is enabled (the configuration setting
856 a compiler option not supported by the direct mode is used:
867 \fB\-Wp,\fR\fB\fIX\fR\fR
868 compiler option other than
869 \fB\-Wp,\-MD,\fR\fB\fIpath\fR\fR
871 \fB\-Wp,\-MMD,\fR\fB\fIpath\fR\fR
882 \fB\-Xpreprocessor\fR
894 the string \(lq__TIME__\(rq is present in the source code
896 .SS "The preprocessor mode"
898 In the preprocessor mode, the hash is formed of the common information and:
908 the preprocessor output from running the compiler with
920 the command line options except options that affect include files (\fB\-I\fR,
922 \fB\-D\fR, etc; the theory is that these options will change the preprocessor output if they have any effect at all)
933 any standard error output generated by the preprocessor
936 Based on the hash, the cached compilation result can be looked up directly in the cache\&.
937 .SH "COMPILING IN DIFFERENT DIRECTORIES"
939 Some information included in the hash that identifies a unique compilation may contain absolute paths:
949 The preprocessed source code may contain absolute paths to include files if the compiler option
951 is used or if absolute paths are given to
953 and similar compiler options\&.
964 Paths specified by compiler options (such as
966 \fB\-MF\fR, etc) may be absolute\&.
977 The source code file path may be absolute, and that path may substituted for
979 macros in the source code or included in warnings emitted to standard error by the preprocessor\&.
982 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\&.)
984 The drawbacks of using a base directory are:
994 If you specify an absolute path to the source code file,
996 macros will be expanded to a relative path instead\&.
1001 \h'-04'\(bu\h'+03'\c
1007 If you specify an absolute path to the source code file and compile with
1008 \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\&.
1010 .SH "PRECOMPILED HEADERS"
1012 ccache has support for GCC\(cqs precompiled headers\&. However, you have to do some things to make it work properly:
1016 \h'-04'\(bu\h'+03'\c
1025 \fBpch_defines,time_macros\fR\&. The reason is that ccache can\(cqt tell whether
1029 is used when using a precompiled header\&. Further, it can\(cqt detect changes in #defines in the source code because of how preprocessing works in combination with precompiled headers\&.
1034 \h'-04'\(bu\h'+03'\c
1044 \h'-04'\(bu\h'+03'\c
1052 compiler option to include the precompiled header (i\&.e\&., don\(cqt use
1054 in the source code to include the header); or
1059 \h'-04'\(bu\h'+03'\c
1065 (for the Clang compiler) use the
1066 \fB\-include\-pch\fR
1067 compiler option to include the PCH file generated from the precompiled header; or
1072 \h'-04'\(bu\h'+03'\c
1079 \fB\-fpch\-preprocess\fR
1080 compiler option when compiling\&.
1083 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)\&.
1085 .SH "SHARING A CACHE"
1087 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:
1091 \h'-04'\(bu\h'+03'\c
1097 Use the same cache directory\&.
1102 \h'-04'\(bu\h'+03'\c
1108 Make sure that the configuration setting
1110 is false (which is the default)\&.
1115 \h'-04'\(bu\h'+03'\c
1121 Make sure that all users are in the same group\&.
1126 \h'-04'\(bu\h'+03'\c
1132 Set the configuration setting
1134 to 002\&. This ensures that cached files are accessible to everyone in the group\&.
1139 \h'-04'\(bu\h'+03'\c
1145 Make sure that all users have write permission in the entire cache directory (and that you trust all users of the shared cache)\&.
1150 \h'-04'\(bu\h'+03'\c
1156 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 \(lqfind $CCACHE_DIR \-type d | xargs chmod g+s\(rq might be useful for this\&.
1159 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\&.
1161 You may also want to make sure that a base directory is set appropriately, as discussed in a previous section\&.
1162 .SH "SHARING A CACHE ON NFS"
1164 It is possible to put the cache directory on an NFS filesystem (or similar filesystems), but keep in mind that:
1168 \h'-04'\(bu\h'+03'\c
1174 Having the cache on NFS may slow down compilation\&. Make sure to do some benchmarking to see if it\(cqs worth it\&.
1179 \h'-04'\(bu\h'+03'\c
1185 ccache hasn\(cqt been tested very thoroughly on NFS\&.
1188 A tip is to set \fBtemporary_dir\fR to a directory on the local host to avoid NFS traffic for temporary files\&.
1189 .SH "USING CCACHE WITH OTHER COMPILER WRAPPERS"
1191 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\&.
1193 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:
1197 \h'-04'\(bu\h'+03'\c
1203 Compiler upgrades will not be detected properly\&.
1208 \h'-04'\(bu\h'+03'\c
1214 The cached results will not be shared between compilations with and without the other wrapper\&.
1217 Another minor thing is that if \fBprefix_command\fR is used, ccache will not invoke the other wrapper when running the preprocessor, which increase performance\&.
1222 \h'-04'\(bu\h'+03'\c
1228 ccache doesn\(cqt handle the GNU Assembler\(cqs
1230 directive correctly\&. This directive can be embedded in the source code inside an
1232 statement in order to include a file verbatim in the object file\&. If the included file is modified, ccache doesn\(cqt pick up the change since the inclusion isn\(cqt done by the preprocessor\&. A workaround of this problem is to set
1233 \fBextra_files_to_hash\fR
1234 to the path of the included file\&.
1239 \h'-04'\(bu\h'+03'\c
1245 The direct mode fails to pick up new header files in some rare scenarios\&. See
1249 .SH "TROUBLESHOOTING"
1252 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\&.
1255 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\&.
1257 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\&.
1259 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:
1263 \h'-04'\(bu\h'+03'\c
1269 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:
1273 \h'-04'\(bu\h'+03'\c
1279 The source code has been modified in such a way that the preprocessor output is not affected\&.
1284 \h'-04'\(bu\h'+03'\c
1290 Compiler arguments that are hashed in the direct mode but not in the preprocessor mode have changed (\fB\-I\fR,
1292 \fB\-D\fR, etc) and they didn\(cqt affect the preprocessor output\&.
1297 \h'-04'\(bu\h'+03'\c
1304 \fB\-Xpreprocessor\fR
1306 \fB\-Wp,\fR\fB\fIX\fR\fR
1308 \fB\-Wp,\-MD,\fR\fB\fIpath\fR\fR
1310 \fBWp,\-MMD,\fR\fB\fIpath\fR\fR) is used\&.
1315 \h'-04'\(bu\h'+03'\c
1321 This was the first compilation with a new value of the base directory setting\&.
1326 \h'-04'\(bu\h'+03'\c
1332 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
1335 \fBinclude_file_mtime\fR
1336 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\&.)
1341 \h'-04'\(bu\h'+03'\c
1349 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
1353 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
1355 isn\(cqt used in practise, or don\(cqt care if ccache produces objects where
1357 is expanded to something in the past, you can set
1360 \fBtime_macros\fR\&.
1365 \h'-04'\(bu\h'+03'\c
1373 preprocessor macro is (potentially) being used and the date has changed\&. This is similar to how
1375 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
1377 macro affects the output\&. If you know that
1379 isn\(cqt used in practise, or don\(cqt care if ccache produces objects where
1381 is expanded to something in the past, you can set
1384 \fBtime_macros\fR\&.
1389 \h'-04'\(bu\h'+03'\c
1397 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
1399 macro affects the output\&. If you know that
1401 isn\(cqt used in practise, or don\(cqt care if ccache produces objects where
1403 is expanded to the wrong path, you can set
1412 \h'-04'\(bu\h'+03'\c
1418 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
1422 macros, or use of automatically generated code that contains a timestamp, build counter or other volatile information\&.
1427 \h'-04'\(bu\h'+03'\c
1433 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\&.
1438 \h'-04'\(bu\h'+03'\c
1444 If \(lqunsupported compiler option\(rq has been incremented, enable debug logging and check which option was rejected\&.
1449 \h'-04'\(bu\h'+03'\c
1455 If \(lqpreprocessor error\(rq has been incremented, one possible reason is that precompiled headers are being used\&. See
1457 for how to remedy this\&.
1462 \h'-04'\(bu\h'+03'\c
1468 If \(lqcan\(cqt use precompiled header\(rq has been incremented, see
1469 PRECOMPILED HEADERS\&.
1471 .SS "Errors when compiling with ccache"
1473 If compilation doesn\(cqt work with ccache, but it works without it, one possible reason is that the compiler can\(cqt compile preprocessed output correctly\&. A workaround that may work is to enable \fBrun_second_cpp\fR*\&. This will make cache misses slower, though, so it is better to find and fix the root cause\&.
1474 .SS "Corrupt object files"
1476 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:
1486 Build so that the bad object file ends up in the build tree\&.
1497 Remove the bad object file from the build tree\&.
1509 \fBCCACHE_RECACHE\fR
1513 An alternative is to clear the whole cache with \fBccache \-C\fR if you don\(cqt mind losing other cached results\&.
1515 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\&.
1516 .SH "MORE INFORMATION"
1518 Credits, mailing list information, bug reporting instructions, source code, etc, can be found on ccache\(cqs web site: http://ccache\&.samba\&.org\&.
1521 ccache was originally written by Andrew Tridgell and is currently developed and maintained by Joel Rosdahl\&. See AUTHORS\&.txt or AUTHORS\&.html and http://ccache\&.samba\&.org/credits\&.html for a list of contributors\&.
projects / platform / upstream / ccache.git / blob