#include "derivation-goal.hh" #include "hook-instance.hh" #include "worker.hh" #include "builtins.hh" #include "builtins/buildenv.hh" #include "references.hh" #include "finally.hh" #include "archive.hh" #include "compression.hh" #include "common-protocol.hh" #include "common-protocol-impl.hh" #include "topo-sort.hh" #include "local-store.hh" // TODO remove, along with remaining downcasts #include "logging-json.hh" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if HAVE_STATVFS #include #endif /* Includes required for chroot support. */ #if __linux__ #include #include #include #include #include #include #include #include #include #if HAVE_SECCOMP #include #endif #define pivot_root(new_root, put_old) (syscall(SYS_pivot_root, new_root, put_old)) #endif #if __APPLE__ #include #include #endif #include #include #include namespace nix { DerivationGoal::DerivationGoal(const StorePath & drvPath, const OutputsSpec & wantedOutputs, Worker & worker, BuildMode buildMode) : Goal(worker, DerivedPath::Built { .drvPath = makeConstantStorePathRef(drvPath), .outputs = wantedOutputs }) , useDerivation(true) , drvPath(drvPath) , wantedOutputs(wantedOutputs) , buildMode(buildMode) { state = &DerivationGoal::getDerivation; name = fmt( "building of '%s' from .drv file", DerivedPath::Built { makeConstantStorePathRef(drvPath), wantedOutputs }.to_string(worker.store)); trace("created"); mcExpectedBuilds = std::make_unique>(worker.expectedBuilds); worker.updateProgress(); } DerivationGoal::DerivationGoal(const StorePath & drvPath, const BasicDerivation & drv, const OutputsSpec & wantedOutputs, Worker & worker, BuildMode buildMode) : Goal(worker, DerivedPath::Built { .drvPath = makeConstantStorePathRef(drvPath), .outputs = wantedOutputs }) , useDerivation(false) , drvPath(drvPath) , wantedOutputs(wantedOutputs) , buildMode(buildMode) { this->drv = std::make_unique(drv); state = &DerivationGoal::haveDerivation; name = fmt( "building of '%s' from in-memory derivation", DerivedPath::Built { makeConstantStorePathRef(drvPath), drv.outputNames() }.to_string(worker.store)); trace("created"); mcExpectedBuilds = std::make_unique>(worker.expectedBuilds); worker.updateProgress(); /* Prevent the .chroot directory from being garbage-collected. (See isActiveTempFile() in gc.cc.) */ worker.store.addTempRoot(this->drvPath); } DerivationGoal::~DerivationGoal() noexcept(false) { /* Careful: we should never ever throw an exception from a destructor. */ try { closeLogFile(); } catch (...) { ignoreException(); } } std::string DerivationGoal::key() { /* Ensure that derivations get built in order of their name, i.e. a derivation named "aardvark" always comes before "baboon". And substitution goals always happen before derivation goals (due to "b$"). */ return "b$" + std::string(drvPath.name()) + "$" + worker.store.printStorePath(drvPath); } void DerivationGoal::killChild() { hook.reset(); } void DerivationGoal::timedOut(Error && ex) { killChild(); done(BuildResult::TimedOut, {}, std::move(ex)); } void DerivationGoal::work() { (this->*state)(); } void DerivationGoal::addWantedOutputs(const OutputsSpec & outputs) { auto newWanted = wantedOutputs.union_(outputs); switch (needRestart) { case NeedRestartForMoreOutputs::OutputsUnmodifedDontNeed: if (!newWanted.isSubsetOf(wantedOutputs)) needRestart = NeedRestartForMoreOutputs::OutputsAddedDoNeed; break; case NeedRestartForMoreOutputs::OutputsAddedDoNeed: /* No need to check whether we added more outputs, because a restart is already queued up. */ break; case NeedRestartForMoreOutputs::BuildInProgressWillNotNeed: /* We are already building all outputs, so it doesn't matter if we now want more. */ break; }; wantedOutputs = newWanted; } void DerivationGoal::getDerivation() { trace("init"); /* The first thing to do is to make sure that the derivation exists. If it doesn't, it may be created through a substitute. */ if (buildMode == bmNormal && worker.evalStore.isValidPath(drvPath)) { loadDerivation(); return; } addWaitee(upcast_goal(worker.makePathSubstitutionGoal(drvPath))); state = &DerivationGoal::loadDerivation; } void DerivationGoal::loadDerivation() { trace("loading derivation"); if (nrFailed != 0) { done(BuildResult::MiscFailure, {}, Error("cannot build missing derivation '%s'", worker.store.printStorePath(drvPath))); return; } /* `drvPath' should already be a root, but let's be on the safe side: if the user forgot to make it a root, we wouldn't want things being garbage collected while we're busy. */ worker.evalStore.addTempRoot(drvPath); /* Get the derivation. It is probably in the eval store, but it might be inthe main store: - Resolved derivation are resolved against main store realisations, and so must be stored there. - Dynamic derivations are built, and so are found in the main store. */ for (auto * drvStore : { &worker.evalStore, &worker.store }) { if (drvStore->isValidPath(drvPath)) { drv = std::make_unique(drvStore->readDerivation(drvPath)); break; } } assert(drv); haveDerivation(); } void DerivationGoal::haveDerivation() { trace("have derivation"); parsedDrv = std::make_unique(drvPath, *drv); if (!drv->type().hasKnownOutputPaths()) experimentalFeatureSettings.require(Xp::CaDerivations); if (!drv->type().isPure()) { experimentalFeatureSettings.require(Xp::ImpureDerivations); for (auto & [outputName, output] : drv->outputs) { auto randomPath = StorePath::random(outputPathName(drv->name, outputName)); assert(!worker.store.isValidPath(randomPath)); initialOutputs.insert({ outputName, InitialOutput { .wanted = true, .outputHash = impureOutputHash, .known = InitialOutputStatus { .path = randomPath, .status = PathStatus::Absent } } }); } gaveUpOnSubstitution(); return; } for (auto & i : drv->outputsAndOptPaths(worker.store)) if (i.second.second) worker.store.addTempRoot(*i.second.second); auto outputHashes = staticOutputHashes(worker.evalStore, *drv); for (auto & [outputName, outputHash] : outputHashes) initialOutputs.insert({ outputName, InitialOutput { .wanted = true, // Will be refined later .outputHash = outputHash } }); /* Check what outputs paths are not already valid. */ auto [allValid, validOutputs] = checkPathValidity(); /* If they are all valid, then we're done. */ if (allValid && buildMode == bmNormal) { done(BuildResult::AlreadyValid, std::move(validOutputs)); return; } /* We are first going to try to create the invalid output paths through substitutes. If that doesn't work, we'll build them. */ if (settings.useSubstitutes && parsedDrv->substitutesAllowed()) for (auto & [outputName, status] : initialOutputs) { if (!status.wanted) continue; if (!status.known) addWaitee( upcast_goal( worker.makeDrvOutputSubstitutionGoal( DrvOutput{status.outputHash, outputName}, buildMode == bmRepair ? Repair : NoRepair ) ) ); else { auto * cap = getDerivationCA(*drv); addWaitee(upcast_goal(worker.makePathSubstitutionGoal( status.known->path, buildMode == bmRepair ? Repair : NoRepair, cap ? std::optional { *cap } : std::nullopt))); } } if (waitees.empty()) /* to prevent hang (no wake-up event) */ outputsSubstitutionTried(); else state = &DerivationGoal::outputsSubstitutionTried; } void DerivationGoal::outputsSubstitutionTried() { trace("all outputs substituted (maybe)"); assert(drv->type().isPure()); if (nrFailed > 0 && nrFailed > nrNoSubstituters + nrIncompleteClosure && !settings.tryFallback) { done(BuildResult::TransientFailure, {}, Error("some substitutes for the outputs of derivation '%s' failed (usually happens due to networking issues); try '--fallback' to build derivation from source ", worker.store.printStorePath(drvPath))); return; } /* If the substitutes form an incomplete closure, then we should build the dependencies of this derivation, but after that, we can still use the substitutes for this derivation itself. If the nrIncompleteClosure != nrFailed, we have another issue as well. In particular, it may be the case that the hole in the closure is an output of the current derivation, which causes a loop if retried. */ { bool substitutionFailed = nrIncompleteClosure > 0 && nrIncompleteClosure == nrFailed; switch (retrySubstitution) { case RetrySubstitution::NoNeed: if (substitutionFailed) retrySubstitution = RetrySubstitution::YesNeed; break; case RetrySubstitution::YesNeed: // Should not be able to reach this state from here. assert(false); break; case RetrySubstitution::AlreadyRetried: debug("substitution failed again, but we already retried once. Not retrying again."); break; } } nrFailed = nrNoSubstituters = nrIncompleteClosure = 0; if (needRestart == NeedRestartForMoreOutputs::OutputsAddedDoNeed) { needRestart = NeedRestartForMoreOutputs::OutputsUnmodifedDontNeed; haveDerivation(); return; } auto [allValid, validOutputs] = checkPathValidity(); if (buildMode == bmNormal && allValid) { done(BuildResult::Substituted, std::move(validOutputs)); return; } if (buildMode == bmRepair && allValid) { repairClosure(); return; } if (buildMode == bmCheck && !allValid) throw Error("some outputs of '%s' are not valid, so checking is not possible", worker.store.printStorePath(drvPath)); /* Nothing to wait for; tail call */ gaveUpOnSubstitution(); } /* At least one of the output paths could not be produced using a substitute. So we have to build instead. */ void DerivationGoal::gaveUpOnSubstitution() { /* At this point we are building all outputs, so if more are wanted there is no need to restart. */ needRestart = NeedRestartForMoreOutputs::BuildInProgressWillNotNeed; /* The inputs must be built before we can build this goal. */ inputDrvOutputs.clear(); if (useDerivation) { std::function, const DerivedPathMap::ChildNode &)> addWaiteeDerivedPath; addWaiteeDerivedPath = [&](ref inputDrv, const DerivedPathMap::ChildNode & inputNode) { if (!inputNode.value.empty()) addWaitee(worker.makeGoal( DerivedPath::Built { .drvPath = inputDrv, .outputs = inputNode.value, }, buildMode == bmRepair ? bmRepair : bmNormal)); for (const auto & [outputName, childNode] : inputNode.childMap) addWaiteeDerivedPath( make_ref(SingleDerivedPath::Built { inputDrv, outputName }), childNode); }; for (const auto & [inputDrvPath, inputNode] : dynamic_cast(drv.get())->inputDrvs.map) { /* Ensure that pure, non-fixed-output derivations don't depend on impure derivations. */ if (experimentalFeatureSettings.isEnabled(Xp::ImpureDerivations) && drv->type().isPure() && !drv->type().isFixed()) { auto inputDrv = worker.evalStore.readDerivation(inputDrvPath); if (!inputDrv.type().isPure()) throw Error("pure derivation '%s' depends on impure derivation '%s'", worker.store.printStorePath(drvPath), worker.store.printStorePath(inputDrvPath)); } addWaiteeDerivedPath(makeConstantStorePathRef(inputDrvPath), inputNode); } } /* Copy the input sources from the eval store to the build store. Note that some inputs might not be in the eval store because they are (resolved) derivation outputs in a resolved derivation. */ if (&worker.evalStore != &worker.store) { RealisedPath::Set inputSrcs; for (auto & i : drv->inputSrcs) if (worker.evalStore.isValidPath(i)) inputSrcs.insert(i); copyClosure(worker.evalStore, worker.store, inputSrcs); } for (auto & i : drv->inputSrcs) { if (worker.store.isValidPath(i)) continue; if (!settings.useSubstitutes) throw Error("dependency '%s' of '%s' does not exist, and substitution is disabled", worker.store.printStorePath(i), worker.store.printStorePath(drvPath)); addWaitee(upcast_goal(worker.makePathSubstitutionGoal(i))); } if (waitees.empty()) /* to prevent hang (no wake-up event) */ inputsRealised(); else state = &DerivationGoal::inputsRealised; } void DerivationGoal::repairClosure() { assert(drv->type().isPure()); /* If we're repairing, we now know that our own outputs are valid. Now check whether the other paths in the outputs closure are good. If not, then start derivation goals for the derivations that produced those outputs. */ /* Get the output closure. */ auto outputs = queryDerivationOutputMap(); StorePathSet outputClosure; for (auto & i : outputs) { if (!wantedOutputs.contains(i.first)) continue; worker.store.computeFSClosure(i.second, outputClosure); } /* Filter out our own outputs (which we have already checked). */ for (auto & i : outputs) outputClosure.erase(i.second); /* Get all dependencies of this derivation so that we know which derivation is responsible for which path in the output closure. */ StorePathSet inputClosure; if (useDerivation) worker.store.computeFSClosure(drvPath, inputClosure); std::map outputsToDrv; for (auto & i : inputClosure) if (i.isDerivation()) { auto depOutputs = worker.store.queryPartialDerivationOutputMap(i, &worker.evalStore); for (auto & j : depOutputs) if (j.second) outputsToDrv.insert_or_assign(*j.second, i); } /* Check each path (slow!). */ for (auto & i : outputClosure) { if (worker.pathContentsGood(i)) continue; printError( "found corrupted or missing path '%s' in the output closure of '%s'", worker.store.printStorePath(i), worker.store.printStorePath(drvPath)); auto drvPath2 = outputsToDrv.find(i); if (drvPath2 == outputsToDrv.end()) addWaitee(upcast_goal(worker.makePathSubstitutionGoal(i, Repair))); else addWaitee(worker.makeGoal( DerivedPath::Built { .drvPath = makeConstantStorePathRef(drvPath2->second), .outputs = OutputsSpec::All { }, }, bmRepair)); } if (waitees.empty()) { done(BuildResult::AlreadyValid, assertPathValidity()); return; } state = &DerivationGoal::closureRepaired; } void DerivationGoal::closureRepaired() { trace("closure repaired"); if (nrFailed > 0) throw Error("some paths in the output closure of derivation '%s' could not be repaired", worker.store.printStorePath(drvPath)); done(BuildResult::AlreadyValid, assertPathValidity()); } void DerivationGoal::inputsRealised() { trace("all inputs realised"); if (nrFailed != 0) { if (!useDerivation) throw Error("some dependencies of '%s' are missing", worker.store.printStorePath(drvPath)); done(BuildResult::DependencyFailed, {}, Error( "%s dependencies of derivation '%s' failed to build", nrFailed, worker.store.printStorePath(drvPath))); return; } if (retrySubstitution == RetrySubstitution::YesNeed) { retrySubstitution = RetrySubstitution::AlreadyRetried; haveDerivation(); return; } /* Gather information necessary for computing the closure and/or running the build hook. */ /* Determine the full set of input paths. */ /* First, the input derivations. */ if (useDerivation) { auto & fullDrv = *dynamic_cast(drv.get()); auto drvType = fullDrv.type(); bool resolveDrv = std::visit(overloaded { [&](const DerivationType::InputAddressed & ia) { /* must resolve if deferred. */ return ia.deferred; }, [&](const DerivationType::ContentAddressed & ca) { return !fullDrv.inputDrvs.map.empty() && ( ca.fixed /* Can optionally resolve if fixed, which is good for avoiding unnecessary rebuilds. */ ? experimentalFeatureSettings.isEnabled(Xp::CaDerivations) /* Must resolve if floating and there are any inputs drvs. */ : true); }, [&](const DerivationType::Impure &) { return true; } }, drvType.raw); if (resolveDrv && !fullDrv.inputDrvs.map.empty()) { experimentalFeatureSettings.require(Xp::CaDerivations); /* We are be able to resolve this derivation based on the now-known results of dependencies. If so, we become a stub goal aliasing that resolved derivation goal. */ std::optional attempt = fullDrv.tryResolve(worker.store, inputDrvOutputs); if (!attempt) { /* TODO (impure derivations-induced tech debt) (see below): The above attempt should have found it, but because we manage inputDrvOutputs statefully, sometimes it gets out of sync with the real source of truth (store). So we query the store directly if there's a problem. */ attempt = fullDrv.tryResolve(worker.store, &worker.evalStore); } assert(attempt); Derivation drvResolved { std::move(*attempt) }; auto pathResolved = writeDerivation(worker.store, drvResolved); auto msg = fmt("resolved derivation: '%s' -> '%s'", worker.store.printStorePath(drvPath), worker.store.printStorePath(pathResolved)); act = std::make_unique(*logger, lvlInfo, actBuildWaiting, msg, Logger::Fields { worker.store.printStorePath(drvPath), worker.store.printStorePath(pathResolved), }); resolvedDrvGoal = worker.makeDerivationGoal( pathResolved, wantedOutputs, buildMode); addWaitee(resolvedDrvGoal); state = &DerivationGoal::resolvedFinished; return; } std::function::ChildNode &)> accumInputPaths; accumInputPaths = [&](const StorePath & depDrvPath, const DerivedPathMap::ChildNode & inputNode) { /* Add the relevant output closures of the input derivation `i' as input paths. Only add the closures of output paths that are specified as inputs. */ auto getOutput = [&](const std::string & outputName) { /* TODO (impure derivations-induced tech debt): Tracking input derivation outputs statefully through the goals is error prone and has led to bugs. For a robust nix, we need to move towards the `else` branch, which does not rely on goal state to match up with the reality of the store, which is our real source of truth. However, the impure derivations feature still relies on this fragile way of doing things, because its builds do not have a representation in the store, which is a usability problem in itself. When implementing this logic entirely with lookups make sure that they're cached. */ if (auto outPath = get(inputDrvOutputs, { depDrvPath, outputName })) { return *outPath; } else { auto outMap = [&]{ for (auto * drvStore : { &worker.evalStore, &worker.store }) if (drvStore->isValidPath(depDrvPath)) return worker.store.queryDerivationOutputMap(depDrvPath, drvStore); assert(false); }(); auto outMapPath = outMap.find(outputName); if (outMapPath == outMap.end()) { throw Error( "derivation '%s' requires non-existent output '%s' from input derivation '%s'", worker.store.printStorePath(drvPath), outputName, worker.store.printStorePath(depDrvPath)); } return outMapPath->second; } }; for (auto & outputName : inputNode.value) worker.store.computeFSClosure(getOutput(outputName), inputPaths); for (auto & [outputName, childNode] : inputNode.childMap) accumInputPaths(getOutput(outputName), childNode); }; for (auto & [depDrvPath, depNode] : fullDrv.inputDrvs.map) accumInputPaths(depDrvPath, depNode); } /* Second, the input sources. */ worker.store.computeFSClosure(drv->inputSrcs, inputPaths); debug("added input paths %s", worker.store.showPaths(inputPaths)); /* What type of derivation are we building? */ derivationType = drv->type(); /* Okay, try to build. Note that here we don't wait for a build slot to become available, since we don't need one if there is a build hook. */ state = &DerivationGoal::tryToBuild; worker.wakeUp(shared_from_this()); } void DerivationGoal::started() { auto msg = fmt( buildMode == bmRepair ? "repairing outputs of '%s'" : buildMode == bmCheck ? "checking outputs of '%s'" : "building '%s'", worker.store.printStorePath(drvPath)); fmt("building '%s'", worker.store.printStorePath(drvPath)); if (hook) msg += fmt(" on '%s'", machineName); act = std::make_unique(*logger, lvlInfo, actBuild, msg, Logger::Fields{worker.store.printStorePath(drvPath), hook ? machineName : "", 1, 1}); mcRunningBuilds = std::make_unique>(worker.runningBuilds); worker.updateProgress(); } void DerivationGoal::tryToBuild() { trace("trying to build"); /* Obtain locks on all output paths, if the paths are known a priori. The locks are automatically released when we exit this function or Nix crashes. If we can't acquire the lock, then continue; hopefully some other goal can start a build, and if not, the main loop will sleep a few seconds and then retry this goal. */ PathSet lockFiles; /* FIXME: Should lock something like the drv itself so we don't build same CA drv concurrently */ if (dynamic_cast(&worker.store)) { /* If we aren't a local store, we might need to use the local store as a build remote, but that would cause a deadlock. */ /* FIXME: Make it so we can use ourselves as a build remote even if we are the local store (separate locking for building vs scheduling? */ /* FIXME: find some way to lock for scheduling for the other stores so a forking daemon with --store still won't farm out redundant builds. */ for (auto & i : drv->outputsAndOptPaths(worker.store)) { if (i.second.second) lockFiles.insert(worker.store.Store::toRealPath(*i.second.second)); else lockFiles.insert( worker.store.Store::toRealPath(drvPath) + "." + i.first ); } } if (!outputLocks.lockPaths(lockFiles, "", false)) { if (!actLock) actLock = std::make_unique(*logger, lvlWarn, actBuildWaiting, fmt("waiting for lock on %s", Magenta(showPaths(lockFiles)))); worker.waitForAWhile(shared_from_this()); return; } actLock.reset(); /* Now check again whether the outputs are valid. This is because another process may have started building in parallel. After it has finished and released the locks, we can (and should) reuse its results. (Strictly speaking the first check can be omitted, but that would be less efficient.) Note that since we now hold the locks on the output paths, no other process can build this derivation, so no further checks are necessary. */ auto [allValid, validOutputs] = checkPathValidity(); if (buildMode != bmCheck && allValid) { debug("skipping build of derivation '%s', someone beat us to it", worker.store.printStorePath(drvPath)); outputLocks.setDeletion(true); done(BuildResult::AlreadyValid, std::move(validOutputs)); return; } /* If any of the outputs already exist but are not valid, delete them. */ for (auto & [_, status] : initialOutputs) { if (!status.known || status.known->isValid()) continue; auto storePath = status.known->path; debug("removing invalid path '%s'", worker.store.printStorePath(status.known->path)); deletePath(worker.store.Store::toRealPath(storePath)); } /* Don't do a remote build if the derivation has the attribute `preferLocalBuild' set. Also, check and repair modes are only supported for local builds. */ bool buildLocally = (buildMode != bmNormal || parsedDrv->willBuildLocally(worker.store)) && settings.maxBuildJobs.get() != 0; if (!buildLocally) { switch (tryBuildHook()) { case rpAccept: /* Yes, it has started doing so. Wait until we get EOF from the hook. */ actLock.reset(); buildResult.startTime = time(0); // inexact state = &DerivationGoal::buildDone; started(); return; case rpPostpone: /* Not now; wait until at least one child finishes or the wake-up timeout expires. */ if (!actLock) actLock = std::make_unique(*logger, lvlTalkative, actBuildWaiting, fmt("waiting for a machine to build '%s'", Magenta(worker.store.printStorePath(drvPath)))); worker.waitForAWhile(shared_from_this()); outputLocks.unlock(); return; case rpDecline: /* We should do it ourselves. */ break; } } actLock.reset(); state = &DerivationGoal::tryLocalBuild; worker.wakeUp(shared_from_this()); } void DerivationGoal::tryLocalBuild() { throw Error( "unable to build with a primary store that isn't a local store; " "either pass a different '--store' or enable remote builds." "\nhttps://nixos.org/manual/nix/stable/advanced-topics/distributed-builds.html"); } /* Move/rename path 'src' to 'dst'. Temporarily make 'src' writable if it's a directory and we're not root (to be able to update the directory's parent link ".."). */ static void movePath(const Path & src, const Path & dst) { auto st = lstat(src); bool changePerm = (geteuid() && S_ISDIR(st.st_mode) && !(st.st_mode & S_IWUSR)); if (changePerm) chmodPath(src, st.st_mode | S_IWUSR); renameFile(src, dst); if (changePerm) chmodPath(dst, st.st_mode); } void replaceValidPath(const Path & storePath, const Path & tmpPath) { /* We can't atomically replace storePath (the original) with tmpPath (the replacement), so we have to move it out of the way first. We'd better not be interrupted here, because if we're repairing (say) Glibc, we end up with a broken system. */ Path oldPath = fmt("%1%.old-%2%-%3%", storePath, getpid(), random()); if (pathExists(storePath)) movePath(storePath, oldPath); try { movePath(tmpPath, storePath); } catch (...) { try { // attempt to recover movePath(oldPath, storePath); } catch (...) { ignoreException(); } throw; } deletePath(oldPath); } int DerivationGoal::getChildStatus() { return hook->pid.kill(); } void DerivationGoal::closeReadPipes() { hook->builderOut.readSide.reset(); hook->fromHook.readSide.reset(); } void DerivationGoal::cleanupHookFinally() { } void DerivationGoal::cleanupPreChildKill() { } void DerivationGoal::cleanupPostChildKill() { } bool DerivationGoal::cleanupDecideWhetherDiskFull() { return false; } void DerivationGoal::cleanupPostOutputsRegisteredModeCheck() { } void DerivationGoal::cleanupPostOutputsRegisteredModeNonCheck() { } void runPostBuildHook( Store & store, Logger & logger, const StorePath & drvPath, const StorePathSet & outputPaths) { auto hook = settings.postBuildHook; if (hook == "") return; Activity act(logger, lvlTalkative, actPostBuildHook, fmt("running post-build-hook '%s'", settings.postBuildHook), Logger::Fields{store.printStorePath(drvPath)}); PushActivity pact(act.id); std::map hookEnvironment = getEnv(); hookEnvironment.emplace("DRV_PATH", store.printStorePath(drvPath)); hookEnvironment.emplace("OUT_PATHS", chomp(concatStringsSep(" ", store.printStorePathSet(outputPaths)))); hookEnvironment.emplace("NIX_CONFIG", globalConfig.toKeyValue()); struct LogSink : Sink { Activity & act; std::string currentLine; LogSink(Activity & act) : act(act) { } void operator() (std::string_view data) override { for (auto c : data) { if (c == '\n') { flushLine(); } else { currentLine += c; } } } void flushLine() { act.result(resPostBuildLogLine, currentLine); currentLine.clear(); } ~LogSink() { if (currentLine != "") { currentLine += '\n'; flushLine(); } } }; LogSink sink(act); auto proc = runProgram2({ .program = settings.postBuildHook, .environment = hookEnvironment, .captureStdout = true, .mergeStderrToStdout = true, }); Finally const _wait([&] { proc.wait(); }); // FIXME just process the data, without a wrapper sink class proc.stdout()->drainInto(sink); } void DerivationGoal::buildDone() { trace("build done"); Finally releaseBuildUser([&](){ this->cleanupHookFinally(); }); cleanupPreChildKill(); /* Since we got an EOF on the logger pipe, the builder is presumed to have terminated. In fact, the builder could also have simply have closed its end of the pipe, so just to be sure, kill it. */ int status = getChildStatus(); debug("builder process for '%s' finished", worker.store.printStorePath(drvPath)); buildResult.timesBuilt++; buildResult.stopTime = time(0); /* So the child is gone now. */ worker.childTerminated(this); /* Close the read side of the logger pipe. */ closeReadPipes(); /* Close the log file. */ closeLogFile(); cleanupPostChildKill(); if (buildResult.cpuUser && buildResult.cpuSystem) { debug("builder for '%s' terminated with status %d, user CPU %.3fs, system CPU %.3fs", worker.store.printStorePath(drvPath), status, ((double) buildResult.cpuUser->count()) / 1000000, ((double) buildResult.cpuSystem->count()) / 1000000); } bool diskFull = false; try { /* Check the exit status. */ if (!statusOk(status)) { diskFull |= cleanupDecideWhetherDiskFull(); auto msg = fmt("builder for '%s' %s", Magenta(worker.store.printStorePath(drvPath)), statusToString(status)); if (!logger->isVerbose() && !logTail.empty()) { msg += fmt(";\nlast %d log lines:\n", logTail.size()); for (auto & line : logTail) { msg += "> "; msg += line; msg += "\n"; } auto nixLogCommand = experimentalFeatureSettings.isEnabled(Xp::NixCommand) ? "nix log" : "nix-store -l"; msg += fmt("For full logs, run '" ANSI_BOLD "%s %s" ANSI_NORMAL "'.", nixLogCommand, worker.store.printStorePath(drvPath)); } if (diskFull) msg += "\nnote: build failure may have been caused by lack of free disk space"; throw BuildError("%s", msg); } /* Compute the FS closure of the outputs and register them as being valid. */ auto builtOutputs = registerOutputs(); StorePathSet outputPaths; for (auto & [_, output] : builtOutputs) outputPaths.insert(output.outPath); runPostBuildHook( worker.store, *logger, drvPath, outputPaths ); cleanupPostOutputsRegisteredModeNonCheck(); /* It is now safe to delete the lock files, since all future lockers will see that the output paths are valid; they will not create new lock files with the same names as the old (unlinked) lock files. */ outputLocks.setDeletion(true); outputLocks.unlock(); done(BuildResult::Built, std::move(builtOutputs)); } catch (BuildError & e) { outputLocks.unlock(); BuildResult::Status st = BuildResult::MiscFailure; if (hook && WIFEXITED(status) && WEXITSTATUS(status) == 101) st = BuildResult::TimedOut; else if (hook && (!WIFEXITED(status) || WEXITSTATUS(status) != 100)) { } else { assert(derivationType); st = dynamic_cast(&e) ? BuildResult::NotDeterministic : statusOk(status) ? BuildResult::OutputRejected : !derivationType->isSandboxed() || diskFull ? BuildResult::TransientFailure : BuildResult::PermanentFailure; } done(st, {}, std::move(e)); return; } } void DerivationGoal::resolvedFinished() { trace("resolved derivation finished"); assert(resolvedDrvGoal); auto resolvedDrv = *resolvedDrvGoal->drv; auto & resolvedResult = resolvedDrvGoal->buildResult; SingleDrvOutputs builtOutputs; if (resolvedResult.success()) { auto resolvedHashes = staticOutputHashes(worker.store, resolvedDrv); StorePathSet outputPaths; for (auto & outputName : resolvedDrv.outputNames()) { auto initialOutput = get(initialOutputs, outputName); auto resolvedHash = get(resolvedHashes, outputName); if ((!initialOutput) || (!resolvedHash)) throw Error( "derivation '%s' doesn't have expected output '%s' (derivation-goal.cc/resolvedFinished,resolve)", worker.store.printStorePath(drvPath), outputName); auto realisation = [&]{ auto take1 = get(resolvedResult.builtOutputs, outputName); if (take1) return *take1; /* The above `get` should work. But sateful tracking of outputs in resolvedResult, this can get out of sync with the store, which is our actual source of truth. For now we just check the store directly if it fails. */ auto take2 = worker.evalStore.queryRealisation(DrvOutput { *resolvedHash, outputName }); if (take2) return *take2; throw Error( "derivation '%s' doesn't have expected output '%s' (derivation-goal.cc/resolvedFinished,realisation)", worker.store.printStorePath(resolvedDrvGoal->drvPath), outputName); }(); if (drv->type().isPure()) { auto newRealisation = realisation; newRealisation.id = DrvOutput { initialOutput->outputHash, outputName }; newRealisation.signatures.clear(); if (!drv->type().isFixed()) { auto & drvStore = worker.evalStore.isValidPath(drvPath) ? worker.evalStore : worker.store; newRealisation.dependentRealisations = drvOutputReferences(worker.store, *drv, realisation.outPath, &drvStore); } signRealisation(newRealisation); worker.store.registerDrvOutput(newRealisation); } outputPaths.insert(realisation.outPath); builtOutputs.emplace(outputName, realisation); } runPostBuildHook( worker.store, *logger, drvPath, outputPaths ); } auto status = resolvedResult.status; if (status == BuildResult::AlreadyValid) status = BuildResult::ResolvesToAlreadyValid; done(status, std::move(builtOutputs)); } HookReply DerivationGoal::tryBuildHook() { if (!worker.tryBuildHook || !useDerivation) return rpDecline; if (!worker.hook) worker.hook = std::make_unique(); try { /* Send the request to the hook. */ worker.hook->sink << "try" << (worker.getNrLocalBuilds() < settings.maxBuildJobs ? 1 : 0) << drv->platform << worker.store.printStorePath(drvPath) << parsedDrv->getRequiredSystemFeatures(); worker.hook->sink.flush(); /* Read the first line of input, which should be a word indicating whether the hook wishes to perform the build. */ std::string reply; while (true) { auto s = [&]() { try { return readLine(worker.hook->fromHook.readSide.get()); } catch (Error & e) { e.addTrace({}, "while reading the response from the build hook"); throw; } }(); if (handleJSONLogMessage(s, worker.act, worker.hook->activities, true)) ; else if (s.substr(0, 2) == "# ") { reply = s.substr(2); break; } else { s += "\n"; writeToStderr(s); } } debug("hook reply is '%1%'", reply); if (reply == "decline") return rpDecline; else if (reply == "decline-permanently") { worker.tryBuildHook = false; worker.hook = 0; return rpDecline; } else if (reply == "postpone") return rpPostpone; else if (reply != "accept") throw Error("bad hook reply '%s'", reply); } catch (SysError & e) { if (e.errNo == EPIPE) { printError( "build hook died unexpectedly: %s", chomp(drainFD(worker.hook->fromHook.readSide.get()))); worker.hook = 0; return rpDecline; } else throw; } hook = std::move(worker.hook); try { machineName = readLine(hook->fromHook.readSide.get()); } catch (Error & e) { e.addTrace({}, "while reading the machine name from the build hook"); throw; } CommonProto::WriteConn conn { hook->sink }; /* Tell the hook all the inputs that have to be copied to the remote system. */ CommonProto::write(worker.store, conn, inputPaths); /* Tell the hooks the missing outputs that have to be copied back from the remote system. */ { StringSet missingOutputs; for (auto & [outputName, status] : initialOutputs) { // XXX: Does this include known CA outputs? if (buildMode != bmCheck && status.known && status.known->isValid()) continue; missingOutputs.insert(outputName); } CommonProto::write(worker.store, conn, missingOutputs); } hook->sink = FdSink(); hook->toHook.writeSide.reset(); /* Create the log file and pipe. */ Path logFile = openLogFile(); std::set fds; fds.insert(hook->fromHook.readSide.get()); fds.insert(hook->builderOut.readSide.get()); worker.childStarted(shared_from_this(), fds, false, false); return rpAccept; } SingleDrvOutputs DerivationGoal::registerOutputs() { /* When using a build hook, the build hook can register the output as valid (by doing `nix-store --import'). If so we don't have to do anything here. We can only early return when the outputs are known a priori. For floating content-addressed derivations this isn't the case. */ return assertPathValidity(); } Path DerivationGoal::openLogFile() { logSize = 0; if (!settings.keepLog) return ""; auto baseName = std::string(baseNameOf(worker.store.printStorePath(drvPath))); /* Create a log file. */ Path logDir; if (auto localStore = dynamic_cast(&worker.store)) logDir = localStore->logDir; else logDir = settings.nixLogDir; Path dir = fmt("%s/%s/%s/", logDir, LocalFSStore::drvsLogDir, baseName.substr(0, 2)); createDirs(dir); Path logFileName = fmt("%s/%s%s", dir, baseName.substr(2), settings.compressLog ? ".bz2" : ""); fdLogFile = AutoCloseFD{open(logFileName.c_str(), O_CREAT | O_WRONLY | O_TRUNC | O_CLOEXEC, 0666)}; if (!fdLogFile) throw SysError("creating log file '%1%'", logFileName); logFileSink = std::make_shared(fdLogFile.get()); if (settings.compressLog) logSink = std::shared_ptr(makeCompressionSink("bzip2", *logFileSink)); else logSink = logFileSink; return logFileName; } void DerivationGoal::closeLogFile() { auto logSink2 = std::dynamic_pointer_cast(logSink); if (logSink2) logSink2->finish(); if (logFileSink) logFileSink->flush(); logSink = logFileSink = 0; fdLogFile.reset(); } bool DerivationGoal::isReadDesc(int fd) { return fd == hook->builderOut.readSide.get(); } void DerivationGoal::handleChildOutput(int fd, std::string_view data) { // local & `ssh://`-builds are dealt with here. auto isWrittenToLog = isReadDesc(fd); if (isWrittenToLog) { logSize += data.size(); if (settings.maxLogSize && logSize > settings.maxLogSize) { killChild(); done( BuildResult::LogLimitExceeded, {}, Error("%s killed after writing more than %d bytes of log output", getName(), settings.maxLogSize)); return; } for (auto c : data) if (c == '\r') currentLogLinePos = 0; else if (c == '\n') flushLine(); else { if (currentLogLinePos >= currentLogLine.size()) currentLogLine.resize(currentLogLinePos + 1); currentLogLine[currentLogLinePos++] = c; } if (logSink) (*logSink)(data); } if (hook && fd == hook->fromHook.readSide.get()) { for (auto c : data) if (c == '\n') { auto json = parseJSONMessage(currentHookLine); if (json) { auto s = handleJSONLogMessage(*json, worker.act, hook->activities, true); // ensure that logs from a builder using `ssh-ng://` as protocol // are also available to `nix log`. if (s && !isWrittenToLog && logSink) { const auto type = (*json)["type"]; const auto fields = (*json)["fields"]; if (type == resBuildLogLine) { (*logSink)((fields.size() > 0 ? fields[0].get() : "") + "\n"); } else if (type == resSetPhase && ! fields.is_null()) { const auto phase = fields[0]; if (! phase.is_null()) { // nixpkgs' stdenv produces lines in the log to signal // phase changes. // We want to get the same lines in case of remote builds. // The format is: // @nix { "action": "setPhase", "phase": "$curPhase" } const auto logLine = nlohmann::json::object({ {"action", "setPhase"}, {"phase", phase} }); (*logSink)("@nix " + logLine.dump(-1, ' ', false, nlohmann::json::error_handler_t::replace) + "\n"); } } } } currentHookLine.clear(); } else currentHookLine += c; } } void DerivationGoal::handleEOF(int fd) { if (!currentLogLine.empty()) flushLine(); worker.wakeUp(shared_from_this()); } void DerivationGoal::flushLine() { if (handleJSONLogMessage(currentLogLine, *act, builderActivities, false)) ; else { logTail.push_back(currentLogLine); if (logTail.size() > settings.logLines) logTail.pop_front(); act->result(resBuildLogLine, currentLogLine); } currentLogLine = ""; currentLogLinePos = 0; } std::map> DerivationGoal::queryPartialDerivationOutputMap() { assert(drv->type().isPure()); if (!useDerivation || drv->type().hasKnownOutputPaths()) { std::map> res; for (auto & [name, output] : drv->outputs) res.insert_or_assign(name, output.path(worker.store, drv->name, name)); return res; } else { for (auto * drvStore : { &worker.evalStore, &worker.store }) if (drvStore->isValidPath(drvPath)) return worker.store.queryPartialDerivationOutputMap(drvPath, drvStore); assert(false); } } OutputPathMap DerivationGoal::queryDerivationOutputMap() { assert(drv->type().isPure()); if (!useDerivation || drv->type().hasKnownOutputPaths()) { OutputPathMap res; for (auto & [name, output] : drv->outputsAndOptPaths(worker.store)) res.insert_or_assign(name, *output.second); return res; } else { for (auto * drvStore : { &worker.evalStore, &worker.store }) if (drvStore->isValidPath(drvPath)) return worker.store.queryDerivationOutputMap(drvPath, drvStore); assert(false); } } std::pair DerivationGoal::checkPathValidity() { if (!drv->type().isPure()) return { false, {} }; bool checkHash = buildMode == bmRepair; auto wantedOutputsLeft = std::visit(overloaded { [&](const OutputsSpec::All &) { return StringSet {}; }, [&](const OutputsSpec::Names & names) { return static_cast(names); }, }, wantedOutputs.raw); SingleDrvOutputs validOutputs; for (auto & i : queryPartialDerivationOutputMap()) { auto initialOutput = get(initialOutputs, i.first); if (!initialOutput) // this is an invalid output, gets catched with (!wantedOutputsLeft.empty()) continue; auto & info = *initialOutput; info.wanted = wantedOutputs.contains(i.first); if (info.wanted) wantedOutputsLeft.erase(i.first); if (i.second) { auto outputPath = *i.second; info.known = { .path = outputPath, .status = !worker.store.isValidPath(outputPath) ? PathStatus::Absent : !checkHash || worker.pathContentsGood(outputPath) ? PathStatus::Valid : PathStatus::Corrupt, }; } auto drvOutput = DrvOutput{info.outputHash, i.first}; if (experimentalFeatureSettings.isEnabled(Xp::CaDerivations)) { if (auto real = worker.store.queryRealisation(drvOutput)) { info.known = { .path = real->outPath, .status = PathStatus::Valid, }; } else if (info.known && info.known->isValid()) { // We know the output because it's a static output of the // derivation, and the output path is valid, but we don't have // its realisation stored (probably because it has been built // without the `ca-derivations` experimental flag). worker.store.registerDrvOutput( Realisation { drvOutput, info.known->path, } ); } } if (info.known && info.known->isValid()) validOutputs.emplace(i.first, Realisation { drvOutput, info.known->path }); } // If we requested all the outputs, we are always fine. // If we requested specific elements, the loop above removes all the valid // ones, so any that are left must be invalid. if (!wantedOutputsLeft.empty()) throw Error("derivation '%s' does not have wanted outputs %s", worker.store.printStorePath(drvPath), concatStringsSep(", ", quoteStrings(wantedOutputsLeft))); bool allValid = true; for (auto & [_, status] : initialOutputs) { if (!status.wanted) continue; if (!status.known || !status.known->isValid()) { allValid = false; break; } } return { allValid, validOutputs }; } SingleDrvOutputs DerivationGoal::assertPathValidity() { auto [allValid, validOutputs] = checkPathValidity(); if (!allValid) throw Error("some outputs are unexpectedly invalid"); return validOutputs; } void DerivationGoal::done( BuildResult::Status status, SingleDrvOutputs builtOutputs, std::optional ex) { outputLocks.unlock(); buildResult.status = status; if (ex) buildResult.errorMsg = fmt("%s", Uncolored(ex->info().msg)); if (buildResult.status == BuildResult::TimedOut) worker.timedOut = true; if (buildResult.status == BuildResult::PermanentFailure) worker.permanentFailure = true; mcExpectedBuilds.reset(); mcRunningBuilds.reset(); if (buildResult.success()) { auto wantedBuiltOutputs = filterDrvOutputs(wantedOutputs, std::move(builtOutputs)); assert(!wantedBuiltOutputs.empty()); buildResult.builtOutputs = std::move(wantedBuiltOutputs); if (status == BuildResult::Built) worker.doneBuilds++; } else { if (status != BuildResult::DependencyFailed) worker.failedBuilds++; } worker.updateProgress(); auto traceBuiltOutputsFile = getEnv("_NIX_TRACE_BUILT_OUTPUTS").value_or(""); if (traceBuiltOutputsFile != "") { std::fstream fs; fs.open(traceBuiltOutputsFile, std::fstream::out); fs << worker.store.printStorePath(drvPath) << "\t" << buildResult.toString() << std::endl; } amDone(buildResult.success() ? ecSuccess : ecFailed, std::move(ex)); } void DerivationGoal::waiteeDone(GoalPtr waitee, ExitCode result) { Goal::waiteeDone(waitee, result); if (!useDerivation) return; auto * dg = dynamic_cast(&*waitee); if (!dg) return; auto & fullDrv = *dynamic_cast(drv.get()); auto * nodeP = fullDrv.inputDrvs.findSlot(DerivedPath::Opaque { .path = dg->drvPath }); if (!nodeP) return; auto & outputs = nodeP->value; for (auto & outputName : outputs) { auto buildResult = dg->getBuildResult(DerivedPath::Built { .drvPath = makeConstantStorePathRef(dg->drvPath), .outputs = OutputsSpec::Names { outputName }, }); if (buildResult.success()) { auto i = buildResult.builtOutputs.find(outputName); if (i != buildResult.builtOutputs.end()) inputDrvOutputs.insert_or_assign( { dg->drvPath, outputName }, i->second.outPath); } } } }