exec_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_EXEC_BUILDER_H_
#define TVM_RELAX_EXEC_BUILDER_H_
 
#include <tvm/ffi/extra/dataclass.h>
#include <tvm/ffi/extra/structural_equal.h>
#include <tvm/ffi/extra/structural_hash.h>
#include <tvm/ffi/function.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/expr.h>
#include <tvm/runtime/vm/bytecode.h>
#include <tvm/runtime/vm/executable.h>
 
#include <string>
#include <unordered_map>
#include <vector>
 
namespace tvm {
namespace relax {
 
namespace vm = tvm::runtime::vm;
 
class ExecBuilder;
 
class ExecBuilderObj : public ffi::Object {
 public:
  void DeclareFunction(const std::string& func, vm::VMFuncInfo::FuncKind kind);
  void EmitFunction(const std::string& func, int64_t num_inputs,
                    ffi::Optional<ffi::Array<ffi::String>> param_names,
                    vm::VMFuncInfo::FuncKind kind = vm::VMFuncInfo::FuncKind::kVMFunc,
                    int64_t init_register_size = 0);
  void EndFunction(const std::string& func);
  void EmitCall(const std::string& func, std::vector<vm::Instruction::Arg> args, vm::RegName ret);
  void EmitCall(vm::Instruction::Arg func, std::vector<vm::Instruction::Arg> args, vm::RegName ret);
  void EmitRet(vm::Instruction::Arg result);
  void EmitGoto(vm::Index pc_offset);
  void EmitIf(vm::Instruction::Arg cond, vm::Index false_offset);
  vm::Instruction::Arg GetFunction(const std::string& name);
  template <typename T>
  vm::Instruction::Arg ConvertConstant(T value) {
    ffi::Any rv;
    rv = value;
    return ConvertConstant_(rv);
  }
  void SaveMemoryScope(vm::Instruction::Arg idx, ffi::String scope);
  vm::VMExecutable* exec() const;
  ffi::ObjectPtr<vm::VMExecutable> Get();
  TVM_DLL static ExecBuilder Create();
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<ExecBuilderObj>();
  }
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("relax.ExecBuilder", ExecBuilderObj, ffi::Object);
 
 private:
  vm::Instruction::Arg ConvertConstant_(ffi::Any obj);
 
  void CheckExecutable();
  void Formalize();
 
  ffi::ObjectPtr<vm::VMExecutable> exec_;  // mutable
  std::unordered_map<ffi::Any, vm::Index, ffi::StructuralHash, ffi::StructuralEqual>
      const_dedup_map_;
};
 
class ExecBuilder : public ffi::ObjectRef {
 public:
  explicit ExecBuilder(ffi::UnsafeInit tag, ffi::ObjectPtr<ExecBuilderObj> n)
      : ffi::ObjectRef(tag) {
    data_ = std::move(n);
  }
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(ExecBuilder, ffi::ObjectRef, ExecBuilderObj);
};
 
}  // namespace relax
}  // namespace tvm
 
#endif  // TVM_RELAX_EXEC_BUILDER_H_