block_builder.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef TVM_RELAX_BLOCK_BUILDER_H_
#define TVM_RELAX_BLOCK_BUILDER_H_
 
#include <tvm/arith/analyzer.h>
#include <tvm/ir/name_supply.h>
#include <tvm/relax/expr.h>
#include <tvm/relax/utils.h>
#include <tvm/runtime/object.h>
 
namespace tvm {
namespace relax {
 
class BlockBuilderNode : public Object {
 public:
  //-------------------------------
  // Global Context management
  //-------------------------------
  virtual NameSupply name_supply() = 0;
 
  virtual IRModule GetContextIRModule() const = 0;
 
  virtual IRModule Finalize() = 0;
 
  virtual GlobalVar AddFunction(const BaseFunc& func, String func_name_hint) = 0;
 
  virtual void UpdateFunction(const GlobalVar& gv, BaseFunc function) = 0;
 
  [[noreturn]] virtual void ReportFatal(const Diagnostic& diagnostic) = 0;
 
  //-------------------------------
  // Scope management
  //-------------------------------
  virtual Optional<Expr> LookupBinding(const Var& var) = 0;
 
  virtual void BeginScope(Optional<Array<Var>> params) = 0;
 
  virtual void BeginInnerScope() = 0;
 
  virtual void AddDefinitionToScope(Var var) = 0;
 
  virtual void EndScope() = 0;
 
  virtual void BeginDataflowBlock() = 0;
 
  virtual void BeginBindingBlock() = 0;
  virtual BindingBlock EndBlock() = 0;
 
  virtual bool CurrentBlockIsDataFlow() = 0;
 
  virtual Var Emit(Expr expr, String name_hint = "") = 0;
 
  virtual Var EmitMatchCast(Expr value, StructInfo struct_info, String name_hint = "") = 0;
 
  virtual Var EmitOutput(Expr output, String name_hint = "") = 0;
 
  virtual void EmitNormalized(Binding normalized_binding) = 0;
 
  virtual Expr Normalize(const Expr& expr) = 0;
 
  virtual Expr NormalizeArgument(const Expr& expr) = 0;
 
  virtual arith::Analyzer* GetAnalyzer() = 0;
 
  static constexpr const uint32_t _type_index = TypeIndex::kDynamic;
  static constexpr const char* _type_key = "relax.BlockBuilder";
  TVM_DECLARE_BASE_OBJECT_INFO(BlockBuilderNode, Object);
};
 
class BlockBuilder : public ObjectRef {
 public:
  TVM_DLL static BlockBuilder Create(Optional<IRModule> ctx_mod);
 
  struct DisableOperatorSpecificNormalizationForTVMScript {
    explicit DisableOperatorSpecificNormalizationForTVMScript() = default;  // NOLINT(*)
  };
  TVM_DLL static BlockBuilder Create(Optional<IRModule> ctx_mod,
                                     DisableOperatorSpecificNormalizationForTVMScript tag);
 
  TVM_DEFINE_MUTABLE_OBJECT_REF_METHODS(BlockBuilder, ObjectRef, BlockBuilderNode);
};
 
}  // namespace relax
}  // namespace tvm
 
#endif  // TVM_RELAX_BLOCK_BUILDER_H_