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/runtime/container/map.h>
#include <tvm/runtime/container/string.h>
#include <tvm/runtime/module.h>
#include <tvm/runtime/object.h>
#include <tvm/runtime/packed_func.h>
#include <tvm/runtime/vm/bytecode.h>
 
#include <map>
#include <string>
#include <unordered_map>
#include <utility>
#include <vector>
 
namespace tvm {
namespace runtime {
namespace vm {
 
struct VMFunction;
 
class TVM_DLL Executable : public ModuleNode {
 public:
  TVM_MODULE_VTABLE_BEGIN("VMExecutable");
  TVM_MODULE_VTABLE_ENTRY("get_lib", &Executable::GetLib);
  TVM_MODULE_VTABLE_ENTRY("get_bytecode", &Executable::GetBytecode);
  TVM_MODULE_VTABLE_ENTRY("get_constants", &Executable::GetConstants);
  TVM_MODULE_VTABLE_ENTRY("get_virtual_devices", &Executable::GetVirtualDevices);
  TVM_MODULE_VTABLE_ENTRY("get_primitives", &Executable::GetPrimitives);
  TVM_MODULE_VTABLE_ENTRY("get_stats", &Executable::Stats);
  TVM_MODULE_VTABLE_ENTRY("save", &Executable::Save);
  TVM_MODULE_VTABLE_ENTRY("get_function_arity", &Executable::GetFunctionArity);
  TVM_MODULE_VTABLE_ENTRY("get_function_param_name", &Executable::GetFunctionParameterName);
  TVM_MODULE_VTABLE_ENTRY("vm_load_executable", &Executable::VMLoadExecutable);
  TVM_MODULE_VTABLE_ENTRY("move_late_bound_consts", &Executable::MoveLateBoundConstantsToFile);
  TVM_MODULE_VTABLE_ENTRY("get_late_bound_consts", &Executable::GetLateBoundConstants);
  TVM_MODULE_VTABLE_ENTRY("load_late_bound_consts", &Executable::LoadLateBoundConstantsFromFile);
  TVM_MODULE_VTABLE_ENTRY("load_late_bound_consts_from_map",
                          &Executable::LoadLateBoundConstantsFromMap);
  TVM_MODULE_VTABLE_END();
 
  int GetPropertyMask() const final { return ModulePropertyMask::kBinarySerializable; };
  Module VMLoadExecutable();
  void SaveToBinary(dmlc::Stream* stream) final;
 
  void SaveToFile(const String& path, const String& format) final;
 
  TVMByteArray Save();
 
  static runtime::Module Load(const std::string& code, const runtime::Module lib);
 
  void MoveLateBoundConstantsToStream(dmlc::Stream* stream, int64_t byte_limit);
 
  void MoveLateBoundConstantsToFile(const std::string& path, int64_t byte_limit);
 
  Map<String, NDArray> GetLateBoundConstants(int64_t byte_limit);
 
  void LoadLateBoundConstantsFromStream(dmlc::Stream* stream);
 
  void LoadLateBoundConstantsFromMap(Map<String, NDArray> map);
 
  void LoadLateBoundConstantsFromFile(const std::string& path);
 
  std::string GetBytecode() const;
 
  std::string GetConstants() const;
 
  std::string GetVirtualDevices() const;
 
  std::string GetPrimitives() const;
 
  std::string Stats() const;
 
  runtime::Module GetLib() const;
 
  void SetLib(const runtime::Module& lib);
 
  const VMFunction& GetVMFunctionWithName(const std::string& func_name) const;
 
  int GetFunctionArity(std::string func) const;
 
  std::string GetFunctionParameterName(std::string func, int index) const;
 
  virtual ~Executable() {}
 
  std::vector<std::pair<Device, std::string>> virtual_devices;
  int host_device_index = -1;
  std::vector<ObjectRef> constants;
  std::vector<String> late_bound_constant_names;
 
  std::unordered_map<std::string, Index> global_map;
  std::unordered_map<std::string, Index> primitive_map;
  std::map<Index, Map<String, ObjectRef>> op_attrs;
  std::vector<VMFunction> functions;
  std::vector<Index> const_device_indexes;
 
 private:
  void SaveVirtualDevicesSection(dmlc::Stream* strm);
 
  void SaveGlobalSection(dmlc::Stream* strm);
 
  void SaveConstantSection(dmlc::Stream* stream);
 
  void LoadConstantSection(dmlc::Stream* stream);
 
  void SavePrimitiveOpNames(dmlc::Stream* strm);
 
  void SaveCodeSection(dmlc::Stream* strm);
 
  void LoadVirtualDevicesSection(dmlc::Stream* strm);
 
  void LoadGlobalSection(dmlc::Stream* strm);
 
  void LoadPrimitiveOpNames(dmlc::Stream* strm);
 
  void LoadCodeSection(dmlc::Stream* strm);
 
  std::string code_;
};
 
}  // namespace vm
}  // namespace runtime
}  // namespace tvm
 
#endif  // TVM_RUNTIME_VM_EXECUTABLE_H_