BUILD

   1 Building Dinit
   2 =-=-=-=-=-=-=-
   3
   4 Building Dinit should be a straight-forward process. It requires GNU make.
   5
   6 Edit the "mconfig" file to choose appropriate values for the configuration variables defined
   7 within. In particular:
   8
   9   CXX : should be set to the name of the C++ compiler (and linker)
  10   CXXOPTS :  are options passed to the compiler during compilation (see note for GCC below)
  11   LDFLAGS :  are any extra flags required for linking; should not normally be needed
  12              (FreeBSD requires -lrt).
  13
  14 Suitable defaults for a number of systems are provided. Note that the "eg++" or "clang++" package
  15 must be installed on OpenBSD as the default "g++" compiler is too old. Clang is part of the base
  16 system in recent releases.
  17
  18 Then, change into the "src" directory, and run "make" (or "gmake" if the system make is not
  19 GNU make, such as on most BSD systems):
  20
  21     cd src
  22     make
  23
  24 If everything goes smoothly this will build dinit, dinitctl, and optionally the shutdown
  25 utility. Use "make install" to install; you can specify an alternate installation by
  26 setting the "DESTDIR" variable, eg "make DESTDIR=/tmp/temporary-install-path install".
  27
  28
  29 Running test suite
  30 =-=-=-=-=-=-=-=-=-
  31
  32 Build the "check" target in order to run the test suite:
  33
  34     make check
  35
  36 The standard mconfig options enable various sanitizers during build of the tests. On Linux you may
  37 see an error such as the following:
  38
  39     make[3]: Leaving directory '/home/davmac/workspace/dinit/src/tests/cptests'
  40     ./tests
  41     ==25332==ERROR: AddressSanitizer failed to allocate 0xdfff0001000 (15392894357504) bytes at
  42     address 2008fff7000 (errno: 12)
  43     ==25332==ReserveShadowMemoryRange failed while trying to map 0xdfff0001000 bytes. Perhaps
  44     you're using ulimit -v
  45     make[2]: *** [Makefile:12: run-tests] Aborted
  46
  47 If you get this, either disable the address sanitizer or make sure you have overcommit enabled:
  48
  49     echo 1 > /proc/sys/vm/overcommit_memory
  50
  51 Any test failures will abort the test suite run immediately.
  52
  53 In addition to the standard test suite, there is experimental support for fuzzing the control
  54 protocol handling using LLVM/clang's fuzzer (libFuzzer). Change to the `src/tests/cptests`
  55 directory and build the "fuzz" target:
  56
  57     make fuzz
  58
  59 Then create a "corpus" directory and run the fuzzer:
  60
  61     mkdir corpus
  62     ./fuzz corpus
  63
  64 This will auto-generate test data as it finds input which triggers new execution paths. Check
  65 libFuzzer documentation for further details.
  66
  67
  68 Special note for GCC/Libstdc++
  69 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  70
  71 (Note: the issue discussed here has apparently been resolved in recent GCC versions).
  72
  73 GCC 5.x onwards includes a "dual ABI" in its standard library implementation, aka Libstdc++.
  74 Compiling against the newer (C++11 and later) ABI can be achieved by adding
  75 -D_GLIBCXX_USE_CXX11_ABI=1 to the compiler command line; this uses a non-standard language
  76 extension to differently mangle symbol names in order to link against the new ABI versions.
  77
  78 (Some systems may be configured to build with the new ABI by default, and in that case you
  79 build against the old ABI using D_GLIBCXX_USE_CXX11_ABI=1).
  80
  81 This is problematic for several reasons. First, it prevents linking against the new ABI with
  82 other compilers that do not understand the language extension (LLVM i.e. clang++ does so
  83 in recent versions, so this is perhaps no longer much of a problem in practice). Secondly,
  84 some aspects of library behavior are ABI-dependent but cannot be changed using the ABI
  85 macro; in particular, exceptions thrown as a result of failed I/O operations are, in GCC
  86 versions 5.x and 6.x, always "old ABI" exceptions which cannot be caught by code compiled
  87 against the new ABI, and in GCC version 7.x they are always "new ABI" exceptions which cannot
  88 be caught by code compiled against the old ABI. Since the one library object now supposedly
  89 houses both ABIs, this means that at least one of the two ABIs is always broken.
  90
  91 A blog post describing the dual ABI mechanism can be found here:
  92
  93     https://developers.redhat.com/blog/2015/02/05/gcc5-and-the-c11-abi/
  94
  95 The bug regarding the issue with catching other-ABI exceptions is here:
  96
  97     https://gcc.gnu.org/bugzilla/show_bug.cgi?id=66145
  98
  99 Since Dinit is affected by this bug, the unfortunate possibility exists to break Dinit by
 100 upgrading GCC. If you have libstdc++ corresponding to GCC 5.x or 6.x, you *must* build with
 101 the old ABI, but Dinit will be broken if you upgrade to GCC 7. If you have libstdc++ from
 102 GCC 7, you *must* build with the new ABI. If the wrong ABI is used, Dinit may still run
 103 successfully but any attempt to load a non-existing service, for example, will cause Dinit
 104 to crash.