// Copyright 2019 The IREE Authors
//
// Licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#ifndef IREE_COMPILER_DIALECT_VM_TARGET_BYTECODE_BYTECODEENCODER_H_
#define IREE_COMPILER_DIALECT_VM_TARGET_BYTECODE_BYTECODEENCODER_H_

#include "iree/compiler/Dialect/VM/Analysis/OrdinalAnalysis.h"
#include "iree/compiler/Dialect/VM/IR/VMFuncEncoder.h"
#include "iree/compiler/Dialect/VM/IR/VMOps.h"
#include "iree/compiler/Dialect/VM/Target/Bytecode/DebugDatabaseBuilder.h"
#include "mlir/IR/SymbolTable.h"

namespace mlir::iree_compiler::IREE::VM {

struct EncodedBytecodeFunction {
  // Encoded bytecode data for the function body including padding.
  std::vector<uint8_t> bytecodeData;
  // Precise size of the bytecode.
  size_t bytecodeLength = 0;

  // Total number of blocks including the entry block.
  uint16_t blockCount = 0;

  // Total i32 register slots required for execution.
  // Note that larger types also use these slots (i64=2xi32).
  uint16_t i32RegisterCount = 0;
  // Total vm.ref register slots required for execution.
  uint16_t refRegisterCount = 0;
};

// Abstract encoder used for function bytecode encoding.
class BytecodeEncoder : public VMFuncEncoder {
public:
  // Matches IREE_VM_BYTECODE_VERSION_MAJOR.
  static constexpr uint32_t kVersionMajor = 17;
  // Matches IREE_VM_BYTECODE_VERSION_MINOR.
  static constexpr uint32_t kVersionMinor = 0;
  static constexpr uint32_t kVersion = (kVersionMajor << 16) | kVersionMinor;

  // Encodes a vm.func to bytecode and returns the result.
  // Returns None on failure.
  static std::optional<EncodedBytecodeFunction>
  encodeFunction(IREE::VM::FuncOp funcOp, llvm::DenseMap<Type, int> &typeTable,
                 SymbolTable &symbolTable,
                 const OrdinalAnalysis &ordinalAnalysis,
                 DebugDatabaseBuilder &debugDatabase);

  BytecodeEncoder() = default;
  ~BytecodeEncoder() = default;
};

} // namespace mlir::iree_compiler::IREE::VM

#endif // IREE_COMPILER_DIALECT_VM_TARGET_BYTECODE_BYTECODEENCODER_H_
