Graph.cc

/*
 *  MoMEMta: a modular implementation of the Matrix Element Method
 *  Copyright (C) 2017  Universite catholique de Louvain (UCL), Belgium
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <Graph.h>

#include <ModuleUtils.h>
#include <Path.h>

#include <boost/graph/graphviz.hpp>
#include <boost/graph/topological_sort.hpp>

#include <array>

#ifdef DEBUG_TIMING
using namespace std::chrono;
#endif

using namespace boost::uuids;

namespace momemta {

typedef boost::graph_traits<Graph>::out_edge_iterator out_edge_iterator_t;
typedef boost::graph_traits<Graph>::in_edge_iterator in_edge_iterator_t;

class incomplete_looper_path: public std::runtime_error {
    using std::runtime_error::runtime_error;
};

class unresolved_input: public std::runtime_error {
    using std::runtime_error::runtime_error;
};

bool isConnectedToByOut(Graph& g, vertex_t vertex, vertex_t to) {
    out_edge_iterator_t o, o_end;
    std::tie(o, o_end) = boost::out_edges(vertex, g);

    for (; o != o_end; ++o) {
        vertex_t target = boost::target(*o, g);
        if (target == to)
            return true;

        if (isConnectedToByOut(g, target, to))
            return true;
    }

    return false;
}

bool isConnectedToByIn(Graph& g, vertex_t vertex, vertex_t to) {
    in_edge_iterator_t i, i_end;
    std::tie(i, i_end) = boost::in_edges(vertex, g);

    for (; i != i_end; ++i) {
        vertex_t source = boost::source(*i, g);
        if (source == to)
            return true;

        if (isConnectedToByIn(g, source, to))
            return true;
    }

    return false;
}

bool isConnectedTo(Graph& g, vertex_t vertex, vertex_t to) {
    if (isConnectedToByOut(g, vertex, to))
        return true;

    return isConnectedToByIn(g, vertex, to);
}

bool isConnectedDirectlyTo(Graph& g, vertex_t from, vertex_t to) {
    out_edge_iterator_t o, o_end;
    std::tie(o, o_end) = boost::out_edges(from, g);

    for (; o != o_end; ++o) {
        vertex_t target = boost::target(*o, g);
        if (target == to)
            return true;
    }

    return false;
}

bool checkInPath(const Configuration::ModuleDecl& looper_decl, const std::string& module_name) {

    const auto& looper_path = looper_decl.parameters->get<ExecutionPath>("path");

    auto it = std::find_if(looper_path.elements.begin(), looper_path.elements.end(),
                           [&module_name](const std::string& m) {
                               return m == module_name;
                           });

    return it != looper_path.elements.end();
}

momemta::ModuleList::value_type get_module_def(const std::string& module_type,
                                               const momemta::ModuleList& available_modules) {

    auto it = std::find_if(available_modules.begin(), available_modules.end(),
                           [&module_type](const momemta::ModuleList::value_type& m) {
                               return m.name == module_type;
                           });

    assert(it != available_modules.end());

    return *it;
}

void ComputationGraph::addDecl(const uuid& path, const Configuration::ModuleDecl& decl) {

    auto& storage = module_decls;

    // Check if an entry already exists for the execution path.
    auto map_it = storage.find(path);
    if (map_it == storage.end()) {
        // Add the path into the list of know path, keeping track of the order
        sorted_execution_paths.emplace_back(path);

        // Add the module into its path
        storage[path].emplace_back(decl);
    } else {
        map_it->second.emplace_back(decl);
    }
}

const std::vector<uuid>& ComputationGraph::getPaths() const {
    return sorted_execution_paths;
}

const std::vector<Configuration::ModuleDecl>& ComputationGraph::getDecls(const uuid& path) const {
    return module_decls.at(path);
}

void ComputationGraph::initialize(PoolPtr pool) {
    const auto& execution_paths = sorted_execution_paths;

    // Keep track of the instantiated modules in their own execution path
    std::map<uuid, std::vector<ModulePtr>> module_instances;

    // The list of execution path is sorted in the order we must execute the modules (modules from the first path first,
    // then modules from the second path, etc.)
    // However, some modules (ie Loopers) except as argument an execution path containing a list of module instances.
    // Since modules and paths are sorted based on execution order, such dependencies are always in a other execution path.
    // To solve this, we iterate the execution paths in reverse order, creating first the last execution path, free of
    // any dependencies. This way, we are sure to find the final list of modules already available when we need it.
    for (auto it = execution_paths.rbegin(); it != execution_paths.rend(); ++it) {

        const auto& modules = getDecls(*it);
        for (auto module_decl_it = modules.begin(); module_decl_it != modules.end(); ++module_decl_it) {

            std::unique_ptr<ParameterSet> params(module_decl_it->parameters->clone());

            if (module_decl_it->type == "Looper") {
                // Switch the "path" parameter to the list of module properly instantiated
                auto config_path_id = params->get<ExecutionPath>("path").id;

                // Replace the `path` parameter with the list of modules
                // Since paths are sorted and we iterate backwards, we are sure to find an existing path.
                params->raw_set("path", Path(module_instances.at(config_path_id)));
            }

            try {
                module_instances[*it].push_back(ModuleFactory::get().create(module_decl_it->type, pool, *params));
            } catch (...) {
                LOG(fatal) << "Exception while trying to create module " << module_decl_it->type
                           << "::" << module_decl_it->name
                           << ". See message above for a (possible) more detailed description of the error.";
                std::rethrow_exception(std::current_exception());
            }
        }
    }

    modules = module_instances[DEFAULT_EXECUTION_PATH];
}

void ComputationGraph::configure() {
    for (auto& module: modules)
        module->configure();
}

void ComputationGraph::finish() {
    for (auto& module: modules)
        module->finish();
}

void ComputationGraph::beginIntegration() {
    for (auto& module: modules)
        module->beginIntegration();
}

void ComputationGraph::endIntegration() {
    for (auto& module: modules)
        module->endIntegration();
}

Module::Status ComputationGraph::execute() {
    for (auto& module: modules)
        module->beginPoint();

    for (auto& module: modules) {
#ifdef DEBUG_TIMING
        auto start = high_resolution_clock::now();
#endif
        auto status = module->work();
#ifdef DEBUG_TIMING
        module_timings[module.get()] += high_resolution_clock::now() - start;
#endif

        if (status == Module::Status::NEXT) {
            // Stop execution for the current integration step
            return Module::Status::NEXT;
        } else if (status == Module::Status::ABORT) {
            // Abort integration
            return Module::Status::ABORT;
        }
    }

    for (auto& module: modules)
        module->endPoint();

    return Module::Status::OK;
}

#ifdef DEBUG_TIMING
void ComputationGraph::logTimings() const {
    LOG(info) << "Time spent evaluating modules (more details for loopers below):";
    for (auto it: module_timings) {
        LOG(info) << "    " << it.first->name() << ": " << duration_cast<duration<double>>(it.second).count() << "s";
    }
}
#endif

void ComputationGraph::setNDimensions(size_t n) {
    n_dimensions = n;
}

size_t ComputationGraph::getNDimensions() const {
    return n_dimensions;
}

ComputationGraphBuilder::ComputationGraphBuilder(const momemta::ModuleList& available_modules,
                                                 const Configuration& configuration):
        available_modules(available_modules), configuration(configuration) { }

std::shared_ptr<ComputationGraph> ComputationGraphBuilder::build() {

    uint32_t id = 0;
    const auto& requested_modules = configuration.getModules();

    // Create graph vertices. Each vertex is a module requested in the configuration file
    for (const auto& module: requested_modules) {
        vertex_t v = boost::add_vertex(g);

        auto& vertex = g[v];
        vertex.id = id++;
        vertex.name = module.name;
        vertex.type = module.type;

        // Attach module definition to the vertex
        vertex.def = get_module_def(module.type, available_modules);

        // Attach module declaration to the vertex
        vertex.decl = module;

        vertices.emplace(module.name, v);
    }

    graph_exportable = true;

    // Create edges, connecting modules together. An edge link module's outputs to module's inputs
    typename boost::graph_traits<Graph>::vertex_iterator vtx_it, vtx_it_end;
    for (std::tie(vtx_it, vtx_it_end) = boost::vertices(g); vtx_it != vtx_it_end; vtx_it++) {

        const auto& vertex = g[*vtx_it];

        // Connect each output of this module to any module needing it
        for (const auto& output: vertex.def.outputs) {

            // Find any module using this output (iterate over the graph again)
            typename boost::graph_traits<Graph>::vertex_iterator test_vtx_it, test_vtx_it_end;
            for (std::tie(test_vtx_it, test_vtx_it_end) = boost::vertices(g); test_vtx_it != test_vtx_it_end;
                 test_vtx_it++) {

                const auto& test_module = g[*test_vtx_it];

                // Skip ourselves
                if (test_module.name == vertex.name)
                    continue;

                // Get definition of this new module
                const auto& test_module_def = test_module.def;
                for (const auto& input: test_module_def.inputs) {
                    // Grab the InputTag for each input, and see if it points to the vertex
                    momemta::gtl::optional<std::vector<InputTag>> inputTags =
                            momemta::getInputTagsForInput(input, *test_module.decl.parameters);

                    // If the input is optional, we may not have anything
                    if (! inputTags)
                        continue;

                    for (const auto& inputTag: *inputTags) {
                        if (vertex.name == inputTag.module && output.name == inputTag.parameter) {
                            // We have a match, the InputTag points to the vertex output
                            // Create a new edge in the graph

                            edge_t e;
                            bool inserted;
                            std::tie(e, inserted) = boost::add_edge(*vtx_it, vertices.at(test_module.name), g);

                            auto& edge = g[e];
                            edge.virt = false;
                            edge.tag = inputTag;
                            edge.description = inputTag.parameter;
                            if (inputTag.isIndexed()) {
                                edge.description += "[" + std::to_string(inputTag.index) + "]";
                            }
                        }
                    }
                }
            }
        }
    }

    // We need to make sure that any dependencies of a module inside a looper
    // is ran before the looper itself.
    for (const auto& vertex: vertices) {
        if (g[vertex.second].type != "Looper")
            continue;

        const auto& looper_vtx = vertex.second;
        const auto& looper_decl = g[looper_vtx].decl;

        // Retrieve the looper path
        const auto& looper_path = looper_decl.parameters->get<ExecutionPath>("path");

        // Add virtual link between the looper and all module inside its execution path
        for (const auto& m: looper_path.elements) {

            auto module_it = vertices.find(m);
            if (module_it == vertices.end()) {
                LOG(warning) << "Module '" << m << "' present in Looper '" << looper_decl.name
                             << "' execution path does not exists";
                continue;
            }

            auto module_vertex = module_it->second;
            if (!isConnectedDirectlyTo(g, looper_vtx, module_vertex)) {
                edge_t e;
                bool inserted;
                std::tie(e, inserted) = boost::add_edge(looper_vtx, module_vertex, g);
                g[e].description = "virtual link (module in path)";
                g[e].virt = true;
            }
        }

        out_edge_iterator_t e, e_end;
        std::tie(e, e_end) = boost::out_edges(looper_vtx, g);

        // Iterator over all edges this Looper vertex is connected to
        for (; e != e_end; ++e) {
            auto target = boost::target(*e, g);

            // Iterate over all edges connected to the module
            in_edge_iterator_t i, i_end;
            std::tie(i, i_end) = boost::in_edges(target, g);

            for (; i != i_end; ++i) {
                auto source = boost::source(*i, g);

                if (source == looper_vtx)
                    continue;

                // Check if the source vertex is connected to the looper in any way
                if (!isConnectedTo(g, source, looper_vtx)) {
                    edge_t e;
                    bool inserted;
                    std::tie(e, inserted) = boost::add_edge(source, looper_vtx, g);
                    g[e].description = "virtual link";
                    g[e].virt = true;
                }
            }
        }
    }

    // Remove unused modules
    prune_graph();

    // Sort the modules using their dependencies as constrains
    sort_graph();

    // Validate the graph
    validate();

    // Count the real number of dimension needed for the integration.
    // For that, we use the virtual `cuba` module and count the number of out edges
    // However, we need to be careful here because different modules can share the same dimension, so we need
    // to explicitly check the index of the InputTag to count unique dimensions
    out_edge_iterator_t o, o_end;
    std::tie(o, o_end) = boost::out_edges(vertices.at("cuba"), g);

    std::set<size_t> unique_cuba_indices;
    for (; o != o_end; ++o) {
        const auto& inputTag = g[*o].tag;

        // We only care about phase-space points, not weights
        if (inputTag.parameter != "ps_points")
            continue;

        assert(inputTag.isIndexed());
        unique_cuba_indices.emplace(inputTag.index);
    }

    size_t n_dimensions = unique_cuba_indices.size();

    assert(n_dimensions <= configuration.getNDimensions());

    if (n_dimensions < configuration.getNDimensions()) {
        // A module requesting a new dimension was removed from the computation graph
        // Re-index cuba InputTag in order to ensure continuous indexing
        std::unordered_map<size_t, size_t> new_indices_mapping;
        size_t current_index = 0;
        std::tie(o, o_end) = boost::out_edges(vertices.at("cuba"), g);
        for (; o != o_end; ++o) {
            const auto& module_vertex = g[boost::target(*o, g)];

            for (const auto& input: module_vertex.def.inputs) {

                // Get the inputs tags
                momemta::gtl::optional<std::vector<InputTag>> inputTags =
                        momemta::getInputTagsForInput(input, *module_vertex.decl.parameters);

                // If the input is optional, we may not have anything
                if (! inputTags)
                    continue;

                bool update_decl = false;
                std::vector<InputTag> updatedInputTags;
                for (const auto& inputTag: *inputTags) {

                    auto updatedInputTag = inputTag;

                    // TODO: find a better way than hardcoding the values
                    if (inputTag.module == "cuba" && inputTag.parameter == "ps_points") {
                        update_decl = true;
                        // It's a cuba InputTag, re-index it
                        auto it = new_indices_mapping.find(inputTag.index);
                        if (it == new_indices_mapping.end()) {
                            new_indices_mapping.emplace(inputTag.index, current_index);
                            updatedInputTag.index = current_index;
                            current_index++;
                        } else {
                            updatedInputTag.index = it->second;
                        }
                        updatedInputTag.update();
                    }

                    updatedInputTags.push_back(updatedInputTag);
                }

                if (update_decl) {
                    // At least one InputTag has been updated, we need to update the module parameters
                    momemta::setInputTagsForInput(input, *module_vertex.decl.parameters, updatedInputTags);
                }
            }
        }
    }

    // Finally, everything is setup. Create the final computation graph
    const auto& execution_paths = configuration.getPaths();

    std::shared_ptr<ComputationGraph> computationGraph(new ComputationGraph());
    computationGraph->setNDimensions(n_dimensions);
        
    for (auto vertex: sorted_vertices) {
        // Find in which execution path this module is. If it's not found inside any execution path
        // declared in the configuration, then the module is assigned to the default execution path.
        auto find_module_in_path = [&vertex, this](std::shared_ptr<ExecutionPath> p) -> bool {
            // Returns true if the module is inside the execution path `p`, False otherwise
            auto it = std::find_if(p->elements.begin(), p->elements.end(),
                                   [&vertex, this](const std::string& element) -> bool {
                                       return g[vertex].name == element;
                                   }
            );

            return it != p->elements.end();
        };
    
        auto execution_path_it = std::find_if(execution_paths.begin(), execution_paths.end(), find_module_in_path);
        auto execution_path = execution_path_it == execution_paths.end() ? DEFAULT_EXECUTION_PATH :
                              (*execution_path_it)->id;

        // The first declared path must always be the default one, otherwise we are in trouble
        assert(!computationGraph->getPaths().empty() || execution_path == DEFAULT_EXECUTION_PATH);

        computationGraph->addDecl(execution_path, g[vertex].decl);
    }

    return computationGraph;
}

void ComputationGraphBuilder::prune_graph() {

    // Find all vertices not connected to something and remove them
    for (auto it = vertices.begin(), ite = vertices.end(); it != ite;) {
        if (boost::out_degree(it->second, g) == 0) {

            auto& vertex = g[it->second];

            // Don't consider internal or sticky modules
            if (vertex.def.internal || vertex.def.sticky) {
                ++it;
                continue;
            }

            // Otherwise, remove it
            LOG(info) << "Module '" << it->first << "' output is not used by any other module. Removing it from the configuration.";
            boost::clear_vertex(it->second, g);
            boost::remove_vertex(it->second, g);

            it = vertices.erase(it);
        } else
            ++it;
    }

    // Ensure ids are continuous
    uint32_t id = 0;
    typename boost::graph_traits<Graph>::vertex_iterator vtx_it, vtx_it_end;
    for (std::tie(vtx_it, vtx_it_end) = boost::vertices(g); vtx_it != vtx_it_end; vtx_it++) {
        g[*vtx_it].id = id++;
    }
}

void ComputationGraphBuilder::sort_graph() {
    const std::vector<std::shared_ptr<ExecutionPath>>& execution_paths = configuration.getPaths();

    try {
        boost::topological_sort(g, std::front_inserter(sorted_vertices),
                                boost::vertex_index_map(boost::get(&Vertex::id, g)));
    } catch (...) {
        exportGraph("graph.debug");
        LOG(fatal) << "Exception while sorting the graph. Graphviz representation saved as graph.debug";
        throw;
    }

    // Remove vertices corresponding to internal modules
    sorted_vertices.erase(std::remove_if(sorted_vertices.begin(), sorted_vertices.end(),
                                         [this](const vertex_t& vertex) -> bool {
                                             return g[vertex].def.internal;
                                         }), sorted_vertices.end());
}

void ComputationGraphBuilder::validate() {

    auto log_and_throw_unresolved_input = [](const std::string& module_name, const InputTag& input) {
        LOG(fatal) << "Module '" << module_name << "' requested a non-existing input (" << input.toString() << ")";
        throw unresolved_input("Module '" + module_name + "' requested a non-existing input (" + input.toString() + ")");
    };

    // Find any module whose input point to a non-existing module / parameter
    for (auto it = vertices.begin(), ite = vertices.end(); it != ite; it++) {

        const auto& vertex = g[it->second];
        // Ignore internal module (?)
        if (vertex.def.internal)
            continue;

        const auto& inputs = vertex.def.inputs;

        for (const auto& input_def: inputs) {

            // Get the InputTag for this input
            momemta::gtl::optional<std::vector<InputTag>> inputTags =
                    momemta::getInputTagsForInput(input_def, *vertex.decl.parameters);

            if (! inputTags)
                continue;

            // Ensure that every input tags point to an existing module
            for (const auto& inputTag: *inputTags) {
                auto target_it = vertices.find(inputTag.module);

                if (target_it == vertices.end()) {
                    // Non-existing module
                    log_and_throw_unresolved_input(it->first, inputTag);
                }


                // Look for input in module's output
                const auto& target_module_outputs = g[target_it->second].def.outputs;
                auto output_it = std::find_if(target_module_outputs.begin(),
                                             target_module_outputs.end(),
                                             [&inputTag](const ArgDef& output) {
                                                 return inputTag.parameter == output.name;
                                             });

                if (output_it == target_module_outputs.end()) {
                    // Non-existing parameter
                    log_and_throw_unresolved_input(it->first, inputTag);
                }
            }
        }
    }

    // Ensure all the modules using a Looper output are present in the looper path
    std::map<vertex_t, std::vector<vertex_t>> modules_not_in_path;
    for (const auto& vertex: sorted_vertices) {
        if (g[vertex].type == "Looper") {

            const auto& decl = g[vertex].decl;

            out_edge_iterator_t e, e_end;
            std::tie(e, e_end) = boost::out_edges(vertex, g);

            // Iterator over all edges connected to this Looper vertex
            for (; e != e_end; ++e) {
                auto target = boost::target(*e, g);

                // Check if target is inside the looper path
                if (! checkInPath(decl, g[target].name)) {
                    auto& loopers = modules_not_in_path[target];
                    auto it = std::find(loopers.begin(), loopers.end(), vertex);
                    if (it == loopers.end())
                        loopers.push_back(vertex);
                } else {
                    modules_not_in_path.erase(target);
                }
            }
        }
    }

    if (modules_not_in_path.size() != 0) {
        // Only print a message for the first module not in path
        auto it = modules_not_in_path.begin();

        auto target = g[it->first];

        std::stringstream loopers;
        for (size_t i = 0; i < it->second.size(); i++) {
            loopers << "'" << g[it->second[i]].name << "'";
            if (i != it->second.size() - 1)
                loopers << ", ";
        }

        std::string plural = it->second.size() > 1? "s" : "";
        std::string one_of_the = it->second.size() > 1 ? "one of the" : "the";

        LOG(fatal) << "Module '" << target.name << "' is configured to use Looper " << loopers.str()
                   << " output" << plural << ", but is not actually part of the Looper" << plural << " execution path. This will lead to undefined "
                   << "behavior. You can fix the issue by adding the module '"
                   << target.name
                   << "' to " << one_of_the << " Looper" << plural << " execution path";

        throw incomplete_looper_path("A module is using the looper output but not actually part of its "
                                             "execution path");
    }
}

/*
 * Graphviz export
 */

class graph_writer {
public:
    graph_writer(Graph g,
                 const std::vector<std::shared_ptr<ExecutionPath>>& paths):
            graph(g), paths(paths) {}


    // Vertex writer
    void writeVertex(std::ostream& out, const vertex_t& v) const {
        std::string shape = "ellipse";
        std::string color = "black";
        std::string style = "solid";
        std::string extra = "";

        if (graph[v].def.internal) {
            shape = "rectangle";
            color = "black";
            style = "dashed";
        }

        if (graph[v].type == "Looper") {
            style = "filled";
            extra = "fillcolor=\"" + path_colors.at(graph[v].decl.parameters->get<ExecutionPath>("path").id) + "\"";
        }

        out << "[shape=\"" << shape << "\",color=\"" << color << "\",style=\"" << style
            << "\",label=\"" << graph[v].name << "\"";

        if (!extra.empty()) {
            out << "," << extra;
        }

        out << "]";
    }

    // Edge writer
    void writeEdge(std::ostream& out, const edge_t& e) const {
        std::string color = "black";
        std::string style = "solid";
        std::string extra = "";

        if (graph[e].virt) {
            style = "invis";
            extra = "constraint=false";
        }

        out << "[color=\"" << color << "\",style=\"" << style
            << "\",label=\"" << graph[e].description << "\"";

        if (!extra.empty()) {
            out << "," << extra;
        }

        out << "]";
    }

    // Graph writer
    void writeGraph(std::ostream& out) const {

        size_t index = 0;
        size_t color_index = 0;
        for (const auto& path: paths) {

            out << "subgraph cluster_" << index << " {" << std::endl;

            out << R"(style=filled; fillcolor=")" << colors[color_index] << R"(";)" << std::endl;
            path_colors.emplace(path->id, colors[color_index]);

            auto looper_vertex = find_looper(path->id);

            if (looper_vertex != boost::graph_traits<Graph>::null_vertex())
                out << "    label=\"" << graph[looper_vertex].name << " execution path\";" << std::endl;

            out << "    ";
            for (const auto& e: path->elements) {
                auto vertex = find_vertex(e);
                if (vertex != boost::graph_traits<Graph>::null_vertex())
                    out << graph[vertex].id << "; ";
            }

            out << std::endl;
            out << "}" << std::endl;

            index++;
            color_index++;
            if (color_index >= colors.size())
                color_index = 0;
        }
    }

private:
    vertex_t find_vertex(const std::string& name) const {
        typename boost::graph_traits<Graph>::vertex_iterator vtx_it, vtx_it_end;

        for(boost::tie(vtx_it, vtx_it_end) = boost::vertices(graph); vtx_it != vtx_it_end; ++vtx_it) {
            if (graph[*vtx_it].name == name)
                return *vtx_it;
        }

        return boost::graph_traits<Graph>::null_vertex();
    }

    vertex_t find_looper(const uuid& path) const {
        typename boost::graph_traits<Graph>::vertex_iterator vtx_it, vtx_it_end;

        for(boost::tie(vtx_it, vtx_it_end) = boost::vertices(graph); vtx_it != vtx_it_end; ++vtx_it) {
            if (graph[*vtx_it].type == "Looper") {
                const auto& looper_path = graph[*vtx_it].decl.parameters->get<ExecutionPath>("path");
                if (looper_path.id == path)
                    return *vtx_it;
            }
        }

        return boost::graph_traits<Graph>::null_vertex();
    }

    Graph graph;
    const std::vector<std::shared_ptr<ExecutionPath>> paths;

    mutable std::unordered_map<uuid, std::string,
                               boost::hash<uuid>> path_colors;

    const std::array<std::string, 5> colors = {{
                                                       "#BEEB9F",
                                                       "#ACF0F2",
                                                       "#F3FFE2",
                                                       "#79BD8F88",
                                                       "##EB7F0099"
                                               }};
};

class graph_writer_wrapper {
public:
    graph_writer_wrapper(std::shared_ptr<graph_writer> writer):
            writer(writer) {}

    void operator()(std::ostream& out, const vertex_t& v) const {
        writer->writeVertex(out, v);
    }

    void operator()(std::ostream& out, const edge_t& e) const {
        writer->writeEdge(out, e);
    }

    void operator()(std::ostream& out) const {
        writer->writeGraph(out);
    }

private:
    std::shared_ptr<graph_writer> writer;
};

void graphviz_export(const Graph& g,
                     const std::vector<std::shared_ptr<ExecutionPath>>& paths,
                     const std::string& filename) {

    std::ofstream f(filename.c_str());
    auto writer = std::make_shared<graph_writer>(g, paths);
    boost::write_graphviz(f, g, graph_writer_wrapper(writer), graph_writer_wrapper(writer),
                          graph_writer_wrapper(writer), boost::get(&Vertex::id, g));
}

void ComputationGraphBuilder::exportGraph(const std::string& output) const {
    if (! graph_exportable)
        return;

    graphviz_export(g, configuration.getPaths(), output);
}

}