1//===--- llvm-opt-fuzzer.cpp - Fuzzer for instruction selection ----------===//
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// Tool to fuzz optimization passes using libFuzzer.
10//
11//===----------------------------------------------------------------------===//
12
13#include "llvm/Bitcode/BitcodeReader.h"
14#include "llvm/Bitcode/BitcodeWriter.h"
15#include "llvm/CodeGen/CommandFlags.h"
16#include "llvm/FuzzMutate/FuzzerCLI.h"
17#include "llvm/FuzzMutate/IRMutator.h"
18#include "llvm/IR/Verifier.h"
19#include "llvm/MC/TargetRegistry.h"
20#include "llvm/Passes/PassBuilder.h"
21#include "llvm/Support/CommandLine.h"
22#include "llvm/Support/LibraryOptionsContext.h"
23#include "llvm/Support/SourceMgr.h"
24#include "llvm/Support/TargetSelect.h"
25#include "llvm/Target/TargetMachine.h"
26
27using namespace llvm;
28
29static cl::opt<std::string>
30 TargetTripleStr("mtriple", cl::desc("Override target triple for module"));
31
32// Passes to run for this fuzzer instance. Expects new pass manager syntax.
33static cl::opt<std::string> PassPipeline(
34 "passes",
35 cl::desc("A textual description of the pass pipeline for testing"));
36
37static std::unique_ptr<IRMutator> Mutator;
38static cl::LibraryOptionsContext LibraryOptions;
39static std::unique_ptr<TargetMachine> TM;
40
41std::unique_ptr<IRMutator> createOptMutator() {
42 std::vector<TypeGetter> Types{
43 Type::getInt1Ty, Type::getInt8Ty, Type::getInt16Ty, Type::getInt32Ty,
44 Type::getInt64Ty, Type::getFloatTy, Type::getDoubleTy};
45
46 std::vector<std::unique_ptr<IRMutationStrategy>> Strategies;
47 Strategies.push_back(x: std::make_unique<InjectorIRStrategy>(
48 args: InjectorIRStrategy::getDefaultOps()));
49 Strategies.push_back(x: std::make_unique<InstDeleterIRStrategy>());
50 Strategies.push_back(x: std::make_unique<InstModificationIRStrategy>());
51
52 return std::make_unique<IRMutator>(args: std::move(Types), args: std::move(Strategies));
53}
54
55extern "C" LLVM_ATTRIBUTE_USED size_t LLVMFuzzerCustomMutator(
56 uint8_t *Data, size_t Size, size_t MaxSize, unsigned int Seed) {
57
58 assert(Mutator &&
59 "IR mutator should have been created during fuzzer initialization");
60
61 LLVMContext Context;
62 auto M = parseAndVerify(Data, Size, Context);
63 if (!M) {
64 errs() << "error: mutator input module is broken!\n";
65 return 0;
66 }
67
68 Mutator->mutateModule(M&: *M, Seed, MaxSize);
69
70 if (verifyModule(M: *M, OS: &errs())) {
71 errs() << "mutation result doesn't pass verification\n";
72#ifndef NDEBUG
73 M->dump();
74#endif
75 // Avoid adding incorrect test cases to the corpus.
76 return 0;
77 }
78
79 std::string Buf;
80 {
81 raw_string_ostream OS(Buf);
82 WriteBitcodeToFile(M: *M, Out&: OS);
83 }
84 if (Buf.size() > MaxSize)
85 return 0;
86
87 // There are some invariants which are not checked by the verifier in favor
88 // of having them checked by the parser. They may be considered as bugs in the
89 // verifier and should be fixed there. However until all of those are covered
90 // we want to check for them explicitly. Otherwise we will add incorrect input
91 // to the corpus and this is going to confuse the fuzzer which will start
92 // exploration of the bitcode reader error handling code.
93 auto NewM = parseAndVerify(Data: reinterpret_cast<const uint8_t *>(Buf.data()),
94 Size: Buf.size(), Context);
95 if (!NewM) {
96 errs() << "mutator failed to re-read the module\n";
97#ifndef NDEBUG
98 M->dump();
99#endif
100 return 0;
101 }
102
103 memcpy(dest: Data, src: Buf.data(), n: Buf.size());
104 return Buf.size();
105}
106
107extern "C" int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
108 assert(TM && "Should have been created during fuzzer initialization");
109
110 if (Size <= 1)
111 // We get bogus data given an empty corpus - ignore it.
112 return 0;
113
114 // Parse module
115 //
116
117 LLVMContext Context;
118 Context.getLibraryOptions().assign(Other: LibraryOptions);
119 auto M = parseAndVerify(Data, Size, Context);
120 if (!M) {
121 errs() << "error: input module is broken!\n";
122 return 0;
123 }
124
125 // Set up target dependant options
126 //
127
128 M->setTargetTriple(TM->getTargetTriple());
129 M->setDataLayout(TM->getTargetTriple().computeDataLayout());
130 codegen::setFunctionAttributes(M&: *M, CPU: TM->getTargetCPU(),
131 Features: TM->getTargetFeatureString());
132
133 // Create pass pipeline
134 //
135
136 PassBuilder PB(Context, TM.get());
137
138 LoopAnalysisManager LAM;
139 FunctionAnalysisManager FAM;
140 CGSCCAnalysisManager CGAM;
141 ModulePassManager MPM;
142 ModuleAnalysisManager MAM;
143
144 PB.registerModuleAnalyses(MAM);
145 PB.registerCGSCCAnalyses(CGAM);
146 PB.registerFunctionAnalyses(FAM);
147 PB.registerLoopAnalyses(LAM);
148 PB.crossRegisterProxies(LAM, FAM, CGAM, MAM);
149
150 auto Err = PB.parsePassPipeline(MPM, PipelineText: PassPipeline);
151 assert(!Err && "Should have been checked during fuzzer initialization");
152 // Only fail with assert above, otherwise ignore the parsing error.
153 consumeError(Err: std::move(Err));
154
155 // Run passes which we need to test
156 //
157
158 MPM.run(IR&: *M, AM&: MAM);
159
160 // Check that passes resulted in a correct code
161 if (verifyModule(M: *M, OS: &errs())) {
162 errs() << "Transformation resulted in an invalid module\n";
163 abort();
164 }
165
166 return 0;
167}
168
169static void handleLLVMFatalError(void *, const char *Message, bool) {
170 // TODO: Would it be better to call into the fuzzer internals directly?
171 dbgs() << "LLVM ERROR: " << Message << "\n"
172 << "Aborting to trigger fuzzer exit handling.\n";
173 abort();
174}
175
176extern "C" LLVM_ATTRIBUTE_USED int LLVMFuzzerInitialize(int *argc,
177 char ***argv) {
178 EnableDebugBuffering = true;
179 StringRef ExecName = *argv[0];
180
181 // Make sure we print the summary and the current unit when LLVM errors out.
182 install_fatal_error_handler(handler: handleLLVMFatalError, user_data: nullptr);
183
184 // Initialize llvm
185 //
186
187 InitializeAllTargets();
188 InitializeAllTargetMCs();
189
190 // Parse input options
191 //
192
193 handleExecNameEncodedOptimizerOpts(LibraryOptions, ExecName);
194 parseFuzzerCLOpts(LibraryOptions, ToolOptions: codegen::getToolOptions(), ArgC: *argc, ArgV: *argv);
195
196 // Create TargetMachine
197 //
198 if (TargetTripleStr.empty()) {
199 errs() << ExecName << ": -mtriple must be specified\n";
200 exit(status: 1);
201 }
202 ExitOnError ExitOnErr(std::string(ExecName) + ": error:");
203
204 Triple TT(Triple::normalize(Str: TargetTripleStr));
205 TM = ExitOnErr(codegen::createTargetMachineForTriple(LibraryOptions, TargetTriple: TT));
206
207 // Check that pass pipeline is specified and correct
208 //
209
210 if (PassPipeline.empty()) {
211 errs() << ExecName << ": at least one pass should be specified\n";
212 exit(status: 1);
213 }
214
215 LLVMContext Context;
216 Context.getLibraryOptions().assign(Other: LibraryOptions);
217 PassBuilder PB(Context, TM.get());
218 ModulePassManager MPM;
219 if (auto Err = PB.parsePassPipeline(MPM, PipelineText: PassPipeline)) {
220 errs() << ExecName << ": " << toString(E: std::move(Err)) << "\n";
221 exit(status: 1);
222 }
223
224 // Create mutator
225 //
226
227 Mutator = createOptMutator();
228
229 return 0;
230}
231