src/parser/meta_ref.cc

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

/*!
 * \file src/parser/meta_ref.cc
 * \brief An operator which allows forward referencing a yet-to-be parsed meta table reference.
 */

#include "./meta_ref.h"

#include <tvm/relay/expr_functor.h>
#include <tvm/relay/op.h>
#include <tvm/relay/op_attr_types.h>
#include <tvm/relay/transform.h>

namespace tvm {
namespace parser {

using tvm::relay::transform::CreateFunctionPass;
using tvm::transform::PassContext;

/* Set to arbitrary high number, since we should never schedule in normal pass manager flow. */
static int kMetaExpandOptLevel = 1337;

TVM_REGISTER_NODE_TYPE(MetaRefAttrs);

bool MetaRefRel(const Array<Type>& types, int num_inputs, const Attrs& attrs,
                const TypeReporter& reporter) {
  LOG(FATAL) << "need to expand before type checking";
  return true;
}

RELAY_REGISTER_OP("parser.MetaRef")
    .describe(R"code(A reference into the meta table.)code" TVM_ADD_FILELINE)
    .set_attrs_type<MetaRefAttrs>()
    .set_num_inputs(0)
    .set_support_level(10)
    .add_type_rel("MetaRef", MetaRefRel)
    .set_attr<TOpIsStateful>("TOpIsStateful", false)
    .set_attr<TNonComputational>("TNonComputational", true);

Expr MetaRef(std::string type_key, uint64_t node_index) {
  static const Op& op = Op::Get("parser.MetaRef");
  auto attrs = make_object<MetaRefAttrs>();
  attrs->node_type_key = tvm::String(type_key);
  attrs->node_index = node_index;
  return Call(op, {}, Attrs(attrs), {});
}

struct MetaRefExpander : public ExprMutator {
  MetaTable table;

  explicit MetaRefExpander(const MetaTable& table) : table(table) {}

  Expr VisitExpr_(const CallNode* call) final {
    if (auto op_node = call->op.as<OpNode>()) {
      if (op_node->name == "parser.MetaRef") {
        auto meta_attrs = call->attrs.as<MetaRefAttrs>();
        CHECK(meta_attrs) << "an internal error has occurred";
        auto nodes = table.at(meta_attrs->node_type_key);
        CHECK_LT(meta_attrs->node_index, nodes.size());
        return Downcast<Expr>(nodes[meta_attrs->node_index]);
      }
    }

    return ExprMutator::VisitExpr_(call);
  }
};

Function ExpandMetaRefs(const MetaTable& meta_table, const relay::Function& func) {
  MetaRefExpander expander(meta_table);
  return Downcast<Function>(expander.VisitExpr(func));
}

IRModule ExpandMetaRefs(const MetaTable& meta_table, const IRModule& mod) {
  auto pass = CreateFunctionPass([&](Function func, IRModule module,
                                     PassContext ctx) { return ExpandMetaRefs(meta_table, func); },
                                 kMetaExpandOptLevel, "ExpandMetaRefs", {});

  return pass(mod, PassContext::Create());
}

}  // namespace parser
}  // namespace tvm