executable.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_RUNTIME_VM_EXECUTABLE_H_
#define TVM_RUNTIME_VM_EXECUTABLE_H_
 
#include <tvm/ffi/function.h>
#include <tvm/runtime/module.h>
#include <tvm/runtime/object.h>
#include <tvm/support/io.h>
#include <tvm/support/serializer.h>
 
#include <string>
#include <unordered_map>
#include <vector>
 
#include "./bytecode.h"
 
// Convention: this version should set to minimum TVM version it support
// NOTE: this file only changes if we change relax vm format
// for example if relax vm format do not change in 0.15, this should remain as 0.14
// if it changes in 0.16, we will change it to 0.16
#define VM_VERSION "0.14"
 
namespace tvm {
namespace runtime {
namespace vm {
 
struct VMFuncInfo {
  enum class FuncKind : int {
    kPackedFunc = 0,
    kVMFunc = 1,
    kVMTIRFunc = 2,
  };
  FuncKind kind;
  std::string name;
  Index start_instr = 0;
  Index end_instr = 0;
  Index num_args = 0;
  Index register_file_size = 0;
  std::vector<std::string> param_names;
 
  // defined customized loader save
  void Save(support::Stream* writer) const;
  bool Load(support::Stream* reader);
};
 
class VMExecutable : public ffi::ModuleObj {
 public:
  int GetPropertyMask() const final { return ffi::Module::kBinarySerializable; };
 
  std::string Stats() const;
  Instruction GetInstruction(Index i) const;
  void SetInstructionData(Index i, Index j, ExecWord val);
  ffi::String AsText() const;
  ffi::String AsPython() const;
  ffi::Bytes SaveToBytes() const final;
  static ffi::Module LoadFromBytes(const ffi::Bytes& bytes);
  void WriteToFile(const ffi::String& file_name, const ffi::String& format) const final;
  ffi::Module VMLoadExecutable() const;
  ffi::Module VMProfilerLoadExecutable() const;
  bool HasFunction(const ffi::String& name) const;
  static ffi::Module LoadFromFile(const ffi::String& file_name);
 
  std::vector<VMFuncInfo> func_table;
  std::unordered_map<std::string, Index> func_map;
  std::vector<ffi::Any> constants;
  std::unordered_map<Index, std::string> memory_scopes;
  std::vector<Index> instr_offset;
  std::vector<ExecWord> instr_data;
 
  virtual ~VMExecutable() {}
 
  TVM_MODULE_VTABLE_BEGIN("relax.VMExecutable");
  TVM_MODULE_VTABLE_ENTRY("stats", &VMExecutable::Stats);
  TVM_MODULE_VTABLE_ENTRY("as_text", &VMExecutable::AsText);
  TVM_MODULE_VTABLE_ENTRY("as_python", &VMExecutable::AsPython);
  TVM_MODULE_VTABLE_ENTRY("vm_load_executable", &VMExecutable::VMLoadExecutable);
  TVM_MODULE_VTABLE_ENTRY("vm_profiler_load_executable", &VMExecutable::VMProfilerLoadExecutable);
  TVM_MODULE_VTABLE_ENTRY("has_function", &VMExecutable::HasFunction);
  TVM_MODULE_VTABLE_END();
 
 private:
  void SaveGlobalSection(support::Stream* strm) const;
  void SaveMemoryScopeSection(support::Stream* strm) const;
  void SaveConstantSection(support::Stream* strm) const;
  void SaveCodeSection(support::Stream* strm) const;
  void SavePackedFuncNames(support::Stream* strm) const;
  void LoadGlobalSection(support::Stream* strm);
  void LoadMemoryScopeSection(support::Stream* strm);
  void LoadConstantSection(support::Stream* strm);
  void LoadCodeSection(support::Stream* strm);
  void LoadPackedFuncNames(support::Stream* strm);
};
 
}  // namespace vm
}  // namespace runtime
}  // namespace tvm
 
namespace tvm {
namespace support {
template <>
struct Serializer<::tvm::runtime::vm::VMFuncInfo> {
  static constexpr bool enabled = true;
  static void Write(Stream* strm, const ::tvm::runtime::vm::VMFuncInfo& data) { data.Save(strm); }
  static bool Read(Stream* strm, ::tvm::runtime::vm::VMFuncInfo* data) { return data->Load(strm); }
};
}  // namespace support
}  // namespace tvm
#endif  // TVM_RUNTIME_VM_EXECUTABLE_H_