path: root/tensorflow/core/grappler/grappler_item_builder.cc

/* Copyright 2017 The TensorFlow 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 "tensorflow/core/grappler/grappler_item_builder.h"

#include <unordered_map>
#include <unordered_set>
#include <vector>

#include "tensorflow/core/common_runtime/function.h"
#include "tensorflow/core/framework/attr_value.pb.h"
#include "tensorflow/core/framework/function.h"
#include "tensorflow/core/framework/function.pb.h"
#include "tensorflow/core/framework/node_def.pb.h"
#include "tensorflow/core/framework/op.h"
#include "tensorflow/core/framework/op_def.pb.h"
#include "tensorflow/core/framework/types.pb.h"
#include "tensorflow/core/framework/variable.pb.h"
#include "tensorflow/core/graph/graph_constructor.h"
#include "tensorflow/core/grappler/inputs/utils.h"
#include "tensorflow/core/grappler/op_types.h"
#include "tensorflow/core/grappler/utils.h"
#include "tensorflow/core/protobuf/meta_graph.pb.h"

namespace tensorflow {
namespace grappler {

namespace {
void InitializeTensor(DataType type, Tensor* tensor) {
  const int period = 7;
  if (type == DT_FLOAT) {
    auto flat = tensor->flat<float>();
    // Populate numbers 0, 0.1, 0.2, ..., 0.5, 0.6, 0, 0.1, 0.2, ...
    for (int i = 0; i < flat.size(); i++) {
      flat(i) = static_cast<float>(i % period) / 10.0f;
    }
  } else if (type == DT_INT64) {
    auto flat = tensor->flat<int64>();
    // Populate numbers 0, 1, 2, ..., 5, 6, 0, 1, 2, ...
    for (int i = 0; i < flat.size(); i++) {
      flat(i) = i % period;
    }
  } else {
    memset(const_cast<char*>(tensor->tensor_data().data()), 0,
           tensor->tensor_data().size());
  }
}

// Helper function that returns a bool indicating if there are function
// call nodes in graph.
bool HasFunctionInGraph(const Graph& graph) {
  for (const Node* n : graph.nodes()) {
    if (graph.flib_def().Find(n->type_string()) != nullptr) {
      return true;
    }
  }
  return false;
}

// Wrapper around FunctionDefToBodyHelper that creates a FunctionBody
// for function_def.
Status CreateFunctionBody(const FunctionLibraryDefinition& function_library,
                          const FunctionDef& function_def,
                          const NodeDef& node_def,
                          FunctionBody** function_body) {
  std::function<Status(const string&, const OpDef**)> get_function_signature =
      [&function_library](const string& name, const OpDef** signature) {
        return function_library.LookUpOpDef(name, signature);
      };
  TF_RETURN_IF_ERROR(FunctionDefToBodyHelper(
      function_def, AttrSlice(node_def), &function_library,
      get_function_signature, function_body));
  return Status::OK();
}

// Inlines all functions in a Graph.  Does not recursively inline, so if graph
// contains Function A that calls Function B, calling InlineFunctions once will
// produce a graph with A inlined but not B.  Calling InlineFunctions a second
// time will produce a graph with both A and B inlined.
Status InlineFunctions(Graph* graph) {
  const FunctionLibraryDefinition& function_library = graph->flib_def();
  std::vector<std::pair<Node*, FunctionBody*>> nodes_and_funcs_to_inline;
  std::unordered_map<string, std::unique_ptr<FunctionBody>>
      function_name_to_body;
  std::function<Status(const string&, const OpDef**)> get_function_signature =
      [&function_library](const string& name, const OpDef** signature) {
        return function_library.LookUpOpDef(name, signature);
      };

  for (Node* node : graph->nodes()) {
    const FunctionDef* function_def =
        function_library.Find(node->type_string());
    if (!function_def) {
      // Not a function node.
      continue;
    }
    FunctionBody* function_body = nullptr;
    const string key = Canonicalize(node->def().op(), AttrSlice(node->def()));
    if (function_name_to_body.find(key) == function_name_to_body.end()) {
      TF_RETURN_IF_ERROR(CreateFunctionBody(function_library, *function_def,
                                            node->def(), &function_body));
      function_name_to_body.emplace(
          key, std::unique_ptr<FunctionBody>(function_body));
    }
    function_body = function_name_to_body[key].get();
    if (function_body) {
      nodes_and_funcs_to_inline.emplace_back(node, function_body);
    }
  }

  for (const auto& iter : nodes_and_funcs_to_inline) {
    InlineFunctionBody(function_library, graph, iter.first, iter.second);
  }
  return Status::OK();
}

// Sets *inlined_graph to be graph with all function NodeDefs in graph inlined.
// Recursively inlines, so if graph contains Function A that calls Function B,
// calling InlineAllFunctions once will produce a graph with both A and B
// inlined.
Status InlineAllFunctions(const GraphDef& graph_def,
                          GraphDef* inlined_graph_def) {
  *inlined_graph_def = GraphDef::default_instance();
  // Create a Graph from graph_def. Inlining needs to happen
  // on a single Graph object in order to guarantee unique
  // names of nodes created during the inlining process.
  GraphConstructorOptions graph_ctor_opts;
  graph_ctor_opts.allow_internal_ops = true;
  graph_ctor_opts.expect_device_spec = false;
  FunctionLibraryDefinition function_library(OpRegistry::Global(),
                                             graph_def.library());
  Graph inlined_graph(function_library);
  TF_RETURN_IF_ERROR(
      ConvertGraphDefToGraph(graph_ctor_opts, graph_def, &inlined_graph));
  while (HasFunctionInGraph(inlined_graph)) {
    TF_RETURN_IF_ERROR(InlineFunctions(&inlined_graph));
  }
  inlined_graph.ToGraphDef(inlined_graph_def);
  return Status::OK();
}
}  // namespace

// static
std::unique_ptr<GrapplerItem> GrapplerItemFromMetaGraphDef(
    const string& id, const MetaGraphDef& meta_graph, const ItemConfig& cfg) {
  if (id.empty()) {
    LOG(ERROR) << "id must be non-empty.";
    return nullptr;
  }
  std::unique_ptr<GrapplerItem> new_item(new GrapplerItem());
  new_item->id = id;
  new_item->graph = meta_graph.graph_def();

  if (cfg.inline_functions) {
    Status s = InlineAllFunctions(meta_graph.graph_def(), &new_item->graph);
    if (!s.ok()) {
      LOG(ERROR) << "Unable to inline functions: " << s.error_message()
                 << ", skipping this input.";
      return nullptr;
    }
  }

  // Attempt to detect the fetch node(s).
  if (meta_graph.collection_def().count("train_op") > 0) {
    const CollectionDef& nodes = meta_graph.collection_def().at("train_op");
    if (nodes.has_node_list()) {
      for (const auto& node : nodes.node_list().value()) {
        const string name = NodeName(node);
        if (name.empty()) {
          LOG(ERROR) << "Invalid fetch node name " << node
                     << ", skipping this input";
          return nullptr;
        }
        LOG(INFO) << "Will use fetch node " << name;
        new_item->fetch.push_back(name);
      }
    }
  }
  if (new_item->fetch.empty()) {
    LOG(ERROR) << "Failed to detect the fetch node(s), skipping this input";
    return nullptr;
  }

  for (auto& node : *new_item->graph.mutable_node()) {
    if (IsPlaceholder(node)) {
      if (node.attr().count("dtype") == 0) {
        LOG(ERROR) << "Unknown type for placeholder " << node.name()
                   << ", skipping this input";
        return nullptr;
      }
      DataType type = node.attr().at("dtype").type();

      if (node.attr().count("shape") == 0) {
        LOG(INFO) << "Unknown shape for placeholder " << node.name()
                  << ", skipping this input";
        return nullptr;
      }
      TensorShape shape(node.attr().at("shape").shape());
      // Some placeholder nodes have a mis-match between the node
      // attribute "shape" and a different node attribute "_output_shapes".
      // Specifically, a shape with shape.dims() == 0 could indicate either
      // a scalar or an unknown shape. In those cases, we check _output_shapes
      // for additional information.
      // This case is observed in the bnmt graphs. Have not observed any
      // cases where there was more than 1 _output_shapes, so limit it
      // to cases where there is only 1 _output_shapes.
      // We only do this if cfg.placeholder_unknown_output_shape_dim has
      // been set to avoid crashing non-BNMT graphs.
      if ((cfg.placeholder_unknown_output_shape_dim >= 0) &&
          (shape.dims() == 0) && (node.attr().count("_output_shapes") == 1) &&
          (node.attr().at("_output_shapes").list().shape(0).dim_size() != 0)) {
        shape.Clear();
        for (int dim_i = 0;
             dim_i <
             node.attr().at("_output_shapes").list().shape(0).dim_size();
             dim_i++) {
          const ::tensorflow::TensorShapeProto_Dim dim =
              node.attr().at("_output_shapes").list().shape(0).dim(dim_i);
          if (dim.size() == -1) {
            shape.AddDim(cfg.placeholder_unknown_output_shape_dim);
          } else {
            shape.AddDim(node.attr()
                             .at("_output_shapes")
                             .list()
                             .shape(0)
                             .dim(dim_i)
                             .size());
          }
        }
      }
      Tensor fake_input(type, shape);
      InitializeTensor(type, &fake_input);
      new_item->feed.emplace_back(node.name(), fake_input);
    }

    // Delete user specified placement if requested.
    if (cfg.ignore_user_placement) {
      node.clear_device();
    }
    // Delete colocation constraints if requested.
    if (cfg.ignore_colocation) {
      auto attr = node.mutable_attr();
      auto it = attr->find("_class");
      if (it != attr->end()) {
        attr->erase(it);
      }
    }
  }

  for (const string& var_collection :
       {"variables", "local_variables", "model_variables",
        "trainable_variables"}) {
    if (meta_graph.collection_def().count(var_collection) == 0) {
      continue;
    }
    const CollectionDef& vars = meta_graph.collection_def().at(var_collection);
    for (const auto& raw_var : vars.bytes_list().value()) {
      VariableDef var;
      var.ParseFromString(raw_var);
      if (!var.initializer_name().empty()) {
        new_item->init_ops.push_back(var.initializer_name());
      }
    }
  }

  if (meta_graph.collection_def().count("table_initializer") > 0) {
    const CollectionDef& inits =
        meta_graph.collection_def().at("table_initializer");
    if (inits.has_node_list()) {
      for (const auto& node : inits.node_list().value()) {
        new_item->init_ops.push_back(node);
        // Tables are initialized from files, which can take a long time. Add 30
        // minutes to the initialization time for each table to avoid timing
        // out.
        // TODO(bsteiner): adjust the timeout based on the file size.
        new_item->expected_init_time += 30 * 60;
      }
    }
  }

  if (meta_graph.collection_def().count("queue_runners") > 0) {
    const CollectionDef& vars = meta_graph.collection_def().at("queue_runners");
    for (const auto& raw : vars.bytes_list().value()) {
      QueueRunnerDef queue_runner;
      if (!queue_runner.ParseFromString(raw)) {
        LOG(ERROR) << "Could parse queue_runners, skipping this input";
        return nullptr;
      }
      if (queue_runner.cancel_op_name().empty()) {
        LOG(ERROR) << "Queue without a cancel op, skipping this input";
        return nullptr;
      }
      new_item->queue_runners.push_back(queue_runner);
    }
  }

  // Make sure we still can access the input files (aka "asset_filepaths") since
  // these might have been moved or deleted, the cns cell might have been shut
  // down, or we might be running as a user who does not have access to the
  // files.
  if (meta_graph.collection_def().count("asset_filepaths") > 0) {
    const CollectionDef& file_paths =
        meta_graph.collection_def().at("asset_filepaths");
    std::vector<string> paths;
    for (const auto& raw_path : file_paths.bytes_list().value()) {
      paths.push_back(raw_path);
    }
    if (!FilesExist(paths, nullptr)) {
      LOG(ERROR)
          << "Can't access one or more of the asset files, skipping this input";
      return nullptr;
    }
  }

  return new_item;
}

}  // end namespace grappler
}  // end namespace tensorflow