BuildCache internals documentation

Introduction

This documentation describes the BuildCache internals. It is mainly useful for BuildCache contributors.

Creating a new program wrapper

In order to add support for a new compiler or program, create a new class that inherits from the bcache::program_wrapper_t class.

Code structure

The BuildCache source code is divided into the following parts:

• base - A portable set of support classes and functions.
• sys - System specific support functions.
• cache - The implementation of the cache logic (wrapper independent).
• wrappers - The wrappers for different compilers and programs.
• config - Program configuration logic.
• third_party - Third party libraries.

Namespaces

The following namespaces are used in BuildCache:

• bcache
• bcache::comp
• bcache::config
• bcache::debug
• bcache::file
• bcache::perf
• bcache::serialize
• bcache::sys
• bcache::time