pkgs/development/libraries/boehm-gc/default.nix

   1 { lib
   2 , stdenv
   3 , fetchurl
   4 , autoreconfHook
   5 # doc: https://github.com/ivmai/bdwgc/blob/v8.2.2/doc/README.macros (LARGE_CONFIG)
   6 , enableLargeConfig ? false
   7 , enableMmap ? true
   8 , nixVersions
   9 }:
  10
  11 stdenv.mkDerivation (finalAttrs: {
  12   pname = "boehm-gc";
  13   version = "8.2.2";
  14
  15   src = fetchurl {
  16     urls = [
  17       # "https://www.hboehm.info/gc/gc_source/gc-${finalAttrs.version}.tar.gz"
  18       "https://github.com/ivmai/bdwgc/releases/download/v${finalAttrs.version}/gc-${finalAttrs.version}.tar.gz"
  19     ];
  20     sha256 = "sha256-8wEHvLBi4JIKeQ//+lbZUSNIVGhZNkwjoUviZLOINqA=";
  21   };
  22
  23   outputs = [ "out" "dev" "doc" ];
  24   separateDebugInfo = stdenv.isLinux && stdenv.hostPlatform.libc != "musl";
  25
  26   configureFlags = [
  27     "--enable-cplusplus"
  28     "--with-libatomic-ops=none"
  29   ]
  30   ++ lib.optional enableMmap "--enable-mmap"
  31   ++ lib.optional enableLargeConfig "--enable-large-config";
  32
  33   # `gctest` fails under emulation on aarch64-darwin
  34   doCheck = !(stdenv.isDarwin && stdenv.isx86_64);
  35
  36   enableParallelBuilding = true;
  37
  38   passthru.tests = nixVersions;
  39
  40   meta = with lib; {
  41     homepage = "https://hboehm.info/gc/";
  42     description = "The Boehm-Demers-Weiser conservative garbage collector for C and C++";
  43     longDescription = ''
  44       The Boehm-Demers-Weiser conservative garbage collector can be used as a
  45       garbage collecting replacement for C malloc or C++ new.  It allows you
  46       to allocate memory basically as you normally would, without explicitly
  47       deallocating memory that is no longer useful.  The collector
  48       automatically recycles memory when it determines that it can no longer
  49       be otherwise accessed.
  50
  51       The collector is also used by a number of programming language
  52       implementations that either use C as intermediate code, want to
  53       facilitate easier interoperation with C libraries, or just prefer the
  54       simple collector interface.
  55
  56       Alternatively, the garbage collector may be used as a leak detector for
  57       C or C++ programs, though that is not its primary goal.
  58     '';
  59     # non-copyleft, X11-style license
  60     changelog = "https://github.com/ivmai/bdwgc/blob/v${finalAttrs.version}/ChangeLog";
  61     license = "https://hboehm.info/gc/license.txt";
  62     maintainers = with maintainers; [ AndersonTorres ];
  63     platforms = platforms.all;
  64   };
  65 })