Code Monkey home page Code Monkey logo

sccache's Introduction

Build Status Build status

sccache - Shared Compilation Cache

Sccache is a ccache-like tool. It is used as a compiler wrapper and avoids compilation when possible, storing a cache in a remote storage using the S3 API.

It works as a client-server. The client spawns a server if one is not running already, and sends the wrapped command line as a request to the server, which then does the work and returns stdout/stderr for the job. The client-server model allows the server to be more efficient in its handling of the remote storage.

Sccache can also be used with local storage instead of remote.

Requirements

Sccache is a Rust program.

Usage

Before using sccache, you need to set one of the following environment variables:

  • SCCACHE_BUCKET: sets the S3 bucket name for remote storage.
  • SCCACHE_DIR: sets a directory where to store data locally.

Only SCCACHE_DIR will be used if both are set. Those variables are only taken into account when the server starts, so only on the first run.

Running sccache is like running ccache: wrap your compilation commands with it, like so:

$ sccache gcc -o foo.o -c foo.c

Sccache (tries to) support gcc, clang and MSVC.

Running sccache without a compilation command line will terminate the server.

Known caveats

(and possible future improvements)

  • Sccache doesn't try to be smart about the command line arguments it uses when computing a key for a given compilation result (like skipping preprocessor-specific arguments)
  • It doesn't support all kinds of compiler flags, and is certainly broken with a few of them. Really only the flags used during Firefox builds have been tested.
  • It doesn't support ccache's direct mode.
  • Local storage mode doesn't do any kind of cleanup. The cache will keep growing indefinitely.

sccache's People

Contributors

luser avatar glandium avatar f3real avatar gittup avatar legneato avatar ehsan avatar gregarndt avatar

Stargazers

Steve Wills avatar

Watchers

Harshavardhana avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.