maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #2479 from nlewo/graphml

Browse source 
Add --graphml option to the nix-store --query command
This commit is contained in:
Eelco Dolstra 2018-10-23 15:56:05 +02:00 • committed by GitHub
commit 1a08ad75ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 108 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/manual/command-ref/nix-store.xml
View file

@ -679,6 +679,18 @@ query is applied to the target of the symlink.</para>
</varlistentry>
<varlistentry><term><option>--graphml</option></term>
<listitem><para>Prints the references graph of the store paths
<replaceable>paths</replaceable> in the <link
xlink:href="http://graphml.graphdrawing.org/">GraphML</link> file format.
This can be used to visualise dependency graphs. To obtain a
build-time dependency graph, apply this to a store derivation. To
obtain a runtime dependency graph, apply it to an output
path.</para></listitem>
</varlistentry>
<varlistentry><term><option>--binding</option> <replaceable>name</replaceable></term>
<term><option>-b</option> <replaceable>name</replaceable></term>

90
src/nix-store/graphml.cc Normal file
View file

@ -0,0 +1,90 @@
#include "graphml.hh"
#include "util.hh"
#include "store-api.hh"
#include "derivations.hh"
#include <iostream>
using std::cout;
namespace nix {
static inline const string & xmlQuote(const string & s)
{
// Luckily, store paths shouldn't contain any character that needs to be
// quoted.
return s;
}
static string symbolicName(const string & path)
{
string p = baseNameOf(path);
return string(p, p.find('-') + 1);
}
static string makeEdge(const string & src, const string & dst)
{
return fmt(" <edge source=\"%1%\" target=\"%2%\"/>\n",
xmlQuote(src), xmlQuote(dst));
}
static string makeNode(const ValidPathInfo & info)
{
return fmt(
" <node id=\"%1%\">\n"
" <data key=\"narSize\">%2%</data>\n"
" <data key=\"name\">%3%</data>\n"
" <data key=\"type\">%4%</data>\n"
" </node>\n",
info.path,
info.narSize,
symbolicName(info.path),
(isDerivation(info.path) ? "derivation" : "output-path"));
}
void printGraphML(ref<Store> store, const PathSet & roots)
{
PathSet workList(roots);
PathSet doneSet;
std::pair<PathSet::iterator,bool> ret;
cout << "<?xml version='1.0' encoding='utf-8'?>\n"
<< "<graphml xmlns='http://graphml.graphdrawing.org/xmlns'\n"
<< " xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'\n"
<< " xsi:schemaLocation='http://graphml.graphdrawing.org/xmlns/1.0/graphml.xsd'>\n"
<< "<key id='narSize' for='node' attr.name='narSize' attr.type='int'/>"
<< "<key id='name' for='node' attr.name='name' attr.type='string'/>"
<< "<key id='type' for='node' attr.name='type' attr.type='string'/>"
<< "<graph id='G' edgedefault='directed'>\n";
while (!workList.empty()) {
Path path = *(workList.begin());
workList.erase(path);
ret = doneSet.insert(path);
if (ret.second == false) continue;
ValidPathInfo info = *(store->queryPathInfo(path));
cout << makeNode(info);
for (auto & p : store->queryPathInfo(path)->references) {
if (p != path) {
workList.insert(p);
cout << makeEdge(path, p);
}
}
}
cout << "</graph>\n";
cout << "</graphml>\n";
}
}

2
src/nix-store/xmlgraph.hh → src/nix-store/graphml.hh
View file

@ -6,6 +6,6 @@ namespace nix {
class Store;
void printXmlGraph(ref<Store> store, const PathSet & roots);
void printGraphML(ref<Store> store, const PathSet & roots);
}

10
src/nix-store/nix-store.cc
View file

@ -8,7 +8,7 @@
#include "shared.hh"
#include "util.hh"
#include "worker-protocol.hh"
#include "xmlgraph.hh"
#include "graphml.hh"
#include <iostream>
#include <algorithm>
@ -273,7 +273,7 @@ static void opQuery(Strings opFlags, Strings opArgs)
enum QueryType
{ qDefault, qOutputs, qRequisites, qReferences, qReferrers
, qReferrersClosure, qDeriver, qBinding, qHash, qSize
, qTree, qGraph, qXml, qResolve, qRoots };
, qTree, qGraph, qGraphML, qResolve, qRoots };
QueryType query = qDefault;
bool useOutput = false;
bool includeOutputs = false;
@ -299,7 +299,7 @@ static void opQuery(Strings opFlags, Strings opArgs)
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 == "--graphml") query = qGraphML;
else if (i == "--resolve") query = qResolve;
else if (i == "--roots") query = qRoots;
else if (i == "--use-output" || i == "-u") useOutput = true;
@ -403,13 +403,13 @@ static void opQuery(Strings opFlags, Strings opArgs)
break;
}
case qXml: {
case qGraphML: {
PathSet roots;
for (auto & i : opArgs) {
PathSet paths = maybeUseOutputs(store->followLinksToStorePath(i), useOutput, forceRealise);
roots.insert(paths.begin(), paths.end());
}
printXmlGraph(ref<Store>(store), roots);
printGraphML(ref<Store>(store), roots);
break;
}

66
src/nix-store/xmlgraph.cc
View file

@ -1,66 +0,0 @@
#include "xmlgraph.hh"
#include "util.hh"
#include "store-api.hh"
#include <iostream>
using std::cout;
namespace nix {
static inline const string & xmlQuote(const string & s)
{
// Luckily, store paths shouldn't contain any character that needs to be
// quoted.
return s;
}
static string makeEdge(const string & src, const string & dst)
{
format f = format(" <edge src=\"%1%\" dst=\"%2%\"/>\n")
% xmlQuote(src) % xmlQuote(dst);
return f.str();
}
static string makeNode(const string & id)
{
format f = format(" <node name=\"%1%\"/>\n") % xmlQuote(id);
return f.str();
}
void printXmlGraph(ref<Store> store, const PathSet & roots)
{
PathSet workList(roots);
PathSet doneSet;
cout << "<?xml version='1.0' encoding='utf-8'?>\n"
<< "<nix>\n";
while (!workList.empty()) {
Path path = *(workList.begin());
workList.erase(path);
if (doneSet.find(path) != doneSet.end()) continue;
doneSet.insert(path);
cout << makeNode(path);
for (auto & p : store->queryPathInfo(path)->references) {
if (p != path) {
workList.insert(p);
cout << makeEdge(p, path);
}
}
}
cout << "</nix>\n";
}
}