https://github.com/mozilla/sccache Skip to content Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} mozilla / sccache Public * Notifications * Fork 494 * Star 4.9k sccache is ccache with cloud storage License Apache-2.0 license 4.9k stars 494 forks Activity Star Notifications * Code * Issues 316 * Pull requests 26 * Discussions * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights mozilla/sccache This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 19 branches 46 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/m] Use Git or checkout with SVN using the web URL. [gh repo clone mozill] Work fast with our official CLI. Learn more about the CLI. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @vincentdephily vincentdephily Versionbump opendal 0.41.0 -> 0.43.0 (#1992) ... 855ec0f Dec 14, 2023 Versionbump opendal 0.41.0 -> 0.43.0 (#1992) Remove the `opendal/services-redis-rustls` feature as it's no longer available/needed. 855ec0f Git stats * 1,848 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github build(deps): bump vmactions/freebsd-vm from 1.0.4 to 1.0.5 December 11, 2023 18:40 docs Only activate direct mode by default for local November 23, 2023 09:13 scripts Update FreeBSD CI to 13.2-RELEASE (#1879) September 5, 2023 13:25 snap Fix some typos November 14, 2023 21:51 src Activate direct mode when e.g. SCCACHE_DIR is set. November 24, 2023 08:52 tests Fix some typos November 14, 2023 21:51 .gitignore gitignore VSCode Workspace Files November 11, 2022 00:48 .pre-commit-config.yaml add a pre-commit conf November 7, 2023 09:43 .taplo.toml chore: Make sure Cargo.toml is formatted June 6, 2023 17:56 CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file March 29, 2019 14:56 Cargo.lock Versionbump opendal 0.41.0 -> 0.43.0 (#1992) December 14, 2023 15:14 Cargo.toml Versionbump opendal 0.41.0 -> 0.43.0 (#1992) December 14, 2023 15:14 LICENSE Somewhat-fleshed-out skeleton. April 26, 2016 16:43 README.md Fix some typos November 14, 2023 21:51 View code [ ] sccache - Shared Compilation Cache Table of Contents (ToC) Installation macOS Windows Via cargo Usage Build Requirements Build Building portable binaries Linux macOS Windows Separating caches between invocations Overwriting the cache Debugging Interaction with GNU make jobserver Known Caveats General Rust Symbolic links Storage Options README.md Build Status Crates.io Matrix Crates.io dependency status CodeCov sccache - Shared Compilation Cache sccache is a ccache-like compiler caching tool. It is used as a compiler wrapper and avoids compilation when possible, storing cached results either on local disk or in one of several cloud storage backends. sccache includes support for caching the compilation of C/C++ code, Rust, as well as NVIDIA's CUDA using nvcc, and clang. sccache also provides icecream-style distributed compilation (automatic packaging of local toolchains) for all supported compilers (including Rust). The distributed compilation system includes several security features that icecream lacks such as authentication, transport layer encryption, and sandboxed compiler execution on build servers. See the distributed quickstart guide for more information. sccache is also available as a GitHub Actions to facilitate the deployment using GitHub Actions cache. --------------------------------------------------------------------- Table of Contents (ToC) * Installation * Usage * Build Requirements * Build * Separating caches between invocations * Overwriting the cache * Debugging * Interaction with GNU make jobserver * Known Caveats * Storage Options + Local + S3 + R2 + Redis + Memcached + Google Cloud Storage + Azure + GitHub Actions + WebDAV (Ccache/Bazel/Gradle compatible) --------------------------------------------------------------------- Installation There are prebuilt x86-64 binaries available for Windows, Linux (a portable binary compiled against musl), and macOS on the releases page. Several package managers also include sccache packages, you can install the latest release from source using cargo, or build directly from a source checkout. macOS On macOS sccache can be installed via Homebrew: brew install sccache or via MacPorts: sudo port install sccache Windows On Windows, sccache can be installed via scoop: scoop install sccache Via cargo If you have a Rust toolchain installed you can install sccache using cargo. Note that this will compile sccache from source which is fairly resource-intensive. For CI purposes you should use prebuilt binary packages. cargo install sccache --locked --------------------------------------------------------------------- Usage Running sccache is like running ccache: prefix your compilation commands with it, like so: sccache gcc -o foo.o -c foo.c If you want to use sccache for caching Rust builds you can define build.rustc-wrapper in the cargo configuration file. For example, you can set it globally in $HOME/.cargo/config.toml by adding: [build] rustc-wrapper = "/path/to/sccache" Note that you need to use cargo 1.40 or newer for this to work. Alternatively you can use the environment variable RUSTC_WRAPPER: export RUSTC_WRAPPER=/path/to/sccache cargo build sccache supports gcc, clang, MSVC, rustc, NVCC, NVC++, and Wind River's diab compiler. Both gcc and msvc support Response Files, read more about their implementation here. If you don't specify otherwise, sccache will use a local disk cache. sccache works using a client-server model, where the server runs locally on the same machine as the client. The client-server model allows the server to be more efficient by keeping some state in memory. The sccache command will spawn a server process if one is not already running, or you can run sccache --start-server to start the background server process without performing any compilation. You can run sccache --stop-server to terminate the server. It will also terminate after (by default) 10 minutes of inactivity. Running sccache --show-stats will print a summary of cache statistics. Some notes about using sccache with Jenkins are here. To use sccache with cmake, provide the following command line arguments to cmake 3.4 or newer: -DCMAKE_C_COMPILER_LAUNCHER=sccache -DCMAKE_CXX_COMPILER_LAUNCHER=sccache To generate PDB files for debugging with MSVC, you can use the /Z7 option. Alternatively, the /Zi option together with /Fd can work if / Fd names a different PDB file name for each object file created. Note that CMake sets /Zi by default, so if you use CMake, you can use /Z7 by adding code like this in your CMakeLists.txt: if(CMAKE_BUILD_TYPE STREQUAL "Debug") string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}") string(REPLACE "/Zi" "/Z7" CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG}") elseif(CMAKE_BUILD_TYPE STREQUAL "Release") string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}") string(REPLACE "/Zi" "/Z7" CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE}") elseif(CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo") string(REPLACE "/Zi" "/Z7" CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO}") string(REPLACE "/Zi" "/Z7" CMAKE_C_FLAGS_RELWITHDEBINFO "${CMAKE_C_FLAGS_RELWITHDEBINFO}") endif() By default, sccache will fail your build if it fails to successfully communicate with its associated server. To have sccache instead gracefully failover to the local compiler without stopping, set the environment variable SCCACHE_IGNORE_SERVER_IO_ERROR=1. Update: On CMake 3.25, you have to use the new CMAKE_MSVC_DEBUG_INFORMATION_FORMAT option, meant to configure the -Z7 flag: set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT Embedded) Example configuration where we automatically look for sccache in the PATH: find_program(SCCACHE sccache REQUIRED) set(CMAKE_C_COMPILER_LAUNCHER ${SCCACHE}) set(CMAKE_CXX_COMPILER_LAUNCHER ${SCCACHE}) set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT Embedded) And you can build code as usual without any additional flags in the command line, useful for IDEs. --------------------------------------------------------------------- Build Requirements sccache is a Rust program. Building it requires cargo (and thusrustc). sccache currently requires Rust 1.67.1. We recommend you install Rust via Rustup. Build If you are building sccache for non-development purposes make sure you use cargo build --release to get optimized binaries: cargo build --release [--no-default-features --features=s3|redis|gcs|memcached|azure] By default, sccache builds with support for all storage backends, but individual backends may be disabled by resetting the list of features and enabling all the other backends. Refer the Cargo Documentation for details on how to select features with Cargo. Feature vendored-openssl can be used to statically link with openssl if feature openssl is enabled. Building portable binaries When building with the dist-server feature, sccache will depend on OpenSSL, which can be an annoyance if you want to distribute portable binaries. It is possible to statically link against OpenSSL using the openssl/vendored feature. Linux Build with cargo and use ldd to check that the resulting binary does not depend on OpenSSL anymore. macOS Build with cargo and use otool -L to check that the resulting binary does not depend on OpenSSL anymore. Windows On Windows, the binary might also depend on a few MSVC CRT DLLs that are not available on older Windows versions. It is possible to statically link against the CRT using a .cargo/ config.toml file with the following contents. [target.x86_64-pc-windows-msvc] rustflags = ["-Ctarget-feature=+crt-static"] Build with cargo and use dumpbin /dependents to check that the resulting binary does not depend on MSVC CRT DLLs anymore. When statically linking with OpenSSL, you will need Perl available in your $PATH. --------------------------------------------------------------------- Separating caches between invocations In situations where several different compilation invocations should not reuse the cached results from each other, one can set SCCACHE_C_CUSTOM_CACHE_BUSTER to a unique value that'll be mixed into the hash. MACOSX_DEPLOYMENT_TARGET and IPHONEOS_DEPLOYMENT_TARGET variables already exhibit such reuse-suppression behaviour. There are currently no such variables for compiling Rust. --------------------------------------------------------------------- Overwriting the cache In situations where the cache contains broken build artifacts, it can be necessary to overwrite the contents in the cache. That can be achieved by setting the SCCACHE_RECACHE environment variable. --------------------------------------------------------------------- Debugging You can set the SCCACHE_ERROR_LOG environment variable to a path and set SCCACHE_LOG to get the server process to redirect its logging there (including the output of unhandled panics, since the server sets RUST_BACKTRACE=1 internally). SCCACHE_ERROR_LOG=/tmp/sccache_log.txt SCCACHE_LOG=debug sccache You can also set these environment variables for your build system, for example SCCACHE_ERROR_LOG=/tmp/sccache_log.txt SCCACHE_LOG=debug cmake --build /path/to/cmake/build/directory Alternatively, if you are compiling locally, you can run the server manually in foreground mode by running SCCACHE_START_SERVER=1 SCCACHE_NO_DAEMON=1 sccache, and send logging to stderr by setting the SCCACHE_LOG environment variable for example. This method is not suitable for CI services because you need to compile in another shell at the same time. SCCACHE_LOG=debug SCCACHE_START_SERVER=1 SCCACHE_NO_DAEMON=1 sccache --------------------------------------------------------------------- Interaction with GNU make jobserver sccache provides support for a GNU make jobserver. When the server is started from a process that provides a jobserver, sccache will use that jobserver and provide it to any processes it spawns. (If you are running sccache from a GNU make recipe, you will need to prefix the command with + to get this behavior.) If the sccache server is started without a jobserver present it will create its own with the number of slots equal to the number of available CPU cores. This is most useful when using sccache for Rust compilation, as rustc supports using a jobserver for parallel codegen, so this ensures that rustc will not overwhelm the system with codegen tasks. Cargo implements its own jobserver (see the information on NUM_JOBS in the cargo documentation) for rustc to use, so using sccache for Rust compilation in cargo via RUSTC_WRAPPER should do the right thing automatically. --------------------------------------------------------------------- Known Caveats General * Absolute paths to files must match to get a cache hit. This means that even if you are using a shared cache, everyone will have to build at the same absolute path (i.e. not in $HOME) in order to benefit each other. In Rust this includes the source for third party crates which are stored in $HOME/.cargo/registry/cache by default. Rust * Crates that invoke the system linker cannot be cached. This includes bin, dylib, cdylib, and proc-macro crates. You may be able to improve compilation time of large bin crates by converting them to a lib crate with a thin bin wrapper. * Incrementally compiled crates cannot be cached. By default, in the debug profile Cargo will use incremental compilation for workspace members and path dependencies. You can disable incremental compilation. More details on Rust caveats Symbolic links * Symbolic links to sccache won't work. Use hardlinks: ln sccache / usr/local/bin/cc Storage Options * Local * S3 * R2 * Redis * Memcached * Google Cloud Storage * Azure * GitHub Actions * WebDAV (Ccache/Bazel/Gradle compatible) About sccache is ccache with cloud storage Resources Readme License Apache-2.0 license Code of conduct Code of conduct Activity Stars 4.9k stars Watchers 46 watching Forks 494 forks Report repository Releases 41 v0.7.4 Latest Nov 27, 2023 + 40 releases Packages 0 No packages published Used by 342 * @IsolatedLun * @Maaarcocr * @IsolatedLun * @bc-lee * @briancabbott * @sarvex * @Unearthlyglow * @TJVaughn + 334 Contributors 191 * @luser * @dependabot[bot] * @glandium * @aidanhs * @chmanchester * @sylvestre * @froydnj * @alexcrichton * @flxo * @robertmaynard * @Xanewok * @Xuanwo * @jschwe * @sigiesec + 177 contributors Languages * Rust 98.5% * Shell 1.2% * C 0.1% * C++ 0.1% * Cuda 0.1% * M4 0.0% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.