revng-revng/include/revng/Lift/CodeGenerator.h

#pragma once

//
// This file is distributed under the MIT License. See LICENSE.md for details.
//

#include <cstdint>
#include <memory>
#include <string>

#include "llvm/ADT/ArrayRef.h"

#include "revng/Support/revng.h"

#include "BinaryFile.h"

// Forward declarations
namespace llvm {

class LLVMContext;
class Function;
class GlobalVariable;
class Module;
class Value;
class StructType;
class DataLayout;

}; // namespace llvm

/// Translator from binary code to LLVM IR.
class CodeGenerator {
public:
  /// Create a new code generator translating code from an architecture to
  /// another, writing the corresponding LLVM IR and other useful information to
  /// the specified paths.
  ///
  /// \param Binary reference to a BinaryFile object describing the input.
  /// \param Target target architecture.
  /// \param Output path where the generate LLVM IR must be saved.
  /// \param Helpers path of the LLVM IR file containing the QEMU helpers.
  CodeGenerator(BinaryFile &Binary,
                Architecture &Target,
                llvm::Module *TheModule,
                std::string Helpers,
                std::string EarlyLinked);

  ~CodeGenerator();

  /// \brief Creates an LLVM function for the code in the specified memory area.
  ///
  /// \param VirtualAddress the address from where the translation should start.
  void translate(llvm::Optional<uint64_t> RawVirtualAddress);

private:
  Architecture TargetArchitecture;
  llvm::Module *TheModule;
  llvm::LLVMContext &Context;
  std::unique_ptr<llvm::Module> HelpersModule;
  std::unique_ptr<llvm::Module> EarlyLinkedModule;
  BinaryFile &Binary;

  unsigned OriginalInstrMDKind;
  unsigned PTCInstrMDKind;

  std::string FunctionListPath;

  std::set<MetaAddress> NoMoreCodeBoundaries;
};