Libbitcoin Build

The libbitcoin-build repository is used by Libbitcoin maintainers to generate Autotols and other build artifacts from declarative sources. The purpose of the library is to maintain build quality and consistency across the Libbitcoin repositories without unnecessarily restricting contributions.

Generated Artifacts

.travis.yml
autogen.sh
configure.ac
install.sh
[library].pc.in
[library]_test_runner.sh
Makefile.am
include/bitcoin/[library].hpp
include/bitcoin/[library]/version.hpp

Design Overview

The Libbitcoin build system uses GSL for generation of build artifacts from a declarative XML model of each repository. The system also enumerates source files within each repository in order to generate a master [library].hpp and Makefile.am. Visual Studio projects and solutions are not currently generated. Scripts invoking SWIG are used to generate source code for Java and Python bindings.

Change Control Process

Maintainers generate and push resulting artifacts to each of the other repositories so that contributors have familiar context. Contributors to a given repository can edit the generated artifacts and later maintainers can determine whether to retain changes by incorporating them into the model. This allows less experienced contributors to introduce changes for review without introducing fragility into user-facing build, install and packaging processes.

Example Repository Model

 <repository name="libbitcoin-consensus" version="2.0.0" email="eric@voskuil.org" >

   <package library="bitcoin-consensus" description="Libbitcoin Consensus Library" url="https://github.com/libbitcoin/libbitcoin-consensus" />

   <configure>
     <option type="with" name="pkgconfigdir" default="${libdir}/pkgconfig" example="=DIR" unprefixed="true" substitute="true" description="Path to pkgconfig directory." />
     <option type="with" name="tests" default="yes" conditional="true" description="Compile with unit tests." />
     <option type="with" name="java" default="no" conditional="true" description="Compile the Java bindings." />
     <option type="with" name="python" default="no" conditional="true" description="Compile the Python bindings." />
     <option type="enable" name="ndebug" default="yes" define="NDEBUG" description="Compile without debug assertions." />
     <option type="enable" name="shared" default="yes" define="BOOST_TEST_DYN_LINK" inherited="true" description="Required for dynamically linking boost test." />
 
     ...
 
     <dependency name="boost" compiler="gcc" version="1.55.0" option="tests" />
     <dependency name="boost" compiler="clang" version="1.56.0" option="tests" />
     <dependency name="boost_unit_test_framework" option="tests" />
     <dependency name="secp256k1" version="0.0.1" />
     <dependency name="java" option="java" />
     <dependency name="python" version="2.7" option="python" />

     <flag name="Wall" comment="Warn on all stuff." context="c" />
     <flag name="Wextra" comment="Warn on extra stuff." context="c" />
     <flag name="Wpedantic" alternate="pedantic" comment="Be really annoying." context="c" />
     <flag name="Wno-missing-braces" comment="Conform to style." context="c++" />
     <flag name="Wno-mismatched-tags" compiler="clang" comment="Conflict in stdlib under clang." context="c++" />
 
     <flag name="fstack-protector" comment="Protect stack." context="link" />
     <flag name="fstack-protector-all" comment="Protect stack comprehensively." context="link" />
     <flag name="fvisibility-hidden" compiler="gcc" comment="Hide internal functions from external libs." context="c++" />
     <flag name="fvisibility-inlines-hidden" compiler="gcc" comment="Hide inlines from external libs." context="c++" />
   </configure>

   <make>
     <product prefix="pkgconfig" >
       <file path="libbitcoin-consensus.pc" />
     </product>
     <product prefix="doc" >
       <file path="AUTHORS" />
       <file path="COPYING" />
       <file path="ChangeLog" />
       <file path="INSTALL" />
       <file path="NEWS" />
       <file path="README" />
     </product>
     <product prefix="lib" path="src" name="bitcoin-consensus" uuid="6c521d95-00ce-4120-97d1-430e2870d738" >
       <library name="secp256k1" />
       <headers path="include" />
       <headers path="src" />
       <headers path="src/clone" />
       <sources path="src" />
     </product>
     <product prefix="bin" path="test" name="libbitcoin_consensus_test" test="true" option="tests" uuid="d282ef8c-6217-483c-ac47-864b2fba50fd" >
       <runner/>
       <library name="bitcoin-consensus" />
       <library name="boost" />
       <library name="boost_unit_test_framework" />
       <headers path="include" />
       <headers path="src" />
       <headers path="src/clone" />
       <sources path="test" />
     </product>
     <product prefix="include" container="bitcoin" >
       <files path="include/bitcoin" />
     </product>
     <product prefix="lib" path="bindings/java/wrap" name="bitcoin-consensus-jni" option="java" >
       <library name="bitcoin-consensus" />
       <library name="java" />
       <headers path="include" />
       <sources path="bindings/java/wrap" />
     </product>
     <product prefix="javaexec" distribute="true" install="false" option="java" >
       <files path="bindings/java/proxy/org/libbitcoin/consensus" />
     </product>
     <product prefix="jarexec" distribute="false" install="true" option="java" >
       <file path="org.libbitcoin.consensus-${VERSION}.jar" />
     </product>
     <product prefix="pkgpyexec" path="bindings/python/wrap" name="_bitcoin-consensus" unprefixed="true" option="python" >
       <library name="bitcoin-consensus" />
       <library name="python" />
       <headers path="include" />
       <sources path="bindings/python/wrap" />
     </product>
     <product prefix="pkgpython" option="python" >
       <files path="bindings/python/proxy" />
     </product>
   </make>

   <install>
     <build name="boost" version="1.56.0" parallel="true">
       <option value="--with-system" />
       <option value="--with-test" />
     </build>
     <build name="secp256k1" github="libbitcoin" repository="secp256k1" branch="version4" parallel="true" >
       <option value="--disable-tests" />
       <option value="--enable-module-recovery" />
     </build>
     <build name="bitcoin-consensus" github="libbitcoin" repository="libbitcoin-consensus" branch="version2" parallel="true" >
       <option value="${with_boost}" />
       <option value="${with_pkgconfigdir}" />
     </build>
   </install>

   <matrix>
     <job system="osx" compiler="clang" link="static" >
       <get name="swig" />
       <option value="--with-java" />
       <option value="--disable-shared" />
       <option value="--build-boost" />
       <option value="--prefix=$TRAVIS_BUILD_DIR/my-prefix" />
     </job>
     <job system="linux" compiler="clang" link="static" >
       <get name="swig" />
       <option value="--with-python" />
       <option value="--disable-shared" />
       <option value="--build-boost" />
       <option value="--prefix=$TRAVIS_BUILD_DIR/my-prefix" />
       <option value="CFLAGS='-Os'" />
       <option value="CXXFLAGS='-Os'" />
     </job>
     <job system="linux" compiler="gcc" link="static" coverage="true" >
       <exclude path="clone/*" />
       <get name="swig" />
       <option value="--with-java" />
       <option value="--disable-shared" />
       <option value="--build-boost" />
       <option value="--build-dir=my-build" />
       <option value="--prefix=$TRAVIS_BUILD_DIR/my-prefix" />
       <option value="CFLAGS='-O0 -g --coverage'" />
       <option value="CXXFLAGS='-O0 -g --coverage'" />
     </job>
     <job system="osx" compiler="clang" link="dynamic" >
       <get name="boost" />
       <get name="swig" />
       <option value="--with-python" />
     </job>
     <job system="linux" compiler="clang" link="dynamic" sudo="true" >
       <option value="--build-boost" />
       <option value="--disable-ndebug" />
       <option value="--disable-static" />
       <option value="CFLAGS='-Os'" />
       <option value="CXXFLAGS='-Os'" />
     </job>
     <job system="linux" compiler="gcc" link="dynamic" sudo="true" >
       <get name="swig" />
       <option value="--with-java" />
       <option value="--with-python" />
       <option value="--disable-static" />
       <option value="--build-boost" />
       <option value="CFLAGS='-Os -s'" />
       <option value="CXXFLAGS='-Os -s'" />
     </job>
   </matrix>

 </repository>

Dependencies

• GSL/4.1 - Universal Code Generator
• SWIG - Simplified Wrapper and Interface Generator

See Also

• Libbitcoin