#include "installables.hh" #include "command.hh" #include "attr-path.hh" #include "common-eval-args.hh" #include "derivations.hh" #include "eval-inline.hh" #include "eval.hh" #include "get-drvs.hh" #include "store-api.hh" #include "shared.hh" #include "flake/flake.hh" #include "eval-cache.hh" #include "url.hh" #include "registry.hh" #include #include #include namespace nix { void completeFlakeInputPath( ref evalState, const FlakeRef & flakeRef, std::string_view prefix) { auto flake = flake::getFlake(*evalState, flakeRef, true); for (auto & input : flake.inputs) if (hasPrefix(input.first, prefix)) completions->add(input.first); } MixFlakeOptions::MixFlakeOptions() { auto category = "Common flake-related options"; addFlag({ .longName = "recreate-lock-file", .description = "Recreate the flake's lock file from scratch.", .category = category, .handler = {&lockFlags.recreateLockFile, true} }); addFlag({ .longName = "no-update-lock-file", .description = "Do not allow any updates to the flake's lock file.", .category = category, .handler = {&lockFlags.updateLockFile, false} }); addFlag({ .longName = "no-write-lock-file", .description = "Do not write the flake's newly generated lock file.", .category = category, .handler = {&lockFlags.writeLockFile, false} }); addFlag({ .longName = "no-registries", .description = "Don't allow lookups in the flake registries. This option is deprecated; use `--no-use-registries`.", .category = category, .handler = {[&]() { lockFlags.useRegistries = false; warn("'--no-registries' is deprecated; use '--no-use-registries'"); }} }); addFlag({ .longName = "commit-lock-file", .description = "Commit changes to the flake's lock file.", .category = category, .handler = {&lockFlags.commitLockFile, true} }); addFlag({ .longName = "update-input", .description = "Update a specific flake input (ignoring its previous entry in the lock file).", .category = category, .labels = {"input-path"}, .handler = {[&](std::string s) { lockFlags.inputUpdates.insert(flake::parseInputPath(s)); }}, .completer = {[&](size_t, std::string_view prefix) { if (auto flakeRef = getFlakeRefForCompletion()) completeFlakeInputPath(getEvalState(), *flakeRef, prefix); }} }); addFlag({ .longName = "override-input", .description = "Override a specific flake input (e.g. `dwarffs/nixpkgs`). This implies `--no-write-lock-file`.", .category = category, .labels = {"input-path", "flake-url"}, .handler = {[&](std::string inputPath, std::string flakeRef) { lockFlags.writeLockFile = false; lockFlags.inputOverrides.insert_or_assign( flake::parseInputPath(inputPath), parseFlakeRef(flakeRef, absPath("."), true)); }} }); addFlag({ .longName = "inputs-from", .description = "Use the inputs of the specified flake as registry entries.", .category = category, .labels = {"flake-url"}, .handler = {[&](std::string flakeRef) { auto evalState = getEvalState(); auto flake = flake::lockFlake( *evalState, parseFlakeRef(flakeRef, absPath(".")), { .writeLockFile = false }); for (auto & [inputName, input] : flake.lockFile.root->inputs) { auto input2 = flake.lockFile.findInput({inputName}); // resolve 'follows' nodes if (auto input3 = std::dynamic_pointer_cast(input2)) { overrideRegistry( fetchers::Input::fromAttrs({{"type","indirect"}, {"id", inputName}}), input3->lockedRef.input, {}); } } }}, .completer = {[&](size_t, std::string_view prefix) { completeFlakeRef(getEvalState()->store, prefix); }} }); } SourceExprCommand::SourceExprCommand() { addFlag({ .longName = "file", .shortName = 'f', .description = "Interpret installables as attribute paths relative to the Nix expression stored in *file*.", .category = installablesCategory, .labels = {"file"}, .handler = {&file}, .completer = completePath }); addFlag({ .longName = "expr", .description = "Interpret installables as attribute paths relative to the Nix expression *expr*.", .category = installablesCategory, .labels = {"expr"}, .handler = {&expr} }); addFlag({ .longName = "derivation", .description = "Operate on the store derivation rather than its outputs.", .category = installablesCategory, .handler = {&operateOn, OperateOn::Derivation}, }); } Strings SourceExprCommand::getDefaultFlakeAttrPaths() { return { "packages." + settings.thisSystem.get() + ".default", "defaultPackage." + settings.thisSystem.get() }; } Strings SourceExprCommand::getDefaultFlakeAttrPathPrefixes() { return { // As a convenience, look for the attribute in // 'outputs.packages'. "packages." + settings.thisSystem.get() + ".", // As a temporary hack until Nixpkgs is properly converted // to provide a clean 'packages' set, look in 'legacyPackages'. "legacyPackages." + settings.thisSystem.get() + "." }; } void SourceExprCommand::completeInstallable(std::string_view prefix) { if (file) { evalSettings.pureEval = false; auto state = getEvalState(); Expr *e = state->parseExprFromFile( resolveExprPath(state->checkSourcePath(lookupFileArg(*state, *file))) ); Value root; state->eval(e, root); auto autoArgs = getAutoArgs(*state); std::string prefix_ = std::string(prefix); auto sep = prefix_.rfind('.'); std::string searchWord; if (sep != std::string::npos) { searchWord = prefix_.substr(sep + 1, std::string::npos); prefix_ = prefix_.substr(0, sep); } else { searchWord = prefix_; prefix_ = ""; } auto [v, pos] = findAlongAttrPath(*state, prefix_, *autoArgs, root); Value &v1(*v); state->forceValue(v1, pos); Value v2; state->autoCallFunction(*autoArgs, v1, v2); completionType = ctAttrs; if (v2.type() == nAttrs) { for (auto & i : *v2.attrs) { std::string name = i.name; if (name.find(searchWord) == 0) { completions->add(i.name); } } } } else { completeFlakeRefWithFragment( getEvalState(), lockFlags, getDefaultFlakeAttrPathPrefixes(), getDefaultFlakeAttrPaths(), prefix); } } void completeFlakeRefWithFragment( ref evalState, flake::LockFlags lockFlags, Strings attrPathPrefixes, const Strings & defaultFlakeAttrPaths, std::string_view prefix) { /* Look for flake output attributes that match the prefix. */ try { auto hash = prefix.find('#'); if (hash == std::string::npos) { completeFlakeRef(evalState->store, prefix); } else { auto fragment = prefix.substr(hash + 1); auto flakeRefS = std::string(prefix.substr(0, hash)); // FIXME: do tilde expansion. auto flakeRef = parseFlakeRef(flakeRefS, absPath(".")); auto evalCache = openEvalCache(*evalState, std::make_shared(lockFlake(*evalState, flakeRef, lockFlags))); auto root = evalCache->getRoot(); /* Complete 'fragment' relative to all the attrpath prefixes as well as the root of the flake. */ attrPathPrefixes.push_back(""); completionType = ctAttrs; for (auto & attrPathPrefixS : attrPathPrefixes) { auto attrPathPrefix = parseAttrPath(*evalState, attrPathPrefixS); auto attrPathS = attrPathPrefixS + std::string(fragment); auto attrPath = parseAttrPath(*evalState, attrPathS); std::string lastAttr; if (!attrPath.empty() && !hasSuffix(attrPathS, ".")) { lastAttr = attrPath.back(); attrPath.pop_back(); } auto attr = root->findAlongAttrPath(attrPath); if (!attr) continue; for (auto & attr2 : (*attr)->getAttrs()) { if (hasPrefix(attr2, lastAttr)) { auto attrPath2 = (*attr)->getAttrPath(attr2); /* Strip the attrpath prefix. */ attrPath2.erase(attrPath2.begin(), attrPath2.begin() + attrPathPrefix.size()); completions->add(flakeRefS + "#" + concatStringsSep(".", attrPath2)); } } } /* And add an empty completion for the default attrpaths. */ if (fragment.empty()) { for (auto & attrPath : defaultFlakeAttrPaths) { auto attr = root->findAlongAttrPath(parseAttrPath(*evalState, attrPath)); if (!attr) continue; completions->add(flakeRefS + "#"); } } } } catch (Error & e) { warn(e.msg()); } } void completeFlakeRef(ref store, std::string_view prefix) { if (!settings.isExperimentalFeatureEnabled(Xp::Flakes)) return; if (prefix == "") completions->add("."); completeDir(0, prefix); /* Look for registry entries that match the prefix. */ for (auto & registry : fetchers::getRegistries(store)) { for (auto & entry : registry->entries) { auto from = entry.from.to_string(); if (!hasPrefix(prefix, "flake:") && hasPrefix(from, "flake:")) { std::string from2(from, 6); if (hasPrefix(from2, prefix)) completions->add(from2); } else { if (hasPrefix(from, prefix)) completions->add(from); } } } } DerivedPath Installable::toDerivedPath() { auto buildables = toDerivedPaths(); if (buildables.size() != 1) throw Error("installable '%s' evaluates to %d derivations, where only one is expected", what(), buildables.size()); return std::move(buildables[0]); } std::vector, std::string>> Installable::getCursors(EvalState & state) { auto evalCache = std::make_shared(std::nullopt, state, [&]() { return toValue(state).first; }); return {{evalCache->getRoot(), ""}}; } std::pair, std::string> Installable::getCursor(EvalState & state) { auto cursors = getCursors(state); if (cursors.empty()) throw Error("cannot find flake attribute '%s'", what()); return cursors[0]; } static StorePath getDeriver( ref store, const Installable & i, const StorePath & drvPath) { auto derivers = store->queryValidDerivers(drvPath); if (derivers.empty()) throw Error("'%s' does not have a known deriver", i.what()); // FIXME: use all derivers? return *derivers.begin(); } struct InstallableStorePath : Installable { ref store; StorePath storePath; InstallableStorePath(ref store, StorePath && storePath) : store(store), storePath(std::move(storePath)) { } std::string what() const override { return store->printStorePath(storePath); } DerivedPaths toDerivedPaths() override { if (storePath.isDerivation()) { auto drv = store->readDerivation(storePath); return { DerivedPath::Built { .drvPath = storePath, .outputs = drv.outputNames(), } }; } else { return { DerivedPath::Opaque { .path = storePath, } }; } } StorePathSet toDrvPaths(ref store) override { if (storePath.isDerivation()) { return {storePath}; } else { return {getDeriver(store, *this, storePath)}; } } std::optional getStorePath() override { return storePath; } }; DerivedPaths InstallableValue::toDerivedPaths() { DerivedPaths res; std::map> drvsToOutputs; RealisedPath::Set drvsToCopy; // Group by derivation, helps with .all in particular for (auto & drv : toDerivations()) { auto outputName = drv.outputName; if (outputName == "") throw Error("derivation '%s' lacks an 'outputName' attribute", state->store->printStorePath(drv.drvPath)); drvsToOutputs[drv.drvPath].insert(outputName); drvsToCopy.insert(drv.drvPath); } for (auto & i : drvsToOutputs) res.push_back(DerivedPath::Built { i.first, i.second }); return res; } StorePathSet InstallableValue::toDrvPaths(ref store) { StorePathSet res; for (auto & drv : toDerivations()) res.insert(drv.drvPath); return res; } struct InstallableAttrPath : InstallableValue { SourceExprCommand & cmd; RootValue v; std::string attrPath; InstallableAttrPath(ref state, SourceExprCommand & cmd, Value * v, const std::string & attrPath) : InstallableValue(state), cmd(cmd), v(allocRootValue(v)), attrPath(attrPath) { } std::string what() const override { return attrPath; } std::pair toValue(EvalState & state) override { auto [vRes, pos] = findAlongAttrPath(state, attrPath, *cmd.getAutoArgs(state), **v); state.forceValue(*vRes, pos); return {vRes, pos}; } virtual std::vector toDerivations() override; }; std::vector InstallableAttrPath::toDerivations() { auto v = toValue(*state).first; Bindings & autoArgs = *cmd.getAutoArgs(*state); DrvInfos drvInfos; getDerivations(*state, *v, "", autoArgs, drvInfos, false); std::vector res; for (auto & drvInfo : drvInfos) { auto drvPath = drvInfo.queryDrvPath(); if (!drvPath) throw Error("'%s' is not a derivation", what()); res.push_back({ *drvPath, drvInfo.queryOutputName() }); } return res; } std::vector InstallableFlake::getActualAttrPaths() { std::vector res; for (auto & prefix : prefixes) res.push_back(prefix + *attrPaths.begin()); for (auto & s : attrPaths) res.push_back(s); return res; } Value * InstallableFlake::getFlakeOutputs(EvalState & state, const flake::LockedFlake & lockedFlake) { auto vFlake = state.allocValue(); callFlake(state, lockedFlake, *vFlake); auto aOutputs = vFlake->attrs->get(state.symbols.create("outputs")); assert(aOutputs); state.forceValue(*aOutputs->value, [&]() { return aOutputs->value->determinePos(noPos); }); return aOutputs->value; } ref openEvalCache( EvalState & state, std::shared_ptr lockedFlake) { auto fingerprint = lockedFlake->getFingerprint(); return make_ref( evalSettings.useEvalCache && evalSettings.pureEval ? std::optional { std::cref(fingerprint) } : std::nullopt, state, [&state, lockedFlake]() { /* For testing whether the evaluation cache is complete. */ if (getEnv("NIX_ALLOW_EVAL").value_or("1") == "0") throw Error("not everything is cached, but evaluation is not allowed"); auto vFlake = state.allocValue(); flake::callFlake(state, *lockedFlake, *vFlake); state.forceAttrs(*vFlake, noPos); auto aOutputs = vFlake->attrs->get(state.symbols.create("outputs")); assert(aOutputs); return aOutputs->value; }); } static std::string showAttrPaths(const std::vector & paths) { std::string s; for (const auto & [n, i] : enumerate(paths)) { if (n > 0) s += n + 1 == paths.size() ? " or " : ", "; s += '\''; s += i; s += '\''; } return s; } InstallableFlake::InstallableFlake( SourceExprCommand * cmd, ref state, FlakeRef && flakeRef, std::string_view fragment, Strings attrPaths, Strings prefixes, const flake::LockFlags & lockFlags) : InstallableValue(state), flakeRef(flakeRef), attrPaths(fragment == "" ? attrPaths : Strings{(std::string) fragment}), prefixes(fragment == "" ? Strings{} : prefixes), lockFlags(lockFlags) { if (cmd && cmd->getAutoArgs(*state)->size()) throw UsageError("'--arg' and '--argstr' are incompatible with flakes"); } std::tuple InstallableFlake::toDerivation() { auto lockedFlake = getLockedFlake(); auto cache = openEvalCache(*state, lockedFlake); auto root = cache->getRoot(); Suggestions suggestions; for (auto & attrPath : getActualAttrPaths()) { debug("trying flake output attribute '%s'", attrPath); auto attrOrSuggestions = root->findAlongAttrPath( parseAttrPath(*state, attrPath), true ); if (!attrOrSuggestions) { suggestions += attrOrSuggestions.getSuggestions(); continue; } auto attr = *attrOrSuggestions; if (!attr->isDerivation()) throw Error("flake output attribute '%s' is not a derivation", attrPath); auto drvPath = attr->forceDerivation(); auto drvInfo = DerivationInfo { std::move(drvPath), attr->getAttr(state->sOutputName)->getString() }; return {attrPath, lockedFlake->flake.lockedRef, std::move(drvInfo)}; } throw Error(suggestions, "flake '%s' does not provide attribute %s", flakeRef, showAttrPaths(getActualAttrPaths())); } std::vector InstallableFlake::toDerivations() { std::vector res; res.push_back(std::get<2>(toDerivation())); return res; } std::pair InstallableFlake::toValue(EvalState & state) { auto lockedFlake = getLockedFlake(); auto vOutputs = getFlakeOutputs(state, *lockedFlake); auto emptyArgs = state.allocBindings(0); Suggestions suggestions; for (auto & attrPath : getActualAttrPaths()) { try { auto [v, pos] = findAlongAttrPath(state, attrPath, *emptyArgs, *vOutputs); state.forceValue(*v, pos); return {v, pos}; } catch (AttrPathNotFound & e) { suggestions += e.info().suggestions; } } throw Error( suggestions, "flake '%s' does not provide attribute %s", flakeRef, showAttrPaths(getActualAttrPaths()) ); } std::vector, std::string>> InstallableFlake::getCursors(EvalState & state) { auto evalCache = openEvalCache(state, std::make_shared(lockFlake(state, flakeRef, lockFlags))); auto root = evalCache->getRoot(); std::vector, std::string>> res; for (auto & attrPath : getActualAttrPaths()) { auto attr = root->findAlongAttrPath(parseAttrPath(state, attrPath)); if (attr) res.push_back({*attr, attrPath}); } return res; } std::shared_ptr InstallableFlake::getLockedFlake() const { flake::LockFlags lockFlagsApplyConfig = lockFlags; lockFlagsApplyConfig.applyNixConfig = true; if (!_lockedFlake) { _lockedFlake = std::make_shared(lockFlake(*state, flakeRef, lockFlagsApplyConfig)); } return _lockedFlake; } FlakeRef InstallableFlake::nixpkgsFlakeRef() const { auto lockedFlake = getLockedFlake(); if (auto nixpkgsInput = lockedFlake->lockFile.findInput({"nixpkgs"})) { if (auto lockedNode = std::dynamic_pointer_cast(nixpkgsInput)) { debug("using nixpkgs flake '%s'", lockedNode->lockedRef); return std::move(lockedNode->lockedRef); } } return Installable::nixpkgsFlakeRef(); } std::vector> SourceExprCommand::parseInstallables( ref store, std::vector ss) { std::vector> result; if (file || expr) { if (file && expr) throw UsageError("'--file' and '--expr' are exclusive"); // FIXME: backward compatibility hack if (file) evalSettings.pureEval = false; auto state = getEvalState(); auto vFile = state->allocValue(); if (file) state->evalFile(lookupFileArg(*state, *file), *vFile); else { auto e = state->parseExprFromString(*expr, absPath(".")); state->eval(e, *vFile); } for (auto & s : ss) result.push_back(std::make_shared(state, *this, vFile, s == "." ? "" : s)); } else { for (auto & s : ss) { std::exception_ptr ex; if (s.find('/') != std::string::npos) { try { result.push_back(std::make_shared(store, store->followLinksToStorePath(s))); continue; } catch (BadStorePath &) { } catch (...) { if (!ex) ex = std::current_exception(); } } try { auto [flakeRef, fragment] = parseFlakeRefWithFragment(s, absPath(".")); result.push_back(std::make_shared( this, getEvalState(), std::move(flakeRef), fragment, getDefaultFlakeAttrPaths(), getDefaultFlakeAttrPathPrefixes(), lockFlags)); continue; } catch (...) { ex = std::current_exception(); } std::rethrow_exception(ex); } } return result; } std::shared_ptr SourceExprCommand::parseInstallable( ref store, const std::string & installable) { auto installables = parseInstallables(store, {installable}); assert(installables.size() == 1); return installables.front(); } BuiltPaths getBuiltPaths(ref evalStore, ref store, const DerivedPaths & hopefullyBuiltPaths) { BuiltPaths res; for (const auto & b : hopefullyBuiltPaths) std::visit( overloaded{ [&](const DerivedPath::Opaque & bo) { res.push_back(BuiltPath::Opaque{bo.path}); }, [&](const DerivedPath::Built & bfd) { OutputPathMap outputs; auto drv = evalStore->readDerivation(bfd.drvPath); auto outputHashes = staticOutputHashes(*evalStore, drv); // FIXME: expensive auto drvOutputs = drv.outputsAndOptPaths(*store); for (auto & output : bfd.outputs) { if (!outputHashes.count(output)) throw Error( "the derivation '%s' doesn't have an output named '%s'", store->printStorePath(bfd.drvPath), output); if (settings.isExperimentalFeatureEnabled( Xp::CaDerivations)) { auto outputId = DrvOutput{outputHashes.at(output), output}; auto realisation = store->queryRealisation(outputId); if (!realisation) throw Error( "cannot operate on an output of unbuilt " "content-addressed derivation '%s'", outputId.to_string()); outputs.insert_or_assign( output, realisation->outPath); } else { // If ca-derivations isn't enabled, assume that // the output path is statically known. assert(drvOutputs.count(output)); assert(drvOutputs.at(output).second); outputs.insert_or_assign( output, *drvOutputs.at(output).second); } } res.push_back(BuiltPath::Built{bfd.drvPath, outputs}); }, }, b.raw()); return res; } BuiltPaths Installable::build( ref evalStore, ref store, Realise mode, const std::vector> & installables, BuildMode bMode) { if (mode == Realise::Nothing) settings.readOnlyMode = true; std::vector pathsToBuild; for (auto & i : installables) { auto b = i->toDerivedPaths(); pathsToBuild.insert(pathsToBuild.end(), b.begin(), b.end()); } if (mode == Realise::Nothing || mode == Realise::Derivation) printMissing(store, pathsToBuild, lvlError); else if (mode == Realise::Outputs) store->buildPaths(pathsToBuild, bMode, evalStore); return getBuiltPaths(evalStore, store, pathsToBuild); } BuiltPaths Installable::toBuiltPaths( ref evalStore, ref store, Realise mode, OperateOn operateOn, const std::vector> & installables) { if (operateOn == OperateOn::Output) return Installable::build(evalStore, store, mode, installables); else { if (mode == Realise::Nothing) settings.readOnlyMode = true; BuiltPaths res; for (auto & drvPath : Installable::toDerivations(store, installables, true)) res.push_back(BuiltPath::Opaque{drvPath}); return res; } } StorePathSet Installable::toStorePaths( ref evalStore, ref store, Realise mode, OperateOn operateOn, const std::vector> & installables) { StorePathSet outPaths; for (auto & path : toBuiltPaths(evalStore, store, mode, operateOn, installables)) { auto thisOutPaths = path.outPaths(); outPaths.insert(thisOutPaths.begin(), thisOutPaths.end()); } return outPaths; } StorePath Installable::toStorePath( ref evalStore, ref store, Realise mode, OperateOn operateOn, std::shared_ptr installable) { auto paths = toStorePaths(evalStore, store, mode, operateOn, {installable}); if (paths.size() != 1) throw Error("argument '%s' should evaluate to one store path", installable->what()); return *paths.begin(); } StorePathSet Installable::toDerivations( ref store, const std::vector> & installables, bool useDeriver) { StorePathSet drvPaths; for (const auto & i : installables) for (const auto & b : i->toDerivedPaths()) std::visit(overloaded { [&](const DerivedPath::Opaque & bo) { if (!useDeriver) throw Error("argument '%s' did not evaluate to a derivation", i->what()); drvPaths.insert(getDeriver(store, *i, bo.path)); }, [&](const DerivedPath::Built & bfd) { drvPaths.insert(bfd.drvPath); }, }, b.raw()); return drvPaths; } InstallablesCommand::InstallablesCommand() { expectArgs({ .label = "installables", .handler = {&_installables}, .completer = {[&](size_t, std::string_view prefix) { completeInstallable(prefix); }} }); } void InstallablesCommand::prepare() { if (_installables.empty() && useDefaultInstallables()) // FIXME: commands like "nix install" should not have a // default, probably. _installables.push_back("."); installables = parseInstallables(getStore(), _installables); } std::optional InstallablesCommand::getFlakeRefForCompletion() { if (_installables.empty()) { if (useDefaultInstallables()) return parseFlakeRef(".", absPath(".")); return {}; } return parseFlakeRef(_installables.front(), absPath(".")); } InstallableCommand::InstallableCommand() { expectArgs({ .label = "installable", .optional = true, .handler = {&_installable}, .completer = {[&](size_t, std::string_view prefix) { completeInstallable(prefix); }} }); } void InstallableCommand::prepare() { installable = parseInstallable(getStore(), _installable); } }