Export.h

Go to the documentation of this file.

//===- Export.h - MLIR to LLVM IR translation entry point -------*- C++ -*-===//
//
// Part of the LLVM Project, 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 MLIR_TARGET_LLVMIR_EXPORT_H
#define MLIR_TARGET_LLVMIR_EXPORT_H
 
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/VirtualFileSystemFwd.h"
#include <memory>
 
namespace llvm {
class LLVMContext;
class Module;
} // namespace llvm
 
namespace mlir {
class Operation;
 
/// Translates a given LLVM dialect `module` into an LLVM IR module living in
/// the given context. Operates on any operation from dialects that provide a
/// registered implementation of the LLVMTranslationDialectInterface. Returns
/// nullptr when the translation fails.
/// Verifies the produced LLVM module, except when `disableVerification` is set.
/// An optional \p fs can be provided to avoid direct filesystem access (e.g.,
/// to comply with the IO sandbox in clang -cc1). When null, the real filesystem
/// is used.
std::unique_ptr<llvm::Module>
translateModuleToLLVMIR(Operation *module, llvm::LLVMContext &llvmContext,
                        llvm::StringRef name = "LLVMDialectModule",
                        bool disableVerification = false,
                        llvm::vfs::FileSystem *fs = nullptr);
} // namespace mlir
 
#endif // MLIR_TARGET_LLVMIR_EXPORT_H