graph_viz_pass.cc

/* Copyright (c) 2018 PaddlePaddle Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

#include "paddle/fluid/framework/ir/graph_viz_pass.h"

#include <fstream>
#include <ostream>
#include <string>

#include "paddle/fluid/framework/ir/graph_helper.h"
#include "paddle/fluid/framework/ir/graph_printer.h"
#include "paddle/fluid/framework/op_proto_maker.h"
#include "paddle/fluid/framework/program_desc.h"
#include "paddle/fluid/inference/analysis/dot.h"
#include "paddle/fluid/inference/analysis/helper.h"

namespace paddle {
namespace framework {
namespace ir {
using inference::analysis::Dot;
namespace {
std::string FormatName(const Node* node) {
  if (!node->IsOp() || !node->Op() ||
      !node->Op()->HasAttr(OpProtoAndCheckerMaker::OpNamescopeAttrName())) {
    return node->Name();
  }
  const std::string full_scope = PADDLE_GET_CONST(
      std::string,
      node->Op()->GetAttr(OpProtoAndCheckerMaker::OpNamescopeAttrName()));
  return string::Sprintf("%s%s", full_scope.c_str(), node->Name().c_str());
}
}  // namespace

void GraphVizPass::ApplyImpl(ir::Graph* graph) const {
  std::string optim_cache_dir;
  if (Has("optim_cache_dir")) {
    optim_cache_dir = Get<std::string>("optim_cache_dir");
    if (!optim_cache_dir.empty()) {
      paddle::inference::analysis::MakeDirIfNotExists(optim_cache_dir);
    }
  }
  const std::string& graph_viz_path = Get<std::string>(kGraphvizPath);
  VLOG(3) << "draw IR graph viz to " << graph_viz_path;
  std::unique_ptr<std::ostream> fout(new std::ofstream(graph_viz_path));
  PADDLE_ENFORCE_EQ(
      fout->good(),
      true,
      platform::errors::Unavailable(
          "Can not open file %s for printing the graph.", graph_viz_path));
  std::ostream& sout = *fout;

  // serialize only model file.
  std::string program_path;
  std::size_t found1 = graph_viz_path.find("_ir_");
  std::size_t found2 = graph_viz_path.find(".dot");
  if (found1 != std::string::npos && found2 != std::string::npos) {
    ProgramDesc program_desc;
    GraphToProgram(*graph, &program_desc);
    // TODO(wilber): GraphToProgram seems have bugs.
    for (size_t i = 0; i < program_desc.Size(); ++i) {
      for (size_t j = 0; j < program_desc.Block(i).OpSize(); ++j) {
        if (program_desc.Block(i).Op(j)->Type() == "tensorrt_engine") {
          program_desc.Block(i).Op(j)->RemoveAttr("sub_block");
        }
      }
    }
    std::string program_bytes = program_desc.Proto()->SerializeAsString();
    // rename from "17_ir_fc_fuse_pass.dot" to "fc_fuse_pass.pdmodel"
    program_path =
        graph_viz_path.substr(found1 + 4, found2 - found1 - 4) + ".pdmodel";
    if (!optim_cache_dir.empty()) {
      program_path = optim_cache_dir + "/" + program_path;
    }
    std::ofstream file(program_path.c_str(), std::ios::binary);
    file.write(program_bytes.c_str(), program_bytes.size());
    file.close();
    VLOG(3) << "serialize program to " << program_path;
  }

  std::unordered_map<const ir::Node*, std::string> node2dot;

  Dot dot;

  const std::vector<Dot::Attr> op_attrs({
      Dot::Attr("style", "rounded,filled,bold"),  //
      Dot::Attr("shape", "box"),                  //
      Dot::Attr("color", "#303A3A"),              //
      Dot::Attr("fontcolor", "#ffffff"),          //
      Dot::Attr("width", "1.3"),                  //
      Dot::Attr("height", "0.84"),                //
      Dot::Attr("fontname", "Arial"),             //
  });
  const std::vector<Dot::Attr> arg_attrs({
      Dot::Attr("shape", "box"),                  //
      Dot::Attr("style", "rounded,filled,bold"),  //
      Dot::Attr("fontname", "Arial"),             //
      Dot::Attr("fillcolor", "#999999"),          //
      Dot::Attr("color", "#dddddd"),              //
  });

  const std::vector<Dot::Attr> param_attrs({
      Dot::Attr("shape", "box"),                  //
      Dot::Attr("style", "rounded,filled,bold"),  //
      Dot::Attr("fontname", "Arial"),             //
      Dot::Attr("color", "#148b97"),              //
      Dot::Attr("fontcolor", "#ffffff"),          //
  });

  const std::vector<Dot::Attr> marked_op_attrs(
      {Dot::Attr("style", "rounded,filled,bold"),
       Dot::Attr("shape", "box"),
       Dot::Attr("fillcolor", "yellow")});
  const std::vector<Dot::Attr> marked_var_attrs(
      {Dot::Attr("style", "filled,rounded"),
       Dot::Attr("shape", "box"),
       Dot::Attr("fillcolor", "yellow")});

  auto marked_nodes = ConsumeMarkedNodes(graph);
  // Create nodes
  for (const Node* n : graph->Nodes()) {
    std::string node_id = FormatName(n) + "(" + std::to_string(n->id()) + ")";
    if (n->IsOp()) {
      decltype(op_attrs) attr =
          marked_nodes.count(n) ? marked_op_attrs : op_attrs;
      dot.AddNode(node_id, attr, node_id);
    } else if (n->IsVar()) {
      if (n->Var() && n->Var()->GetType() == proto::VarType::LOD_TENSOR) {
        bool is_first = true;
        for (int64_t length : n->Var()->GetShape()) {
          if (is_first) {
            node_id += "\n" + std::to_string(length);
            is_first = false;
          } else {
            node_id += "," + std::to_string(length);
          }
        }
      }
      decltype(op_attrs)* attr;
      if (marked_nodes.count(n)) {
        attr = &marked_var_attrs;
      } else if (const_cast<Node*>(n)->Var() &&
                 const_cast<Node*>(n)->Var()->Persistable()) {
        attr = &param_attrs;
      } else {
        attr = &arg_attrs;
      }

      dot.AddNode(node_id, *attr, node_id);
    }
    node2dot[n] = node_id;
  }
  // Create edges
  for (const Node* n : graph->Nodes()) {
    const auto& src_id = node2dot.at(n);
    for (auto* out : n->outputs) {
      const auto& trg_id = node2dot.at(out);
      dot.AddEdge(src_id, trg_id, {});
    }
  }

  sout << dot.Build();
}

GraphVizPass::marked_nodes_t GraphVizPass::ConsumeMarkedNodes(
    Graph* graph) const {
  marked_nodes_t res;
  if (graph->Has(kGraphvizMarkedNodeAttr)) {
    auto& attr = graph->Get<marked_nodes_t>(kGraphvizMarkedNodeAttr);
    res = attr;
    attr.clear();
  }
  return res;
}

}  // namespace ir
}  // namespace framework
}  // namespace paddle

REGISTER_PASS(graph_viz_pass, paddle::framework::ir::GraphVizPass)
    .RequirePassAttr(paddle::framework::ir::kGraphvizPath);