#include "worker.hh" #include "substitution-goal.hh" #include "nar-info.hh" #include "finally.hh" namespace nix { PathSubstitutionGoal::PathSubstitutionGoal(const StorePath & storePath, Worker & worker, RepairFlag repair, std::optional ca) : Goal(worker, DerivedPath::Opaque { storePath }) , storePath(storePath) , repair(repair) , ca(ca) { state = &PathSubstitutionGoal::init; name = fmt("substitution of '%s'", worker.store.printStorePath(this->storePath)); trace("created"); maintainExpectedSubstitutions = std::make_unique>(worker.expectedSubstitutions); } PathSubstitutionGoal::~PathSubstitutionGoal() { cleanup(); } void PathSubstitutionGoal::done( ExitCode result, BuildResult::Status status, std::optional errorMsg) { buildResult.status = status; if (errorMsg) { debug(*errorMsg); buildResult.errorMsg = *errorMsg; } amDone(result); } void PathSubstitutionGoal::work() { (this->*state)(); } void PathSubstitutionGoal::init() { trace("init"); worker.store.addTempRoot(storePath); /* If the path already exists we're done. */ if (!repair && worker.store.isValidPath(storePath)) { done(ecSuccess, BuildResult::AlreadyValid); return; } if (settings.readOnlyMode) throw Error("cannot substitute path '%s' - no write access to the Nix store", worker.store.printStorePath(storePath)); subs = settings.useSubstitutes ? getDefaultSubstituters() : std::list>(); tryNext(); } void PathSubstitutionGoal::tryNext() { trace("trying next substituter"); cleanup(); if (subs.size() == 0) { /* None left. Terminate this goal and let someone else deal with it. */ /* Hack: don't indicate failure if there were no substituters. In that case the calling derivation should just do a build. */ done( substituterFailed ? ecFailed : ecNoSubstituters, BuildResult::NoSubstituters, fmt("path '%s' is required, but there is no substituter that can build it", worker.store.printStorePath(storePath))); if (substituterFailed) { worker.failedSubstitutions++; worker.updateProgress(); } return; } sub = subs.front(); subs.pop_front(); if (ca) { subPath = sub->makeFixedOutputPathFromCA({ .name = std::string { storePath.name() }, .info = caWithoutRefs(*ca), }); if (sub->storeDir == worker.store.storeDir) assert(subPath == storePath); } else if (sub->storeDir != worker.store.storeDir) { tryNext(); return; } try { // FIXME: make async info = sub->queryPathInfo(subPath ? *subPath : storePath); } catch (InvalidPath &) { tryNext(); return; } catch (SubstituterDisabled &) { if (settings.tryFallback) { tryNext(); return; } throw; } catch (Error & e) { if (settings.tryFallback) { logError(e.info()); tryNext(); return; } throw; } if (info->path != storePath) { if (info->isContentAddressed(*sub) && info->references.empty() && !info->hasSelfReference) { auto info2 = std::make_shared(*info); info2->path = storePath; info = info2; } else { printError("asked '%s' for '%s' but got '%s'", sub->getUri(), worker.store.printStorePath(storePath), sub->printStorePath(info->path)); tryNext(); return; } } /* Update the total expected download size. */ auto narInfo = std::dynamic_pointer_cast(info); maintainExpectedNar = std::make_unique>(worker.expectedNarSize, info->narSize); maintainExpectedDownload = narInfo && narInfo->fileSize ? std::make_unique>(worker.expectedDownloadSize, narInfo->fileSize) : nullptr; worker.updateProgress(); /* Bail out early if this substituter lacks a valid signature. LocalStore::addToStore() also checks for this, but only after we've downloaded the path. */ if (!sub->isTrusted && worker.store.pathInfoIsUntrusted(*info)) { warn("ignoring substitute for '%s' from '%s', as it's not signed by any of the keys in 'trusted-public-keys'", worker.store.printStorePath(storePath), sub->getUri()); tryNext(); return; } /* To maintain the closure invariant, we first have to realise the paths referenced by this one. */ for (auto & i : info->references) addWaitee(worker.makePathSubstitutionGoal(i)); if (waitees.empty()) /* to prevent hang (no wake-up event) */ referencesValid(); else state = &PathSubstitutionGoal::referencesValid; } void PathSubstitutionGoal::referencesValid() { trace("all references realised"); if (nrFailed > 0) { done( nrNoSubstituters > 0 || nrIncompleteClosure > 0 ? ecIncompleteClosure : ecFailed, BuildResult::DependencyFailed, fmt("some references of path '%s' could not be realised", worker.store.printStorePath(storePath))); return; } for (auto & i : info->references) assert(worker.store.isValidPath(i)); state = &PathSubstitutionGoal::tryToRun; worker.wakeUp(shared_from_this()); } void PathSubstitutionGoal::tryToRun() { trace("trying to run"); /* Make sure that we are allowed to start a build. Note that even if maxBuildJobs == 0 (no local builds allowed), we still allow a substituter to run. This is because substitutions cannot be distributed to another machine via the build hook. */ if (worker.getNrLocalBuilds() >= std::max(1U, (unsigned int) settings.maxBuildJobs)) { worker.waitForBuildSlot(shared_from_this()); return; } maintainRunningSubstitutions = std::make_unique>(worker.runningSubstitutions); worker.updateProgress(); outPipe.create(); promise = std::promise(); thr = std::thread([this]() { try { /* Wake up the worker loop when we're done. */ Finally updateStats([this]() { outPipe.writeSide.close(); }); Activity act(*logger, actSubstitute, Logger::Fields{worker.store.printStorePath(storePath), sub->getUri()}); PushActivity pact(act.id); copyStorePath(*sub, worker.store, subPath ? *subPath : storePath, repair, sub->isTrusted ? NoCheckSigs : CheckSigs); promise.set_value(); } catch (...) { promise.set_exception(std::current_exception()); } }); worker.childStarted(shared_from_this(), {outPipe.readSide.get()}, true, false); state = &PathSubstitutionGoal::finished; } void PathSubstitutionGoal::finished() { trace("substitute finished"); thr.join(); worker.childTerminated(this); try { promise.get_future().get(); } catch (std::exception & e) { printError(e.what()); /* Cause the parent build to fail unless --fallback is given, or the substitute has disappeared. The latter case behaves the same as the substitute never having existed in the first place. */ try { throw; } catch (SubstituteGone &) { } catch (...) { substituterFailed = true; } /* Try the next substitute. */ state = &PathSubstitutionGoal::tryNext; worker.wakeUp(shared_from_this()); return; } worker.markContentsGood(storePath); printMsg(lvlChatty, "substitution of path '%s' succeeded", worker.store.printStorePath(storePath)); maintainRunningSubstitutions.reset(); maintainExpectedSubstitutions.reset(); worker.doneSubstitutions++; if (maintainExpectedDownload) { auto fileSize = maintainExpectedDownload->delta; maintainExpectedDownload.reset(); worker.doneDownloadSize += fileSize; } worker.doneNarSize += maintainExpectedNar->delta; maintainExpectedNar.reset(); worker.updateProgress(); done(ecSuccess, BuildResult::Substituted); } void PathSubstitutionGoal::handleChildOutput(int fd, std::string_view data) { } void PathSubstitutionGoal::handleEOF(int fd) { if (fd == outPipe.readSide.get()) worker.wakeUp(shared_from_this()); } void PathSubstitutionGoal::cleanup() { try { if (thr.joinable()) { // FIXME: signal worker thread to quit. thr.join(); worker.childTerminated(this); } outPipe.close(); } catch (...) { ignoreException(); } } }