#include "globals.hh" #include "misc.hh" #include "archive.hh" #include "shared.hh" #include "dotgraph.hh" #include "xmlgraph.hh" #include "local-store.hh" #include "util.hh" #include "help.txt.hh" #include #include #include #include #include #include #include using namespace nix; using std::cin; using std::cout; typedef void (* Operation) (Strings opFlags, Strings opArgs); void printHelp() { cout << string((char *) helpText); } static Path gcRoot; static int rootNr = 0; static bool indirectRoot = false; LocalStore & ensureLocalStore() { LocalStore * store2(dynamic_cast(store.get())); if (!store2) throw Error("you don't have sufficient rights to use this command"); return *store2; } static Path useDeriver(Path path) { if (!isDerivation(path)) { path = store->queryDeriver(path); if (path == "") throw Error(format("deriver of path `%1%' is not known") % path); } return path; } /* Realise the given path. For a derivation that means build it; for other paths it means ensure their validity. */ static PathSet realisePath(const Path & path) { if (isDerivation(path)) { store->buildPaths(singleton(path)); Derivation drv = derivationFromPath(*store, path); rootNr++; PathSet outputs; foreach (DerivationOutputs::iterator, i, drv.outputs) { Path outPath = i->second.path; if (gcRoot == "") printGCWarning(); else { Path rootName = gcRoot; if (rootNr > 1) rootName += "-" + int2String(rootNr); if (i->first != "out") rootName += "-" + i->first; outPath = addPermRoot(*store, outPath, rootName, indirectRoot); } outputs.insert(outPath); } return outputs; } else { store->ensurePath(path); return singleton(path); } } /* Realise the given paths. */ static void opRealise(Strings opFlags, Strings opArgs) { bool dryRun = false; foreach (Strings::iterator, i, opFlags) if (*i == "--dry-run") dryRun = true; else throw UsageError(format("unknown flag `%1%'") % *i); foreach (Strings::iterator, i, opArgs) *i = followLinksToStorePath(*i); printMissing(*store, PathSet(opArgs.begin(), opArgs.end())); if (dryRun) return; /* Build all paths at the same time to exploit parallelism. */ PathSet paths(opArgs.begin(), opArgs.end()); store->buildPaths(paths); foreach (Paths::iterator, i, opArgs) { PathSet paths = realisePath(*i); foreach (PathSet::iterator, j, paths) cout << format("%1%\n") % *j; } } /* Add files to the Nix store and print the resulting paths. */ static void opAdd(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); for (Strings::iterator i = opArgs.begin(); i != opArgs.end(); ++i) cout << format("%1%\n") % store->addToStore(*i); } /* Preload the output of a fixed-output derivation into the Nix store. */ static void opAddFixed(Strings opFlags, Strings opArgs) { bool recursive = false; for (Strings::iterator i = opFlags.begin(); i != opFlags.end(); ++i) if (*i == "--recursive") recursive = true; else throw UsageError(format("unknown flag `%1%'") % *i); if (opArgs.empty()) throw UsageError("first argument must be hash algorithm"); HashType hashAlgo = parseHashType(opArgs.front()); opArgs.pop_front(); for (Strings::iterator i = opArgs.begin(); i != opArgs.end(); ++i) cout << format("%1%\n") % store->addToStore(*i, recursive, hashAlgo); } /* Hack to support caching in `nix-prefetch-url'. */ static void opPrintFixedPath(Strings opFlags, Strings opArgs) { bool recursive = false; for (Strings::iterator i = opFlags.begin(); i != opFlags.end(); ++i) if (*i == "--recursive") recursive = true; else throw UsageError(format("unknown flag `%1%'") % *i); if (opArgs.size() != 3) throw UsageError(format("`--print-fixed-path' requires three arguments")); Strings::iterator i = opArgs.begin(); HashType hashAlgo = parseHashType(*i++); string hash = *i++; string name = *i++; cout << format("%1%\n") % makeFixedOutputPath(recursive, hashAlgo, parseHash16or32(hashAlgo, hash), name); } static PathSet maybeUseOutputs(const Path & storePath, bool useOutput, bool forceRealise) { if (forceRealise) realisePath(storePath); if (useOutput && isDerivation(storePath)) { Derivation drv = derivationFromPath(*store, storePath); PathSet outputs; foreach (DerivationOutputs::iterator, i, drv.outputs) outputs.insert(i->second.path); return outputs; } else return singleton(storePath); } /* Some code to print a tree representation of a derivation dependency graph. Topological sorting is used to keep the tree relatively flat. */ const string treeConn = "+---"; const string treeLine = "| "; const string treeNull = " "; static void printTree(const Path & path, const string & firstPad, const string & tailPad, PathSet & done) { if (done.find(path) != done.end()) { cout << format("%1%%2% [...]\n") % firstPad % path; return; } done.insert(path); cout << format("%1%%2%\n") % firstPad % path; PathSet references; store->queryReferences(path, references); #if 0 for (PathSet::iterator i = drv.inputSrcs.begin(); i != drv.inputSrcs.end(); ++i) cout << format("%1%%2%\n") % (tailPad + treeConn) % *i; #endif /* Topologically sort under the relation A < B iff A \in closure(B). That is, if derivation A is an (possibly indirect) input of B, then A is printed first. This has the effect of flattening the tree, preventing deeply nested structures. */ Paths sorted = topoSortPaths(*store, references); reverse(sorted.begin(), sorted.end()); for (Paths::iterator i = sorted.begin(); i != sorted.end(); ++i) { Paths::iterator j = i; ++j; printTree(*i, tailPad + treeConn, j == sorted.end() ? tailPad + treeNull : tailPad + treeLine, done); } } /* Perform various sorts of queries. */ static void opQuery(Strings opFlags, Strings opArgs) { enum { qOutputs, qRequisites, qReferences, qReferrers , qReferrersClosure, qDeriver, qBinding, qHash, qSize , qTree, qGraph, qXml, qResolve, qRoots } query = qOutputs; bool useOutput = false; bool includeOutputs = false; bool forceRealise = false; string bindingName; foreach (Strings::iterator, i, opFlags) if (*i == "--outputs") query = qOutputs; else if (*i == "--requisites" || *i == "-R") query = qRequisites; else if (*i == "--references") query = qReferences; else if (*i == "--referrers" || *i == "--referers") query = qReferrers; else if (*i == "--referrers-closure" || *i == "--referers-closure") query = qReferrersClosure; else if (*i == "--deriver" || *i == "-d") query = qDeriver; else if (*i == "--binding" || *i == "-b") { if (opArgs.size() == 0) throw UsageError("expected binding name"); bindingName = opArgs.front(); opArgs.pop_front(); query = qBinding; } else if (*i == "--hash") query = qHash; else if (*i == "--size") query = qSize; else if (*i == "--tree") query = qTree; else if (*i == "--graph") query = qGraph; else if (*i == "--xml") query = qXml; else if (*i == "--resolve") query = qResolve; else if (*i == "--roots") query = qRoots; else if (*i == "--use-output" || *i == "-u") useOutput = true; else if (*i == "--force-realise" || *i == "-f") forceRealise = true; else if (*i == "--include-outputs") includeOutputs = true; else throw UsageError(format("unknown flag `%1%'") % *i); switch (query) { case qOutputs: { foreach (Strings::iterator, i, opArgs) { *i = followLinksToStorePath(*i); if (forceRealise) realisePath(*i); Derivation drv = derivationFromPath(*store, *i); foreach (DerivationOutputs::iterator, j, drv.outputs) cout << format("%1%\n") % j->second.path; } break; } case qRequisites: case qReferences: case qReferrers: case qReferrersClosure: { PathSet paths; foreach (Strings::iterator, i, opArgs) { PathSet ps = maybeUseOutputs(followLinksToStorePath(*i), useOutput, forceRealise); foreach (PathSet::iterator, j, ps) { if (query == qRequisites) computeFSClosure(*store, *j, paths, false, includeOutputs); else if (query == qReferences) store->queryReferences(*j, paths); else if (query == qReferrers) store->queryReferrers(*j, paths); else if (query == qReferrersClosure) computeFSClosure(*store, *j, paths, true); } } Paths sorted = topoSortPaths(*store, paths); for (Paths::reverse_iterator i = sorted.rbegin(); i != sorted.rend(); ++i) cout << format("%s\n") % *i; break; } case qDeriver: foreach (Strings::iterator, i, opArgs) { Path deriver = store->queryDeriver(followLinksToStorePath(*i)); cout << format("%1%\n") % (deriver == "" ? "unknown-deriver" : deriver); } break; case qBinding: foreach (Strings::iterator, i, opArgs) { Path path = useDeriver(followLinksToStorePath(*i)); Derivation drv = derivationFromPath(*store, path); StringPairs::iterator j = drv.env.find(bindingName); if (j == drv.env.end()) throw Error(format("derivation `%1%' has no environment binding named `%2%'") % path % bindingName); cout << format("%1%\n") % j->second; } break; case qHash: case qSize: foreach (Strings::iterator, i, opArgs) { PathSet paths = maybeUseOutputs(followLinksToStorePath(*i), useOutput, forceRealise); foreach (PathSet::iterator, j, paths) { ValidPathInfo info = store->queryPathInfo(*j); if (query == qHash) { assert(info.hash.type == htSHA256); cout << format("sha256:%1%\n") % printHash32(info.hash); } else if (query == qSize) cout << format("%1%\n") % info.narSize; } } break; case qTree: { PathSet done; foreach (Strings::iterator, i, opArgs) printTree(followLinksToStorePath(*i), "", "", done); break; } case qGraph: { PathSet roots; foreach (Strings::iterator, i, opArgs) { PathSet paths = maybeUseOutputs(followLinksToStorePath(*i), useOutput, forceRealise); roots.insert(paths.begin(), paths.end()); } printDotGraph(roots); break; } case qXml: { PathSet roots; foreach (Strings::iterator, i, opArgs) { PathSet paths = maybeUseOutputs(followLinksToStorePath(*i), useOutput, forceRealise); roots.insert(paths.begin(), paths.end()); } printXmlGraph(roots); break; } case qResolve: { foreach (Strings::iterator, i, opArgs) cout << format("%1%\n") % followLinksToStorePath(*i); break; } case qRoots: { PathSet referrers; foreach (Strings::iterator, i, opArgs) { PathSet paths = maybeUseOutputs(followLinksToStorePath(*i), useOutput, forceRealise); foreach (PathSet::iterator, j, paths) computeFSClosure(*store, *j, referrers, true); } Roots roots = store->findRoots(); foreach (Roots::iterator, i, roots) if (referrers.find(i->second) != referrers.end()) cout << format("%1%\n") % i->first; break; } default: abort(); } } static string shellEscape(const string & s) { string r; foreach (string::const_iterator, i, s) if (*i == '\'') r += "'\\''"; else r += *i; return r; } static void opPrintEnv(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); if (opArgs.size() != 1) throw UsageError("`--print-env' requires one derivation store path"); Path drvPath = opArgs.front(); Derivation drv = derivationFromPath(*store, drvPath); /* Print each environment variable in the derivation in a format that can be sourced by the shell. */ foreach (StringPairs::iterator, i, drv.env) cout << format("export %1%; %1%='%2%'\n") % i->first % shellEscape(i->second); /* Also output the arguments. This doesn't preserve whitespace in arguments. */ cout << "export _args; _args='"; foreach (Strings::iterator, i, drv.args) { if (i != drv.args.begin()) cout << ' '; cout << shellEscape(*i); } cout << "'\n"; } static void opReadLog(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); foreach (Strings::iterator, i, opArgs) { Path path = useDeriver(followLinksToStorePath(*i)); Path logPath = (format("%1%/%2%/%3%") % nixLogDir % drvsLogDir % baseNameOf(path)).str(); Path logBz2Path = logPath + ".bz2"; if (pathExists(logPath)) { /* !!! Make this run in O(1) memory. */ string log = readFile(logPath); writeFull(STDOUT_FILENO, (const unsigned char *) log.data(), log.size()); } else if (pathExists(logBz2Path)) { AutoCloseFD fd = open(logBz2Path.c_str(), O_RDONLY); FILE * f = 0; if (fd == -1 || (f = fdopen(fd.borrow(), "r")) == 0) throw SysError(format("opening file `%1%'") % logBz2Path); int err; BZFILE * bz = BZ2_bzReadOpen(&err, f, 0, 0, 0, 0); if (!bz) throw Error(format("cannot open bzip2 file `%1%'") % logBz2Path); unsigned char buf[128 * 1024]; do { int n = BZ2_bzRead(&err, bz, buf, sizeof(buf)); if (err != BZ_OK && err != BZ_STREAM_END) throw Error(format("error reading bzip2 file `%1%'") % logBz2Path); writeFull(STDOUT_FILENO, buf, n); } while (err != BZ_STREAM_END); BZ2_bzReadClose(&err, bz); } else throw Error(format("build log of derivation `%1%' is not available") % path); } } static void opDumpDB(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); if (!opArgs.empty()) throw UsageError("no arguments expected"); PathSet validPaths = store->queryValidPaths(); foreach (PathSet::iterator, i, validPaths) cout << store->makeValidityRegistration(singleton(*i), true, true); } static void registerValidity(bool reregister, bool hashGiven, bool canonicalise) { ValidPathInfos infos; while (1) { ValidPathInfo info = decodeValidPathInfo(cin, hashGiven); if (info.path == "") break; if (!store->isValidPath(info.path) || reregister) { /* !!! races */ if (canonicalise) canonicalisePathMetaData(info.path); if (!hashGiven) { HashResult hash = hashPath(htSHA256, info.path); info.hash = hash.first; info.narSize = hash.second; } infos.push_back(info); } } ensureLocalStore().registerValidPaths(infos); } static void opLoadDB(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); if (!opArgs.empty()) throw UsageError("no arguments expected"); registerValidity(true, true, false); } static void opRegisterValidity(Strings opFlags, Strings opArgs) { bool reregister = false; // !!! maybe this should be the default bool hashGiven = false; for (Strings::iterator i = opFlags.begin(); i != opFlags.end(); ++i) if (*i == "--reregister") reregister = true; else if (*i == "--hash-given") hashGiven = true; else throw UsageError(format("unknown flag `%1%'") % *i); if (!opArgs.empty()) throw UsageError("no arguments expected"); registerValidity(reregister, hashGiven, true); } static void opCheckValidity(Strings opFlags, Strings opArgs) { bool printInvalid = false; for (Strings::iterator i = opFlags.begin(); i != opFlags.end(); ++i) if (*i == "--print-invalid") printInvalid = true; else throw UsageError(format("unknown flag `%1%'") % *i); for (Strings::iterator i = opArgs.begin(); i != opArgs.end(); ++i) { Path path = followLinksToStorePath(*i); if (!store->isValidPath(path)) { if (printInvalid) cout << format("%1%\n") % path; else throw Error(format("path `%1%' is not valid") % path); } } } static string showBytes(unsigned long long bytes) { return (format("%.2f MiB") % (bytes / (1024.0 * 1024.0))).str(); } struct PrintFreed { bool show; const GCResults & results; PrintFreed(bool show, const GCResults & results) : show(show), results(results) { } ~PrintFreed() { if (show) cout << format("%1% store paths deleted, %2% freed\n") % results.paths.size() % showBytes(results.bytesFreed); } }; static void opGC(Strings opFlags, Strings opArgs) { bool printRoots = false; GCOptions options; options.action = GCOptions::gcDeleteDead; GCResults results; /* Do what? */ foreach (Strings::iterator, i, opFlags) if (*i == "--print-roots") printRoots = true; else if (*i == "--print-live") options.action = GCOptions::gcReturnLive; else if (*i == "--print-dead") options.action = GCOptions::gcReturnDead; else if (*i == "--delete") options.action = GCOptions::gcDeleteDead; else if (*i == "--max-freed") { long long maxFreed = getIntArg(*i, i, opFlags.end()); options.maxFreed = maxFreed >= 0 ? maxFreed : 0; } else throw UsageError(format("bad sub-operation `%1%' in GC") % *i); if (!opArgs.empty()) throw UsageError("no arguments expected"); if (printRoots) { Roots roots = store->findRoots(); foreach (Roots::iterator, i, roots) cout << i->first << " -> " << i->second << std::endl; } else { PrintFreed freed(options.action == GCOptions::gcDeleteDead, results); store->collectGarbage(options, results); if (options.action != GCOptions::gcDeleteDead) foreach (PathSet::iterator, i, results.paths) cout << *i << std::endl; } } /* Remove paths from the Nix store if possible (i.e., if they do not have any remaining referrers and are not reachable from any GC roots). */ static void opDelete(Strings opFlags, Strings opArgs) { GCOptions options; options.action = GCOptions::gcDeleteSpecific; foreach (Strings::iterator, i, opFlags) if (*i == "--ignore-liveness") options.ignoreLiveness = true; else throw UsageError(format("unknown flag `%1%'") % *i); foreach (Strings::iterator, i, opArgs) options.pathsToDelete.insert(followLinksToStorePath(*i)); GCResults results; PrintFreed freed(true, results); store->collectGarbage(options, results); } /* Dump a path as a Nix archive. The archive is written to standard output. */ static void opDump(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); if (opArgs.size() != 1) throw UsageError("only one argument allowed"); FdSink sink(STDOUT_FILENO); string path = *opArgs.begin(); dumpPath(path, sink); } /* Restore a value from a Nix archive. The archive is read from standard input. */ static void opRestore(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); if (opArgs.size() != 1) throw UsageError("only one argument allowed"); FdSource source(STDIN_FILENO); restorePath(*opArgs.begin(), source); } static void opExport(Strings opFlags, Strings opArgs) { bool sign = false; for (Strings::iterator i = opFlags.begin(); i != opFlags.end(); ++i) if (*i == "--sign") sign = true; else throw UsageError(format("unknown flag `%1%'") % *i); FdSink sink(STDOUT_FILENO); exportPaths(*store, opArgs, sign, sink); } static void opImport(Strings opFlags, Strings opArgs) { bool requireSignature = false; foreach (Strings::iterator, i, opFlags) if (*i == "--require-signature") requireSignature = true; else throw UsageError(format("unknown flag `%1%'") % *i); if (!opArgs.empty()) throw UsageError("no arguments expected"); FdSource source(STDIN_FILENO); Paths paths = store->importPaths(requireSignature, source); foreach (Paths::iterator, i, paths) cout << format("%1%\n") % *i << std::flush; } /* Initialise the Nix databases. */ static void opInit(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("unknown flag"); if (!opArgs.empty()) throw UsageError("no arguments expected"); /* Doesn't do anything right now; database tables are initialised automatically. */ } /* Verify the consistency of the Nix environment. */ static void opVerify(Strings opFlags, Strings opArgs) { if (!opArgs.empty()) throw UsageError("no arguments expected"); bool checkContents = false; for (Strings::iterator i = opFlags.begin(); i != opFlags.end(); ++i) if (*i == "--check-contents") checkContents = true; else throw UsageError(format("unknown flag `%1%'") % *i); ensureLocalStore().verifyStore(checkContents); } /* Verify whether the contents of the given store path have not changed. */ static void opVerifyPath(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("no flags expected"); foreach (Strings::iterator, i, opArgs) { Path path = followLinksToStorePath(*i); printMsg(lvlTalkative, format("checking path `%1%'...") % path); ValidPathInfo info = store->queryPathInfo(path); HashResult current = hashPath(info.hash.type, path); if (current.first != info.hash) { printMsg(lvlError, format("path `%1%' was modified! expected hash `%2%', got `%3%'") % path % printHash(info.hash) % printHash(current.first)); exitCode = 1; } } } static void showOptimiseStats(OptimiseStats & stats) { printMsg(lvlError, format("%1% freed by hard-linking %2% files; there are %3% files with equal contents out of %4% files in total") % showBytes(stats.bytesFreed) % stats.filesLinked % stats.sameContents % stats.totalFiles); } /* Optimise the disk space usage of the Nix store by hard-linking files with the same contents. */ static void opOptimise(Strings opFlags, Strings opArgs) { if (!opArgs.empty() || !opFlags.empty()) throw UsageError("no arguments expected"); OptimiseStats stats; try { ensureLocalStore().optimiseStore(stats); } catch (...) { showOptimiseStats(stats); throw; } showOptimiseStats(stats); } static void opQueryFailedPaths(Strings opFlags, Strings opArgs) { if (!opArgs.empty() || !opFlags.empty()) throw UsageError("no arguments expected"); PathSet failed = store->queryFailedPaths(); foreach (PathSet::iterator, i, failed) cout << format("%1%\n") % *i; } static void opClearFailedPaths(Strings opFlags, Strings opArgs) { if (!opFlags.empty()) throw UsageError("no flags expected"); store->clearFailedPaths(PathSet(opArgs.begin(), opArgs.end())); } /* Scan the arguments; find the operation, set global flags, put all other flags in a list, and put all other arguments in another list. */ void run(Strings args) { Strings opFlags, opArgs; Operation op = 0; for (Strings::iterator i = args.begin(); i != args.end(); ) { string arg = *i++; Operation oldOp = op; if (arg == "--realise" || arg == "-r") op = opRealise; else if (arg == "--add" || arg == "-A") op = opAdd; else if (arg == "--add-fixed") op = opAddFixed; else if (arg == "--print-fixed-path") op = opPrintFixedPath; else if (arg == "--delete") op = opDelete; else if (arg == "--query" || arg == "-q") op = opQuery; else if (arg == "--print-env") op = opPrintEnv; else if (arg == "--read-log" || arg == "-l") op = opReadLog; else if (arg == "--dump-db") op = opDumpDB; else if (arg == "--load-db") op = opLoadDB; else if (arg == "--register-validity") op = opRegisterValidity; else if (arg == "--check-validity") op = opCheckValidity; else if (arg == "--gc") op = opGC; else if (arg == "--dump") op = opDump; else if (arg == "--restore") op = opRestore; else if (arg == "--export") op = opExport; else if (arg == "--import") op = opImport; else if (arg == "--init") op = opInit; else if (arg == "--verify") op = opVerify; else if (arg == "--verify-path") op = opVerifyPath; else if (arg == "--optimise") op = opOptimise; else if (arg == "--query-failed-paths") op = opQueryFailedPaths; else if (arg == "--clear-failed-paths") op = opClearFailedPaths; else if (arg == "--add-root") { if (i == args.end()) throw UsageError("`--add-root requires an argument"); gcRoot = absPath(*i++); } else if (arg == "--indirect") indirectRoot = true; else if (arg[0] == '-') { opFlags.push_back(arg); if (arg == "--max-freed" || arg == "--max-links" || arg == "--max-atime") { /* !!! hack */ if (i != args.end()) opFlags.push_back(*i++); } } else opArgs.push_back(arg); if (oldOp && oldOp != op) throw UsageError("only one operation may be specified"); } if (!op) throw UsageError("no operation specified"); if (op != opDump && op != opRestore) /* !!! hack */ store = openStore(op != opGC); op(opFlags, opArgs); } string programId = "nix-store";