1//===---- IRReader.cpp - Reader for LLVM IR files -------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "llvm/IRReader/IRReader.h"
10#include "llvm-c/IRReader.h"
11#include "llvm/AsmParser/AsmParserContext.h"
12#include "llvm/AsmParser/Parser.h"
13#include "llvm/Bitcode/BitcodeReader.h"
14#include "llvm/IR/LLVMContext.h"
15#include "llvm/IR/Module.h"
16#include "llvm/Support/MemoryBuffer.h"
17#include "llvm/Support/SourceMgr.h"
18#include "llvm/Support/Timer.h"
19#include "llvm/Support/raw_ostream.h"
20#include <cstring>
21#include <optional>
22#include <system_error>
23
24using namespace llvm;
25
26namespace llvm {
27 extern bool TimePassesIsEnabled;
28}
29
30const char TimeIRParsingGroupName[] = "irparse";
31const char TimeIRParsingGroupDescription[] = "LLVM IR Parsing";
32const char TimeIRParsingName[] = "parse";
33const char TimeIRParsingDescription[] = "Parse IR";
34
35std::unique_ptr<Module>
36llvm::getLazyIRModule(std::unique_ptr<MemoryBuffer> Buffer, SMDiagnostic &Err,
37 LLVMContext &Context, bool ShouldLazyLoadMetadata) {
38 if (isBitcode(BufPtr: (const unsigned char *)Buffer->getBufferStart(),
39 BufEnd: (const unsigned char *)Buffer->getBufferEnd())) {
40 Expected<std::unique_ptr<Module>> ModuleOrErr = getOwningLazyBitcodeModule(
41 Buffer: std::move(Buffer), Context, ShouldLazyLoadMetadata);
42 if (Error E = ModuleOrErr.takeError()) {
43 handleAllErrors(E: std::move(E), Handlers: [&](ErrorInfoBase &EIB) {
44 Err = SMDiagnostic(Buffer->getBufferIdentifier(), SourceMgr::DK_Error,
45 EIB.message());
46 });
47 return nullptr;
48 }
49 return std::move(ModuleOrErr.get());
50 }
51
52 return parseAssembly(F: Buffer->getMemBufferRef(), Err, Context);
53}
54
55std::unique_ptr<Module> llvm::getLazyIRFileModule(StringRef Filename,
56 SMDiagnostic &Err,
57 LLVMContext &Context,
58 bool ShouldLazyLoadMetadata) {
59 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
60 MemoryBuffer::getFileOrSTDIN(Filename);
61 if (std::error_code EC = FileOrErr.getError()) {
62 Err = SMDiagnostic(Filename, SourceMgr::DK_Error,
63 "Could not open input file: " + EC.message());
64 return nullptr;
65 }
66
67 return getLazyIRModule(Buffer: std::move(FileOrErr.get()), Err, Context,
68 ShouldLazyLoadMetadata);
69}
70
71std::unique_ptr<Module> llvm::parseIR(MemoryBufferRef Buffer, SMDiagnostic &Err,
72 LLVMContext &Context,
73 ParserCallbacks Callbacks,
74 llvm::AsmParserContext *ParserContext) {
75 NamedRegionTimer T(TimeIRParsingName, TimeIRParsingDescription,
76 TimeIRParsingGroupName, TimeIRParsingGroupDescription,
77 TimePassesIsEnabled);
78 if (isBitcode(BufPtr: (const unsigned char *)Buffer.getBufferStart(),
79 BufEnd: (const unsigned char *)Buffer.getBufferEnd())) {
80 Expected<std::unique_ptr<Module>> ModuleOrErr =
81 parseBitcodeFile(Buffer, Context, Callbacks);
82 if (Error E = ModuleOrErr.takeError()) {
83 handleAllErrors(E: std::move(E), Handlers: [&](ErrorInfoBase &EIB) {
84 Err = SMDiagnostic(Buffer.getBufferIdentifier(), SourceMgr::DK_Error,
85 EIB.message());
86 });
87 return nullptr;
88 }
89 return std::move(ModuleOrErr.get());
90 }
91
92 return parseAssembly(F: Buffer, Err, Context, Slots: nullptr,
93 DataLayoutCallback: Callbacks.DataLayout.value_or(
94 u: [](StringRef, StringRef) { return std::nullopt; }),
95 ParserContext);
96}
97
98std::unique_ptr<Module> llvm::parseIRFile(StringRef Filename, SMDiagnostic &Err,
99 LLVMContext &Context,
100 ParserCallbacks Callbacks,
101 AsmParserContext *ParserContext) {
102 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
103 MemoryBuffer::getFileOrSTDIN(Filename, /*IsText=*/true);
104 if (std::error_code EC = FileOrErr.getError()) {
105 Err = SMDiagnostic(Filename, SourceMgr::DK_Error,
106 "Could not open input file: " + EC.message());
107 return nullptr;
108 }
109
110 return parseIR(Buffer: FileOrErr.get()->getMemBufferRef(), Err, Context, Callbacks,
111 ParserContext);
112}
113
114//===----------------------------------------------------------------------===//
115// C API.
116//===----------------------------------------------------------------------===//
117
118LLVMBool LLVMParseIRInContext(LLVMContextRef ContextRef,
119 LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM,
120 char **OutMessage) {
121 std::unique_ptr<MemoryBuffer> MB(unwrap(P: MemBuf));
122 return LLVMParseIRInContext2(ContextRef, MemBuf: wrap(P: MB.get()), OutM, OutMessage);
123}
124
125LLVMBool LLVMParseIRInContext2(LLVMContextRef ContextRef,
126 LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM,
127 char **OutMessage) {
128 SMDiagnostic Diag;
129
130 *OutM = wrap(P: parseIR(Buffer: *unwrap(P: MemBuf), Err&: Diag, Context&: *unwrap(P: ContextRef)).release());
131
132 if (*OutM)
133 return 0;
134
135 if (OutMessage) {
136 std::string Buf;
137 raw_string_ostream OS(Buf);
138 Diag.print(ProgName: nullptr, S&: OS, /*ShowColors=*/false);
139 *OutMessage = strdup(s: Buf.c_str());
140 }
141
142 return 1;
143}
144