blob: 81f257e6290f8541fd6e895929d3fba332bf5456 [file] [log] [blame]
Kostya Serebryany22526252015-05-11 21:16:27 +00001//===- FuzzerTraceState.cpp - Trace-based fuzzer mutator ------------------===//
Kostya Serebryany16d03bd2015-03-30 22:09:51 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
Kostya Serebryany22526252015-05-11 21:16:27 +00009// This file implements a mutation algorithm based on instruction traces and
10// on taint analysis feedback from DFSan.
11//
12// Instruction traces are special hooks inserted by the compiler around
13// interesting instructions. Currently supported traces:
14// * __sanitizer_cov_trace_cmp -- inserted before every ICMP instruction,
15// receives the type, size and arguments of ICMP.
16//
17// Every time a traced event is intercepted we analyse the data involved
18// in the event and suggest a mutation for future executions.
19// For example if 4 bytes of data that derive from input bytes {4,5,6,7}
20// are compared with a constant 12345,
21// we try to insert 12345, 12344, 12346 into bytes
22// {4,5,6,7} of the next fuzzed inputs.
23//
24// The fuzzer can work only with the traces, or with both traces and DFSan.
25//
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000026// DataFlowSanitizer (DFSan) is a tool for
27// generalised dynamic data flow (taint) analysis:
28// http://clang.llvm.org/docs/DataFlowSanitizer.html .
29//
Kostya Serebryany22526252015-05-11 21:16:27 +000030// The approach with DFSan-based fuzzing has some similarity to
31// "Taint-based Directed Whitebox Fuzzing"
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000032// by Vijay Ganesh & Tim Leek & Martin Rinard:
33// http://dspace.mit.edu/openaccess-disseminate/1721.1/59320,
34// but it uses a full blown LLVM IR taint analysis and separate instrumentation
35// to analyze all of the "attack points" at once.
36//
Kostya Serebryany22526252015-05-11 21:16:27 +000037// Workflow with DFSan:
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000038// * lib/Fuzzer/Fuzzer*.cpp is compiled w/o any instrumentation.
Kostya Serebryany22526252015-05-11 21:16:27 +000039// * The code under test is compiled with DFSan *and* with instruction traces.
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000040// * Every call to HOOK(a,b) is replaced by DFSan with
41// __dfsw_HOOK(a, b, label(a), label(b)) so that __dfsw_HOOK
42// gets all the taint labels for the arguments.
43// * At the Fuzzer startup we assign a unique DFSan label
Kostya Serebryany98abb2c2016-01-13 23:46:01 +000044// to every byte of the input string (Fuzzer::CurrentUnitData) so that
45// for any chunk of data we know which input bytes it has derived from.
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000046// * The __dfsw_* functions (implemented in this file) record the
47// parameters (i.e. the application data and the corresponding taint labels)
48// in a global state.
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000049//
Kostya Serebryany22526252015-05-11 21:16:27 +000050// Parts of this code will not function when DFSan is not linked in.
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000051// Instead of using ifdefs and thus requiring a separate build of lib/Fuzzer
52// we redeclare the dfsan_* interface functions as weak and check if they
53// are nullptr before calling.
54// If this approach proves to be useful we may add attribute(weak) to the
55// dfsan declarations in dfsan_interface.h
56//
57// This module is in the "proof of concept" stage.
58// It is capable of solving only the simplest puzzles
59// like test/dfsan/DFSanSimpleCmpTest.cpp.
60//===----------------------------------------------------------------------===//
61
Kostya Serebryany22526252015-05-11 21:16:27 +000062/* Example of manual usage (-fsanitize=dataflow is optional):
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000063(
64 cd $LLVM/lib/Fuzzer/
65 clang -fPIC -c -g -O2 -std=c++11 Fuzzer*.cpp
Alexey Samsonov21a33812015-05-07 23:33:24 +000066 clang++ -O0 -std=c++11 -fsanitize-coverage=edge,trace-cmp \
Kostya Serebryany3befe942015-05-06 22:47:24 +000067 -fsanitize=dataflow \
Kostya Serebryany65f50862015-09-10 18:48:38 +000068 test/SimpleCmpTest.cpp Fuzzer*.o
69 ./a.out -use_traces=1
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000070)
71*/
72
Kostya Serebryany65f50862015-09-10 18:48:38 +000073#include "FuzzerDFSan.h"
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000074#include "FuzzerInternal.h"
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000075
Kostya Serebryanybeb24c32015-05-07 21:02:11 +000076#include <algorithm>
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000077#include <cstring>
Kostya Serebryany226b7342016-01-06 00:03:35 +000078#include <thread>
Kostya Serebryany859e86d2016-01-12 02:08:37 +000079#include <map>
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000080
Kostya Serebryany65f50862015-09-10 18:48:38 +000081#if !LLVM_FUZZER_SUPPORTS_DFSAN
82// Stubs for dfsan for platforms where dfsan does not exist and weak
83// functions don't work.
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000084extern "C" {
Kostya Serebryany65f50862015-09-10 18:48:38 +000085dfsan_label dfsan_create_label(const char *desc, void *userdata) { return 0; }
86void dfsan_set_label(dfsan_label label, void *addr, size_t size) {}
87void dfsan_add_label(dfsan_label label, void *addr, size_t size) {}
88const struct dfsan_label_info *dfsan_get_label_info(dfsan_label label) {
89 return nullptr;
90}
91dfsan_label dfsan_read_label(const void *addr, size_t size) { return 0; }
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000092} // extern "C"
Kostya Serebryany65f50862015-09-10 18:48:38 +000093#endif // !LLVM_FUZZER_SUPPORTS_DFSAN
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000094
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +000095namespace fuzzer {
96
Kostya Serebryany16d03bd2015-03-30 22:09:51 +000097// These values are copied from include/llvm/IR/InstrTypes.h.
98// We do not include the LLVM headers here to remain independent.
99// If these values ever change, an assertion in ComputeCmp will fail.
100enum Predicate {
101 ICMP_EQ = 32, ///< equal
102 ICMP_NE = 33, ///< not equal
103 ICMP_UGT = 34, ///< unsigned greater than
104 ICMP_UGE = 35, ///< unsigned greater or equal
105 ICMP_ULT = 36, ///< unsigned less than
106 ICMP_ULE = 37, ///< unsigned less or equal
107 ICMP_SGT = 38, ///< signed greater than
108 ICMP_SGE = 39, ///< signed greater or equal
109 ICMP_SLT = 40, ///< signed less than
110 ICMP_SLE = 41, ///< signed less or equal
111};
112
113template <class U, class S>
114bool ComputeCmp(size_t CmpType, U Arg1, U Arg2) {
115 switch(CmpType) {
116 case ICMP_EQ : return Arg1 == Arg2;
117 case ICMP_NE : return Arg1 != Arg2;
118 case ICMP_UGT: return Arg1 > Arg2;
119 case ICMP_UGE: return Arg1 >= Arg2;
120 case ICMP_ULT: return Arg1 < Arg2;
121 case ICMP_ULE: return Arg1 <= Arg2;
122 case ICMP_SGT: return (S)Arg1 > (S)Arg2;
123 case ICMP_SGE: return (S)Arg1 >= (S)Arg2;
124 case ICMP_SLT: return (S)Arg1 < (S)Arg2;
125 case ICMP_SLE: return (S)Arg1 <= (S)Arg2;
126 default: assert(0 && "unsupported CmpType");
127 }
128 return false;
129}
130
131static bool ComputeCmp(size_t CmpSize, size_t CmpType, uint64_t Arg1,
132 uint64_t Arg2) {
133 if (CmpSize == 8) return ComputeCmp<uint64_t, int64_t>(CmpType, Arg1, Arg2);
134 if (CmpSize == 4) return ComputeCmp<uint32_t, int32_t>(CmpType, Arg1, Arg2);
135 if (CmpSize == 2) return ComputeCmp<uint16_t, int16_t>(CmpType, Arg1, Arg2);
136 if (CmpSize == 1) return ComputeCmp<uint8_t, int8_t>(CmpType, Arg1, Arg2);
Kostya Serebryanyb74ba422015-07-30 02:33:45 +0000137 // Other size, ==
138 if (CmpType == ICMP_EQ) return Arg1 == Arg2;
Kostya Serebryany8ce74242015-08-01 01:42:51 +0000139 // assert(0 && "unsupported cmp and type size combination");
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000140 return true;
141}
142
143// As a simplification we use the range of input bytes instead of a set of input
144// bytes.
145struct LabelRange {
146 uint16_t Beg, End; // Range is [Beg, End), thus Beg==End is an empty range.
147
148 LabelRange(uint16_t Beg = 0, uint16_t End = 0) : Beg(Beg), End(End) {}
149
150 static LabelRange Join(LabelRange LR1, LabelRange LR2) {
151 if (LR1.Beg == LR1.End) return LR2;
152 if (LR2.Beg == LR2.End) return LR1;
153 return {std::min(LR1.Beg, LR2.Beg), std::max(LR1.End, LR2.End)};
154 }
155 LabelRange &Join(LabelRange LR) {
156 return *this = Join(*this, LR);
157 }
158 static LabelRange Singleton(const dfsan_label_info *LI) {
159 uint16_t Idx = (uint16_t)(uintptr_t)LI->userdata;
160 assert(Idx > 0);
161 return {(uint16_t)(Idx - 1), Idx};
162 }
163};
164
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000165// For now, very simple: put Size bytes of Data at position Pos.
166struct TraceBasedMutation {
Kostya Serebryany476f0ce2016-01-16 03:53:32 +0000167 uint32_t Pos;
168 Word W;
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000169};
170
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000171// Declared as static globals for faster checks inside the hooks.
172static bool RecordingTraces = false;
173static bool RecordingMemcmp = false;
174
Kostya Serebryany22526252015-05-11 21:16:27 +0000175class TraceState {
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000176 public:
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000177 TraceState(UserSuppliedFuzzer &USF, const Fuzzer::FuzzingOptions &Options,
178 uint8_t **CurrentUnitData, size_t *CurrentUnitSize)
179 : USF(USF), Options(Options), CurrentUnitData(CurrentUnitData),
180 CurrentUnitSize(CurrentUnitSize) {
181 // Current trace collection is not thread-friendly and it probably
182 // does not have to be such, but at least we should not crash in presence
183 // of threads. So, just ignore all traces coming from all threads but one.
184 IsMyThread = true;
Kostya Serebryany226b7342016-01-06 00:03:35 +0000185 }
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000186
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000187 LabelRange GetLabelRange(dfsan_label L);
188 void DFSanCmpCallback(uintptr_t PC, size_t CmpSize, size_t CmpType,
189 uint64_t Arg1, uint64_t Arg2, dfsan_label L1,
190 dfsan_label L2);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000191 void DFSanMemcmpCallback(size_t CmpSize, const uint8_t *Data1,
192 const uint8_t *Data2, dfsan_label L1,
193 dfsan_label L2);
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000194 void DFSanSwitchCallback(uint64_t PC, size_t ValSizeInBits, uint64_t Val,
195 size_t NumCases, uint64_t *Cases, dfsan_label L);
Kostya Serebryanye641dd62015-09-04 22:32:25 +0000196 void TraceCmpCallback(uintptr_t PC, size_t CmpSize, size_t CmpType,
197 uint64_t Arg1, uint64_t Arg2);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000198 void TraceMemcmpCallback(size_t CmpSize, const uint8_t *Data1,
199 const uint8_t *Data2);
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000200
201 void TraceSwitchCallback(uintptr_t PC, size_t ValSizeInBits, uint64_t Val,
202 size_t NumCases, uint64_t *Cases);
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000203 int TryToAddDesiredData(uint64_t PresentData, uint64_t DesiredData,
204 size_t DataSize);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000205 int TryToAddDesiredData(const uint8_t *PresentData,
206 const uint8_t *DesiredData, size_t DataSize);
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000207
208 void StartTraceRecording() {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000209 if (!Options.UseTraces && !Options.UseMemcmp) return;
210 RecordingTraces = Options.UseTraces;
211 RecordingMemcmp = Options.UseMemcmp;
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000212 NumMutations = 0;
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000213 USF.GetMD().ClearAutoDictionary();
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000214 }
215
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000216 void StopTraceRecording() {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000217 if (!RecordingTraces && !RecordingMemcmp) return;
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000218 RecordingTraces = false;
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000219 RecordingMemcmp = false;
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000220 for (size_t i = 0; i < NumMutations; i++) {
221 auto &M = Mutations[i];
Kostya Serebryany859e86d2016-01-12 02:08:37 +0000222 if (Options.Verbosity >= 2) {
Kostya Serebryany476f0ce2016-01-16 03:53:32 +0000223 AutoDictUnitCounts[M.W]++;
Kostya Serebryany859e86d2016-01-12 02:08:37 +0000224 AutoDictAdds++;
225 if ((AutoDictAdds & (AutoDictAdds - 1)) == 0) {
Kostya Serebryany476f0ce2016-01-16 03:53:32 +0000226 typedef std::pair<size_t, Word> CU;
Kostya Serebryany859e86d2016-01-12 02:08:37 +0000227 std::vector<CU> CountedUnits;
228 for (auto &I : AutoDictUnitCounts)
229 CountedUnits.push_back(std::make_pair(I.second, I.first));
230 std::sort(CountedUnits.begin(), CountedUnits.end(),
231 [](const CU &a, const CU &b) { return a.first > b.first; });
232 Printf("AutoDict:\n");
233 for (auto &I : CountedUnits) {
234 Printf(" %zd ", I.first);
Kostya Serebryany41740052016-01-12 02:36:59 +0000235 PrintASCII(I.second);
Kostya Serebryany859e86d2016-01-12 02:08:37 +0000236 Printf("\n");
237 }
238 }
239 }
Kostya Serebryany476f0ce2016-01-16 03:53:32 +0000240 USF.GetMD().AddWordToAutoDictionary(M.W, M.Pos);
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000241 }
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000242 }
243
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000244 void AddMutation(uint32_t Pos, uint32_t Size, const uint8_t *Data) {
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000245 if (NumMutations >= kMaxMutations) return;
246 auto &M = Mutations[NumMutations++];
247 M.Pos = Pos;
Kostya Serebryany476f0ce2016-01-16 03:53:32 +0000248 M.W.Set(Data, Size);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000249 }
250
251 void AddMutation(uint32_t Pos, uint32_t Size, uint64_t Data) {
252 assert(Size <= sizeof(Data));
253 AddMutation(Pos, Size, reinterpret_cast<uint8_t*>(&Data));
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000254 }
255
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000256 private:
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000257 bool IsTwoByteData(uint64_t Data) {
258 int64_t Signed = static_cast<int64_t>(Data);
259 Signed >>= 16;
260 return Signed == 0 || Signed == -1L;
261 }
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000262 static const size_t kMaxMutations = 1 << 16;
263 size_t NumMutations;
264 TraceBasedMutation Mutations[kMaxMutations];
Kostya Serebryany4d623222015-11-18 01:08:30 +0000265 LabelRange LabelRanges[1 << (sizeof(dfsan_label) * 8)];
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000266 UserSuppliedFuzzer &USF;
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000267 const Fuzzer::FuzzingOptions &Options;
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000268 uint8_t **CurrentUnitData;
269 size_t *CurrentUnitSize;
Kostya Serebryany476f0ce2016-01-16 03:53:32 +0000270 std::map<Word, size_t> AutoDictUnitCounts;
Kostya Serebryany859e86d2016-01-12 02:08:37 +0000271 size_t AutoDictAdds = 0;
Kostya Serebryany226b7342016-01-06 00:03:35 +0000272 static thread_local bool IsMyThread;
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000273};
274
Kostya Serebryany226b7342016-01-06 00:03:35 +0000275thread_local bool TraceState::IsMyThread;
276
Kostya Serebryany22526252015-05-11 21:16:27 +0000277LabelRange TraceState::GetLabelRange(dfsan_label L) {
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000278 LabelRange &LR = LabelRanges[L];
279 if (LR.Beg < LR.End || L == 0)
280 return LR;
281 const dfsan_label_info *LI = dfsan_get_label_info(L);
282 if (LI->l1 || LI->l2)
283 return LR = LabelRange::Join(GetLabelRange(LI->l1), GetLabelRange(LI->l2));
284 return LR = LabelRange::Singleton(LI);
285}
286
Kostya Serebryany22526252015-05-11 21:16:27 +0000287void TraceState::DFSanCmpCallback(uintptr_t PC, size_t CmpSize, size_t CmpType,
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000288 uint64_t Arg1, uint64_t Arg2, dfsan_label L1,
289 dfsan_label L2) {
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000290 assert(ReallyHaveDFSan());
Kostya Serebryany226b7342016-01-06 00:03:35 +0000291 if (!RecordingTraces || !IsMyThread) return;
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000292 if (L1 == 0 && L2 == 0)
293 return; // Not actionable.
294 if (L1 != 0 && L2 != 0)
295 return; // Probably still actionable.
296 bool Res = ComputeCmp(CmpSize, CmpType, Arg1, Arg2);
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000297 uint64_t Data = L1 ? Arg2 : Arg1;
298 LabelRange LR = L1 ? GetLabelRange(L1) : GetLabelRange(L2);
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000299
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000300 for (size_t Pos = LR.Beg; Pos + CmpSize <= LR.End; Pos++) {
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000301 AddMutation(Pos, CmpSize, Data);
302 AddMutation(Pos, CmpSize, Data + 1);
303 AddMutation(Pos, CmpSize, Data - 1);
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000304 }
305
306 if (CmpSize > LR.End - LR.Beg)
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000307 AddMutation(LR.Beg, (unsigned)(LR.End - LR.Beg), Data);
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000308
309
310 if (Options.Verbosity >= 3)
Kostya Serebryanyae7df1c2015-07-28 01:25:00 +0000311 Printf("DFSanCmpCallback: PC %lx S %zd T %zd A1 %llx A2 %llx R %d L1 %d L2 "
312 "%d MU %zd\n",
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000313 PC, CmpSize, CmpType, Arg1, Arg2, Res, L1, L2, NumMutations);
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000314}
315
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000316void TraceState::DFSanMemcmpCallback(size_t CmpSize, const uint8_t *Data1,
317 const uint8_t *Data2, dfsan_label L1,
318 dfsan_label L2) {
319
320 assert(ReallyHaveDFSan());
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000321 if (!RecordingMemcmp || !IsMyThread) return;
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000322 if (L1 == 0 && L2 == 0)
323 return; // Not actionable.
324 if (L1 != 0 && L2 != 0)
325 return; // Probably still actionable.
326
327 const uint8_t *Data = L1 ? Data2 : Data1;
328 LabelRange LR = L1 ? GetLabelRange(L1) : GetLabelRange(L2);
329 for (size_t Pos = LR.Beg; Pos + CmpSize <= LR.End; Pos++) {
330 AddMutation(Pos, CmpSize, Data);
331 if (Options.Verbosity >= 3)
332 Printf("DFSanMemcmpCallback: Pos %d Size %d\n", Pos, CmpSize);
333 }
334}
335
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000336void TraceState::DFSanSwitchCallback(uint64_t PC, size_t ValSizeInBits,
337 uint64_t Val, size_t NumCases,
338 uint64_t *Cases, dfsan_label L) {
339 assert(ReallyHaveDFSan());
Kostya Serebryany226b7342016-01-06 00:03:35 +0000340 if (!RecordingTraces || !IsMyThread) return;
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000341 if (!L) return; // Not actionable.
342 LabelRange LR = GetLabelRange(L);
343 size_t ValSize = ValSizeInBits / 8;
Kostya Serebryanyfe7e41e2015-07-31 20:58:55 +0000344 bool TryShort = IsTwoByteData(Val);
345 for (size_t i = 0; i < NumCases; i++)
346 TryShort &= IsTwoByteData(Cases[i]);
347
348 for (size_t Pos = LR.Beg; Pos + ValSize <= LR.End; Pos++)
349 for (size_t i = 0; i < NumCases; i++)
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000350 AddMutation(Pos, ValSize, Cases[i]);
Kostya Serebryanyfe7e41e2015-07-31 20:58:55 +0000351
352 if (TryShort)
353 for (size_t Pos = LR.Beg; Pos + 2 <= LR.End; Pos++)
354 for (size_t i = 0; i < NumCases; i++)
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000355 AddMutation(Pos, 2, Cases[i]);
Kostya Serebryanyfe7e41e2015-07-31 20:58:55 +0000356
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000357 if (Options.Verbosity >= 3)
Kostya Serebryanyfe7e41e2015-07-31 20:58:55 +0000358 Printf("DFSanSwitchCallback: PC %lx Val %zd SZ %zd # %zd L %d: {%d, %d} "
359 "TryShort %d\n",
360 PC, Val, ValSize, NumCases, L, LR.Beg, LR.End, TryShort);
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000361}
362
Kostya Serebryany22526252015-05-11 21:16:27 +0000363int TraceState::TryToAddDesiredData(uint64_t PresentData, uint64_t DesiredData,
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000364 size_t DataSize) {
Kostya Serebryanyb5e98492016-01-22 01:04:58 +0000365 if (NumMutations >= kMaxMutations) return 0;
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000366 int Res = 0;
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000367 const uint8_t *Beg = *CurrentUnitData;
368 const uint8_t *End = Beg + *CurrentUnitSize;
Kostya Serebryanye641dd62015-09-04 22:32:25 +0000369 for (const uint8_t *Cur = Beg; Cur < End; Cur++) {
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000370 Cur = (uint8_t *)memmem(Cur, End - Cur, &PresentData, DataSize);
371 if (!Cur)
372 break;
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000373 size_t Pos = Cur - Beg;
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000374 assert(Pos < *CurrentUnitSize);
Kostya Serebryanye7583d22016-01-09 00:38:40 +0000375 AddMutation(Pos, DataSize, DesiredData);
376 AddMutation(Pos, DataSize, DesiredData + 1);
377 AddMutation(Pos, DataSize, DesiredData - 1);
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000378 Res++;
379 }
380 return Res;
381}
382
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000383int TraceState::TryToAddDesiredData(const uint8_t *PresentData,
384 const uint8_t *DesiredData,
385 size_t DataSize) {
Kostya Serebryanyb5e98492016-01-22 01:04:58 +0000386 if (NumMutations >= kMaxMutations) return 0;
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000387 int Res = 0;
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000388 const uint8_t *Beg = *CurrentUnitData;
389 const uint8_t *End = Beg + *CurrentUnitSize;
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000390 for (const uint8_t *Cur = Beg; Cur < End; Cur++) {
391 Cur = (uint8_t *)memmem(Cur, End - Cur, PresentData, DataSize);
392 if (!Cur)
393 break;
394 size_t Pos = Cur - Beg;
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000395 assert(Pos < *CurrentUnitSize);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000396 AddMutation(Pos, DataSize, DesiredData);
397 Res++;
398 }
399 return Res;
400}
401
Kostya Serebryanye641dd62015-09-04 22:32:25 +0000402void TraceState::TraceCmpCallback(uintptr_t PC, size_t CmpSize, size_t CmpType,
403 uint64_t Arg1, uint64_t Arg2) {
Kostya Serebryany226b7342016-01-06 00:03:35 +0000404 if (!RecordingTraces || !IsMyThread) return;
Kostya Serebryany859e86d2016-01-12 02:08:37 +0000405 if ((CmpType == ICMP_EQ || CmpType == ICMP_NE) && Arg1 == Arg2)
406 return; // No reason to mutate.
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000407 int Added = 0;
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000408 Added += TryToAddDesiredData(Arg1, Arg2, CmpSize);
409 Added += TryToAddDesiredData(Arg2, Arg1, CmpSize);
410 if (!Added && CmpSize == 4 && IsTwoByteData(Arg1) && IsTwoByteData(Arg2)) {
411 Added += TryToAddDesiredData(Arg1, Arg2, 2);
412 Added += TryToAddDesiredData(Arg2, Arg1, 2);
413 }
Kostya Serebryany859e86d2016-01-12 02:08:37 +0000414 if (Options.Verbosity >= 3 && Added)
415 Printf("TraceCmp %zd/%zd: %p %zd %zd\n", CmpSize, CmpType, PC, Arg1, Arg2);
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000416}
417
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000418void TraceState::TraceMemcmpCallback(size_t CmpSize, const uint8_t *Data1,
419 const uint8_t *Data2) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000420 if (!RecordingMemcmp || !IsMyThread) return;
Kostya Serebryany476f0ce2016-01-16 03:53:32 +0000421 CmpSize = std::min(CmpSize, Word::GetMaxSize());
Kostya Serebryany1f9c40d2016-01-09 03:46:08 +0000422 int Added2 = TryToAddDesiredData(Data1, Data2, CmpSize);
423 int Added1 = TryToAddDesiredData(Data2, Data1, CmpSize);
424 if ((Added1 || Added2) && Options.Verbosity >= 3) {
425 Printf("MemCmp Added %d%d: ", Added1, Added2);
Kostya Serebryany41740052016-01-12 02:36:59 +0000426 if (Added1) PrintASCII(Data1, CmpSize);
427 if (Added2) PrintASCII(Data2, CmpSize);
Kostya Serebryany1f9c40d2016-01-09 03:46:08 +0000428 Printf("\n");
429 }
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000430}
431
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000432void TraceState::TraceSwitchCallback(uintptr_t PC, size_t ValSizeInBits,
433 uint64_t Val, size_t NumCases,
434 uint64_t *Cases) {
Kostya Serebryany226b7342016-01-06 00:03:35 +0000435 if (!RecordingTraces || !IsMyThread) return;
Kostya Serebryanyfe7e41e2015-07-31 20:58:55 +0000436 size_t ValSize = ValSizeInBits / 8;
437 bool TryShort = IsTwoByteData(Val);
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000438 for (size_t i = 0; i < NumCases; i++)
Kostya Serebryanyfe7e41e2015-07-31 20:58:55 +0000439 TryShort &= IsTwoByteData(Cases[i]);
440
441 if (Options.Verbosity >= 3)
442 Printf("TraceSwitch: %p %zd # %zd; TryShort %d\n", PC, Val, NumCases,
443 TryShort);
444
445 for (size_t i = 0; i < NumCases; i++) {
446 TryToAddDesiredData(Val, Cases[i], ValSize);
447 if (TryShort)
448 TryToAddDesiredData(Val, Cases[i], 2);
449 }
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000450}
451
Kostya Serebryany22526252015-05-11 21:16:27 +0000452static TraceState *TS;
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000453
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000454void Fuzzer::StartTraceRecording() {
Kostya Serebryany22526252015-05-11 21:16:27 +0000455 if (!TS) return;
456 TS->StartTraceRecording();
Kostya Serebryanybeb24c32015-05-07 21:02:11 +0000457}
458
Kostya Serebryanyb65805a2016-01-09 03:08:58 +0000459void Fuzzer::StopTraceRecording() {
460 if (!TS) return;
461 TS->StopTraceRecording();
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000462}
463
Kostya Serebryanyd50a3ee2016-01-13 23:02:30 +0000464void Fuzzer::AssignTaintLabels(uint8_t *Data, size_t Size) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000465 if (!Options.UseTraces && !Options.UseMemcmp) return;
Kostya Serebryanyd50a3ee2016-01-13 23:02:30 +0000466 if (!ReallyHaveDFSan()) return;
467 for (size_t i = 0; i < Size; i++)
468 dfsan_set_label(i + 1, &Data[i], 1);
469}
470
Kostya Serebryany22526252015-05-11 21:16:27 +0000471void Fuzzer::InitializeTraceState() {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000472 if (!Options.UseTraces && !Options.UseMemcmp) return;
Kostya Serebryany98abb2c2016-01-13 23:46:01 +0000473 TS = new TraceState(USF, Options, &CurrentUnitData, &CurrentUnitSize);
Kostya Serebryanyd50a3ee2016-01-13 23:02:30 +0000474 if (ReallyHaveDFSan()) {
475 for (size_t i = 0; i < static_cast<size_t>(Options.MaxLen); i++) {
476 dfsan_label L = dfsan_create_label("input", (void *)(i + 1));
477 // We assume that no one else has called dfsan_create_label before.
478 if (L != i + 1) {
479 Printf("DFSan labels are not starting from 1, exiting\n");
480 exit(1);
481 }
Kostya Serebryanyd46369d2015-08-05 23:44:42 +0000482 }
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000483 }
484}
485
Kostya Serebryanyc9dc96b2015-07-30 21:22:22 +0000486static size_t InternalStrnlen(const char *S, size_t MaxLen) {
487 size_t Len = 0;
488 for (; Len < MaxLen && S[Len]; Len++) {}
489 return Len;
490}
491
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000492} // namespace fuzzer
493
Kostya Serebryany22526252015-05-11 21:16:27 +0000494using fuzzer::TS;
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000495using fuzzer::RecordingTraces;
496using fuzzer::RecordingMemcmp;
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000497
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000498extern "C" {
499void __dfsw___sanitizer_cov_trace_cmp(uint64_t SizeAndType, uint64_t Arg1,
500 uint64_t Arg2, dfsan_label L0,
501 dfsan_label L1, dfsan_label L2) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000502 if (!RecordingTraces) return;
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000503 assert(L0 == 0);
504 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
505 uint64_t CmpSize = (SizeAndType >> 32) / 8;
506 uint64_t Type = (SizeAndType << 32) >> 32;
Kostya Serebryany22526252015-05-11 21:16:27 +0000507 TS->DFSanCmpCallback(PC, CmpSize, Type, Arg1, Arg2, L1, L2);
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000508}
Kostya Serebryanya407dde2015-05-07 00:11:33 +0000509
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000510void __dfsw___sanitizer_cov_trace_switch(uint64_t Val, uint64_t *Cases,
511 dfsan_label L1, dfsan_label L2) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000512 if (!RecordingTraces) return;
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000513 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
514 TS->DFSanSwitchCallback(PC, Cases[1], Val, Cases[0], Cases+2, L1);
515}
516
Kostya Serebryanya407dde2015-05-07 00:11:33 +0000517void dfsan_weak_hook_memcmp(void *caller_pc, const void *s1, const void *s2,
518 size_t n, dfsan_label s1_label,
519 dfsan_label s2_label, dfsan_label n_label) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000520 if (!RecordingMemcmp) return;
Kostya Serebryanya407dde2015-05-07 00:11:33 +0000521 dfsan_label L1 = dfsan_read_label(s1, n);
522 dfsan_label L2 = dfsan_read_label(s2, n);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000523 TS->DFSanMemcmpCallback(n, reinterpret_cast<const uint8_t *>(s1),
524 reinterpret_cast<const uint8_t *>(s2), L1, L2);
Kostya Serebryanya407dde2015-05-07 00:11:33 +0000525}
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000526
Kostya Serebryanyb74ba422015-07-30 02:33:45 +0000527void dfsan_weak_hook_strncmp(void *caller_pc, const char *s1, const char *s2,
528 size_t n, dfsan_label s1_label,
529 dfsan_label s2_label, dfsan_label n_label) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000530 if (!RecordingMemcmp) return;
Kostya Serebryanyc9dc96b2015-07-30 21:22:22 +0000531 n = std::min(n, fuzzer::InternalStrnlen(s1, n));
532 n = std::min(n, fuzzer::InternalStrnlen(s2, n));
Kostya Serebryanyc9dc96b2015-07-30 21:22:22 +0000533 dfsan_label L1 = dfsan_read_label(s1, n);
534 dfsan_label L2 = dfsan_read_label(s2, n);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000535 TS->DFSanMemcmpCallback(n, reinterpret_cast<const uint8_t *>(s1),
536 reinterpret_cast<const uint8_t *>(s2), L1, L2);
Kostya Serebryanyb74ba422015-07-30 02:33:45 +0000537}
538
Kostya Serebryany7f4227d2015-08-05 18:23:01 +0000539void dfsan_weak_hook_strcmp(void *caller_pc, const char *s1, const char *s2,
540 dfsan_label s1_label, dfsan_label s2_label) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000541 if (!RecordingMemcmp) return;
Kostya Serebryany7f4227d2015-08-05 18:23:01 +0000542 size_t Len1 = strlen(s1);
543 size_t Len2 = strlen(s2);
544 size_t N = std::min(Len1, Len2);
545 if (N <= 1) return; // Not interesting.
Kostya Serebryany7f4227d2015-08-05 18:23:01 +0000546 dfsan_label L1 = dfsan_read_label(s1, Len1);
547 dfsan_label L2 = dfsan_read_label(s2, Len2);
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000548 TS->DFSanMemcmpCallback(N, reinterpret_cast<const uint8_t *>(s1),
549 reinterpret_cast<const uint8_t *>(s2), L1, L2);
Kostya Serebryany7f4227d2015-08-05 18:23:01 +0000550}
551
Kostya Serebryany4b83a4f2016-01-12 16:50:18 +0000552// We may need to avoid defining weak hooks to stay compatible with older clang.
553#ifndef LLVM_FUZZER_DEFINES_SANITIZER_WEAK_HOOOKS
554# define LLVM_FUZZER_DEFINES_SANITIZER_WEAK_HOOOKS 1
555#endif
556
557#if LLVM_FUZZER_DEFINES_SANITIZER_WEAK_HOOOKS
Kostya Serebryany0e776a22015-07-30 01:34:58 +0000558void __sanitizer_weak_hook_memcmp(void *caller_pc, const void *s1,
Kostya Serebryanye3580952016-01-12 00:43:42 +0000559 const void *s2, size_t n, int result) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000560 if (!RecordingMemcmp) return;
Kostya Serebryanye3580952016-01-12 00:43:42 +0000561 if (result == 0) return; // No reason to mutate.
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000562 if (n <= 1) return; // Not interesting.
563 TS->TraceMemcmpCallback(n, reinterpret_cast<const uint8_t *>(s1),
564 reinterpret_cast<const uint8_t *>(s2));
Kostya Serebryanyb74ba422015-07-30 02:33:45 +0000565}
566
567void __sanitizer_weak_hook_strncmp(void *caller_pc, const char *s1,
Kostya Serebryanye3580952016-01-12 00:43:42 +0000568 const char *s2, size_t n, int result) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000569 if (!RecordingMemcmp) return;
Kostya Serebryanye3580952016-01-12 00:43:42 +0000570 if (result == 0) return; // No reason to mutate.
Kostya Serebryanycd6a4662015-07-31 17:05:05 +0000571 size_t Len1 = fuzzer::InternalStrnlen(s1, n);
572 size_t Len2 = fuzzer::InternalStrnlen(s2, n);
573 n = std::min(n, Len1);
574 n = std::min(n, Len2);
575 if (n <= 1) return; // Not interesting.
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000576 TS->TraceMemcmpCallback(n, reinterpret_cast<const uint8_t *>(s1),
577 reinterpret_cast<const uint8_t *>(s2));
Kostya Serebryany0e776a22015-07-30 01:34:58 +0000578}
579
Kostya Serebryany7f4227d2015-08-05 18:23:01 +0000580void __sanitizer_weak_hook_strcmp(void *caller_pc, const char *s1,
Kostya Serebryanye3580952016-01-12 00:43:42 +0000581 const char *s2, int result) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000582 if (!RecordingMemcmp) return;
Kostya Serebryanye3580952016-01-12 00:43:42 +0000583 if (result == 0) return; // No reason to mutate.
Kostya Serebryany7f4227d2015-08-05 18:23:01 +0000584 size_t Len1 = strlen(s1);
585 size_t Len2 = strlen(s2);
586 size_t N = std::min(Len1, Len2);
587 if (N <= 1) return; // Not interesting.
Kostya Serebryanyc5733162016-01-09 01:39:55 +0000588 TS->TraceMemcmpCallback(N, reinterpret_cast<const uint8_t *>(s1),
589 reinterpret_cast<const uint8_t *>(s2));
Kostya Serebryany7f4227d2015-08-05 18:23:01 +0000590}
591
Kostya Serebryany4b83a4f2016-01-12 16:50:18 +0000592#endif // LLVM_FUZZER_DEFINES_SANITIZER_WEAK_HOOOKS
593
Kostya Serebryany3287d7a2015-09-30 22:22:37 +0000594__attribute__((visibility("default")))
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000595void __sanitizer_cov_trace_cmp(uint64_t SizeAndType, uint64_t Arg1,
596 uint64_t Arg2) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000597 if (!RecordingTraces) return;
Kostya Serebryany35959592015-07-28 00:59:53 +0000598 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
Kostya Serebryany5a99ecb2015-05-11 20:51:19 +0000599 uint64_t CmpSize = (SizeAndType >> 32) / 8;
600 uint64_t Type = (SizeAndType << 32) >> 32;
Kostya Serebryany35959592015-07-28 00:59:53 +0000601 TS->TraceCmpCallback(PC, CmpSize, Type, Arg1, Arg2);
Kostya Serebryany7d470cf2015-05-07 18:32:29 +0000602}
603
Kostya Serebryany3287d7a2015-09-30 22:22:37 +0000604__attribute__((visibility("default")))
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000605void __sanitizer_cov_trace_switch(uint64_t Val, uint64_t *Cases) {
Kostya Serebryanyae5b9562016-01-15 06:24:05 +0000606 if (!RecordingTraces) return;
Kostya Serebryanyfb7d8d92015-07-31 01:33:06 +0000607 uintptr_t PC = reinterpret_cast<uintptr_t>(__builtin_return_address(0));
608 TS->TraceSwitchCallback(PC, Cases[1], Val, Cases[0], Cases + 2);
609}
610
Kostya Serebryany16d03bd2015-03-30 22:09:51 +0000611} // extern "C"