* Through the magic of functional programming, let stdenv export a

  function to regenerate itself with a different setup script.  This
  is useful for experimenting with changes to the setup script in
  specific packages without triggering a rebuild of everything.

* stdenv/generic/setup-latest.sh is a branch of setup.sh containing
  pending changes that will be merged into setup.sh eventually.

* setup-latest.sh: don't use tar's "z" and "j" flags.  Rather, call
  gzip and bunzip2 directly.

svn path=/nixpkgs/trunk/; revision=6066

2 files changed, 726 insertions, 42 deletions

diff --git a/pkgs/stdenv/generic/default.nix b/pkgs/stdenv/generic/default.nix
index 88f0b352ea09..52498e77ee7a 100644
--- a/pkgs/stdenv/generic/default.nix
+++ b/pkgs/stdenv/generic/default.nix
@@ -5,56 +5,69 @@
 
 let {
 
-  body =
+  stdenvGenerator = setupScript: rec {
 
-    stdenv.mkDerivation {
-      inherit name;
+    # The stdenv that we are producing.
+    result =
 
-      builder = ./builder.sh;
+      stdenv.mkDerivation {
+        inherit name;
 
-      substitute = ../../build-support/substitute/substitute.sh;
+        builder = ./builder.sh;
 
-      setup = ./setup.sh;
+        substitute = ../../build-support/substitute/substitute.sh;
 
-      inherit preHook postHook initialPath gcc shell;
+        setup = setupScript;
 
-      # TODO: make this more elegant.
-      inherit param1 param2 param3 param4 param5;
-    }
+        inherit preHook postHook initialPath gcc shell;
 
-    // {
+        # TODO: make this more elegant.
+        inherit param1 param2 param3 param4 param5;
+      }
+
+      // {
     
-      # Add a utility function to produce derivations that use this
-      # stdenv and its shell.
-      mkDerivation = attrs:
-        (derivation (
-          (removeAttrs attrs ["meta"])
+        # Add a utility function to produce derivations that use this
+        # stdenv and its shell.
+        mkDerivation = attrs:
+          (derivation (
+            (removeAttrs attrs ["meta"])
+            //
+            {
+              builder = if attrs ? realBuilder then attrs.realBuilder else shell;
+              args = if attrs ? args then attrs.args else
+                ["-e" (if attrs ? builder then attrs.builder else ./default-builder.sh)];
+              stdenv = result;
+              system = result.system;
+            })
+          )
           //
-          {
-            builder = if attrs ? realBuilder then attrs.realBuilder else shell;
-            args = if attrs ? args then attrs.args else
-              ["-e" (if attrs ? builder then attrs.builder else ./default-builder.sh)];
-            stdenv = body;
-            system = body.system;
-          })
-        )
-        //
-        # The meta attribute is passed in the resulting attribute set,
-        # but it's not part of the actual derivation, i.e., it's not
-        # passed to the builder and is not a dependency.  But since we
-        # include it in the result, it *is* available to nix-env for
-        # queries.
-        { meta = if attrs ? meta then attrs.meta else {}; };
-
-      # Utility value: is this a Darwin system?
-      isDarwin = body.system == "i686-darwin" || body.system == "powerpc-darwin";
-
-    }
-
-    # Propagate any extra attributes.  For instance, we use this to
-    # "lift" packages like curl from the final stdenv for Linux to
-    # all-packages.nix for that platform (meaning that it has a line
-    # like curl = if stdenv ? curl then stdenv.curl else ...).
-    // extraAttrs;
+          # The meta attribute is passed in the resulting attribute set,
+          # but it's not part of the actual derivation, i.e., it's not
+          # passed to the builder and is not a dependency.  But since we
+          # include it in the result, it *is* available to nix-env for
+          # queries.
+          { meta = if attrs ? meta then attrs.meta else {}; };
+
+        # Utility value: is this a Darwin system?
+        isDarwin = result.system == "i686-darwin" || result.system == "powerpc-darwin";
+
+        # Utility function: allow stdenv to be easily regenerated with
+        # a different setup script.  (See all-packages.nix for an
+        # example.)
+        regenerate = stdenvGenerator;
+
+      }
+
+      # Propagate any extra attributes.  For instance, we use this to
+      # "lift" packages like curl from the final stdenv for Linux to
+      # all-packages.nix for that platform (meaning that it has a line
+      # like curl = if stdenv ? curl then stdenv.curl else ...).
+      // extraAttrs;
+
+  }.result;
+
+  
+  body = stdenvGenerator ./setup.sh;
 
 }
diff --git a/pkgs/stdenv/generic/setup-latest.sh b/pkgs/stdenv/generic/setup-latest.sh
new file mode 100644
index 000000000000..31a173ccafcc
--- /dev/null
+++ b/pkgs/stdenv/generic/setup-latest.sh
@@ -0,0 +1,671 @@
+set -e
+
+test -z $NIX_GCC && NIX_GCC=@gcc@
+
+
+# Set up the initial path.
+PATH=
+for i in $NIX_GCC @initialPath@; do
+    PATH=$PATH${PATH:+:}$i/bin
+done
+
+if test "$NIX_DEBUG" = "1"; then
+    echo "Initial path: $PATH"
+fi
+
+
+# Execute the pre-hook.
+export SHELL=@shell@
+param1=@param1@
+param2=@param2@
+param3=@param3@
+param4=@param4@
+param5=@param5@
+if test -n "@preHook@"; then
+    source @preHook@
+fi
+
+
+# Check that the pre-hook initialised SHELL.
+if test -z "$SHELL"; then echo "SHELL not set"; exit 1; fi
+
+
+# Hack: run gcc's setup hook.
+envHooks=()
+if test -f $NIX_GCC/nix-support/setup-hook; then
+    source $NIX_GCC/nix-support/setup-hook
+fi
+
+    
+# Ensure that the given directory exists.
+ensureDir() {
+    local dir=$1
+    if ! test -x "$dir"; then mkdir -p "$dir"; fi
+}
+
+
+# Called when some build action fails.  If $succeedOnFailure is set,
+# create the file `$out/nix-support/failed' to signal failure, and
+# exit normally.  Otherwise, exit with failure.
+fail() {
+    exitCode=$?
+    if test "$succeedOnFailure" = 1; then
+        ensureDir "$out/nix-support"
+        touch "$out/nix-support/failed"
+        exit 0
+    else
+        exit $?
+    fi
+}
+
+
+# Allow the caller to augment buildInputs (it's not always possible to
+# do this before the call to setup.sh, since the PATH is empty at that
+# point; here we have a basic Unix environment).
+if test -n "$addInputsHook"; then
+    $addInputsHook
+fi
+
+
+# Recursively find all build inputs.
+findInputs()
+{
+    local pkg=$1
+
+    case $pkgs in
+        *\ $pkg\ *)
+            return 0
+            ;;
+    esac
+    
+    pkgs="$pkgs $pkg "
+
+    if test -f $pkg/nix-support/setup-hook; then
+        source $pkg/nix-support/setup-hook
+    fi
+    
+    if test -f $pkg/nix-support/propagated-build-inputs; then
+        for i in $(cat $pkg/nix-support/propagated-build-inputs); do
+            findInputs $i
+        done
+    fi
+}
+
+pkgs=""
+if test -n "$buildinputs"; then
+    buildInputs="$buildinputs" # compatibility
+fi
+for i in $buildInputs $propagatedBuildInputs; do
+    findInputs $i
+done
+
+
+# Set the relevant environment variables to point to the build inputs
+# found above.
+addToEnv()
+{
+    local pkg=$1
+
+    if test "$ignoreFailedInputs" != "1" -a -e $1/nix-support/failed; then
+        echo "failed input $1" >&2
+        fail
+    fi
+
+    if test -d $1/bin; then
+        export _PATH=$_PATH${_PATH:+:}$1/bin
+    fi
+
+    for i in "${envHooks[@]}"; do
+        $i $pkg
+    done
+}
+
+for i in $pkgs; do
+    addToEnv $i
+done
+
+
+# Add the output as an rpath.
+if test "$NIX_NO_SELF_RPATH" != "1"; then
+    export NIX_LDFLAGS="-rpath $out/lib $NIX_LDFLAGS"
+fi
+
+
+# Strip debug information by default.
+if test -z "$NIX_STRIP_DEBUG"; then
+    export NIX_STRIP_DEBUG=1
+    export NIX_CFLAGS_STRIP="-g0 -Wl,--strip-debug"
+fi
+
+
+# Do we know where the store is?  This is required for purity checking.
+if test -z "$NIX_STORE"; then
+    echo "Error: you have an old version of Nix that does not set the" \
+        "NIX_STORE variable.  Please upgrade." >&2
+    exit 1
+fi
+
+
+# We also need to know the root of the build directory for purity checking.
+if test -z "$NIX_BUILD_TOP"; then
+    echo "Error: you have an old version of Nix that does not set the" \
+        "NIX_BUILD_TOP variable.  Please upgrade." >&2
+    exit 1
+fi
+
+
+# Set the TZ (timezone) environment variable, otherwise commands like
+# `date' will complain (e.g., `Tue Mar 9 10:01:47 Local time zone must
+# be set--see zic manual page 2004').
+export TZ=UTC
+
+
+# Execute the post-hook.
+if test -n "@postHook@"; then
+    source @postHook@
+fi
+
+PATH=$_PATH${_PATH:+:}$PATH
+if test "$NIX_DEBUG" = "1"; then
+    echo "Final path: $PATH"
+fi
+
+
+######################################################################
+# What follows is the generic builder.
+
+
+nestingLevel=0
+
+startNest() {
+    nestingLevel=$(($nestingLevel + 1))
+    echo -en "\e[$1p"
+}
+
+stopNest() {
+    nestingLevel=$(($nestingLevel - 1))
+    echo -en "\e[q"
+}
+
+header() {
+    startNest "$2"
+    echo "$1"
+}
+
+# Make sure that even when we exit abnormally, the original nesting
+# level is properly restored.
+closeNest() {
+    while test $nestingLevel -gt 0; do
+        stopNest
+    done
+}
+
+trap "closeNest" EXIT
+
+
+# This function is useful for debugging broken Nix builds.  It dumps
+# all environment variables to a file `env-vars' in the build
+# directory.  If the build fails and the `-K' option is used, you can
+# then go to the build directory and source in `env-vars' to reproduce
+# the environment used for building.
+dumpVars() {
+    if test "$noDumpEnvVars" != "1"; then
+        export > $NIX_BUILD_TOP/env-vars
+    fi
+}
+
+
+# Redirect stdout/stderr to a named pipe connected to a `tee' process
+# that writes the specified file (and also to our original stdout).
+# The original stdout is saved in descriptor 3.
+startLog() {
+    local logFile=${logNr}_$1
+    logNr=$((logNr + 1))
+    if test "$logPhases" = 1; then
+        ensureDir $logDir
+
+        exec 3>&1
+
+        if test "$dontLogThroughTee" != 1; then
+            # This required named pipes (fifos).
+            logFifo=$NIX_BUILD_TOP/log_fifo
+            test -p $logFifo || mkfifo $logFifo
+            startLogWrite "$logDir/$logFile" "$logFifo"
+            exec > $logFifo 2>&1
+        else
+            exec > $logDir/$logFile 2>&1
+        fi
+    fi
+}
+
+# Factored into a separate function so that it can be overriden.
+startLogWrite() {
+    tee "$1" < "$2" &
+    logWriterPid=$!
+}
+
+
+if test -z "$logDir"; then
+    logDir=$out/log
+fi
+
+logNr=0
+
+# Restore the original stdout/stderr.
+stopLog() {
+    if test "$logPhases" = 1; then
+        exec >&3 2>&1
+
+        # Wait until the tee process has died.  Otherwise output from
+        # different phases may be mixed up.
+        if test -n "$logWriterPid"; then
+            wait $logWriterPid
+            logWriterPid=
+            rm $logFifo
+        fi
+    fi
+}
+
+
+# Utility function: return the base name of the given path, with the
+# prefix `HASH-' removed, if present.
+stripHash() {
+    strippedName=$(basename $1);
+    if echo "$strippedName" | grep -q '^[a-z0-9]\{32\}-'; then
+        strippedName=$(echo "$strippedName" | cut -c34-)
+    fi
+}
+
+
+unpackFile() {
+    local file=$1
+    local cmd
+
+    header "unpacking source archive $file" 3
+
+    case $file in
+        *.tar)
+            tar xvf $file || fail
+            ;;
+        *.tar.gz | *.tgz | *.tar.Z)
+            gunzip < $file | tar xvf - || fail
+            ;;
+        *.tar.bz2 | *.tbz2)
+            bunzip2 < $file | tar xvf - || fail
+            ;;
+        *.zip)
+            unzip $file || fail
+            ;;
+        *)
+            if test -d "$file"; then
+                stripHash $file
+                cp -prvd $file $strippedName || fail
+            else
+                if test -n "$findUnpacker"; then
+                    $findUnpacker $1;
+                fi
+                if test -z "$unpackCmd"; then
+                    echo "source archive $file has unknown type"
+                    exit 1
+                fi
+                $unpackCmd || fail
+            fi
+            ;;
+    esac
+
+    stopNest
+}
+
+
+unpackW() {
+    if test -n "$unpackPhase"; then
+        $unpackPhase
+        return
+    fi
+
+    if test -z "$srcs"; then
+        if test -z "$src"; then
+            echo 'variable $src or $srcs should point to the source'
+            exit 1
+        fi
+        srcs="$src"
+    fi
+
+    # To determine the source directory created by unpacking the
+    # source archives, we record the contents of the current
+    # directory, then look below which directory got added.  Yeah,
+    # it's rather hacky.
+    local dirsBefore=""
+    for i in *; do
+        if test -d "$i"; then
+            dirsBefore="$dirsBefore $i "
+        fi
+    done
+
+    # Unpack all source archives.
+    for i in $srcs; do
+        unpackFile $i
+    done
+
+    # Find the source directory.
+    if test -n "$setSourceRoot"; then
+        $setSourceRoot
+    else
+        sourceRoot=
+        for i in *; do
+            if test -d "$i"; then
+                case $dirsBefore in
+                    *\ $i\ *)
+                        ;;
+                    *)
+                        if test -n "$sourceRoot"; then
+                            echo "unpacker produced multiple directories"
+                            exit 1
+                        fi
+                        sourceRoot=$i
+                        ;;
+                esac
+            fi
+        done
+    fi
+
+    if test -z "$sourceRoot"; then
+        echo "unpacker appears to have produced no directories"
+        exit 1
+    fi
+
+    echo "source root is $sourceRoot"
+
+    # By default, add write permission to the sources.  This is often
+    # necessary when sources have been copied from other store
+    # locations.
+    if test "dontMakeSourcesWritable" != 1; then
+        chmod -R +w $sourceRoot
+    fi
+    
+    if test -n "$postUnpack"; then
+        $postUnpack
+    fi
+}
+
+
+unpackPhase() {
+    header "unpacking sources"
+    startLog "unpack"
+    unpackW
+    stopLog
+    stopNest
+}
+
+
+patchW() {
+    if test -n "$patchPhase"; then
+        $patchPhase
+        return
+    fi
+
+    for i in $patches; do
+        header "applying patch $i" 3
+        patch -p1 < $i || fail
+        stopNest
+    done
+}
+
+
+patchPhase() {
+    if test -z "$patchPhase" -a -z "$patches"; then return; fi
+    header "patching sources"
+    startLog "patch"
+    patchW
+    stopLog
+    stopNest
+}
+
+
+fixLibtool() {
+    sed 's^eval sys_lib_.*search_path=.*^^' < $1 > $1.tmp
+    mv $1.tmp $1
+}
+
+
+configureW() {
+    if test -n "$configurePhase"; then
+        $configurePhase
+        return
+    fi
+
+    if test -n "$preConfigure"; then
+        $preConfigure
+    fi
+
+    if test -z "$prefix"; then
+        prefix="$out";
+    fi
+
+    if test "$useTempPrefix" = "1"; then
+        prefix="$NIX_BUILD_TOP/tmp_prefix";
+    fi
+
+    if test -z "$configureScript"; then
+        configureScript=./configure
+        if ! test -x $configureScript; then
+            echo "no configure script, doing nothing"
+            return
+        fi
+    fi
+
+    if test -z "$dontFixLibtool"; then
+        for i in $(find . -name "ltmain.sh"); do
+            echo "fixing libtool script $i"
+            fixLibtool $i
+        done
+    fi
+
+    if test -z "$dontAddPrefix"; then
+        configureFlags="--prefix=$prefix $configureFlags"
+    fi
+
+    echo "configure flags: $configureFlags"
+    $configureScript $configureFlags || fail
+
+    if test -n "$postConfigure"; then
+        $postConfigure
+    fi
+}
+
+
+configurePhase() {
+    header "configuring"
+    startLog "configure"
+    configureW
+    stopLog
+    stopNest
+}
+
+
+buildW() {
+    if test -n "$buildPhase"; then
+        $buildPhase
+        return
+    fi
+
+    if test -n "$preBuild"; then
+        $preBuild
+    fi
+    
+    echo "make flags: $makeFlags"
+    make $makeFlags || fail
+
+    if test -n "$postBuild"; then
+        $postBuild
+    fi
+}
+
+
+buildPhase() {
+    if test "$dontBuild" = 1; then
+        return
+    fi
+    header "building"
+    startLog "build"
+    buildW
+    stopLog
+    stopNest
+}
+
+
+checkW() {
+    if test -n "$checkPhase"; then
+        $checkPhase
+        return
+    fi
+
+    if test -z "$checkTarget"; then
+        checkTarget="check"
+    fi
+
+    echo "check flags: $checkFlags"
+    make $checkFlags $checkTarget || fail
+}
+
+
+checkPhase() {
+    if test "$doCheck" != 1; then
+        return
+    fi
+    header "checking"
+    startLog "check"
+    checkW
+    stopLog
+    stopNest
+}
+
+
+patchELF() {
+    # Patch all ELF executables and shared libraries.
+    header "patching ELF executables and libraries"
+    find "$prefix" \( \
+        \( -type f -a -name "*.so*" \) -o \
+        \( -type f -a -perm +0100 \) \
+        \) -print -exec patchelf --shrink-rpath {} \;
+    stopNest
+}
+
+
+installW() {
+    if test -n "$installPhase"; then
+        $installPhase
+        return
+    fi
+    
+    if test -n "$preInstall"; then
+        $preInstall
+    fi
+
+    ensureDir "$prefix"
+    
+    if test -z "$dontMakeInstall"; then
+        echo "install flags: $installFlags"
+        make install $installFlags || fail
+    fi
+
+    if test -z "$dontStrip" -a "$NIX_STRIP_DEBUG" = 1; then
+        find "$prefix" -name "*.a" -exec echo stripping {} \; \
+            -exec strip -S {} \; || fail
+    fi
+
+    if test "$havePatchELF" = 1 -a -z "$dontPatchELF"; then
+        patchELF "$prefix"
+    fi
+
+    if test -n "$propagatedBuildInputs"; then
+        ensureDir "$out/nix-support"
+        echo "$propagatedBuildInputs" > "$out/nix-support/propagated-build-inputs"
+    fi
+
+    if test -n "$postInstall"; then
+        $postInstall
+    fi
+}
+
+
+installPhase() {
+    if test "$dontInstall" = 1; then
+        return
+    fi
+    header "installing"
+    startLog "install"
+    installW
+    stopLog
+    stopNest
+}
+
+
+distW() {
+    if test -n "$distPhase"; then
+        $distPhase
+        return
+    fi
+
+    if test -n "$preDist"; then
+        $preDist
+    fi
+    
+    if test -z "$distTarget"; then
+        distTarget="dist"
+    fi
+
+    echo "dist flags: $distFlags"
+    make $distFlags $distTarget || fail
+
+    if test "$dontCopyDist" != 1; then
+        ensureDir "$out/tarballs"
+
+        if test -z "$tarballs"; then
+            tarballs="*.tar.gz"
+        fi
+
+        # Note: don't quote $tarballs, since we explicitly permit
+        # wildcards in there.
+        cp -pvd $tarballs $out/tarballs
+    fi
+
+    if test -n "$postDist"; then
+        $postDist
+    fi
+}
+
+
+distPhase() {
+    if test "$doDist" != 1; then
+        return
+    fi
+    header "creating distribution"
+    startLog "dist"
+    distW
+    stopLog
+    stopNest
+}
+
+
+genericBuild() {
+    header "building $out"
+
+    unpackPhase
+    cd $sourceRoot
+
+    if test -z "$phases"; then
+        phases="patchPhase configurePhase buildPhase checkPhase \
+            installPhase distPhase";
+    fi
+
+    for i in $phases; do
+        dumpVars
+        $i
+    done
+    
+    stopNest
+}
+
+
+dumpVars