1c5d72517SMarco Vanotti //===- FuzzerMutate.cpp - Mutate a test input -----------------------------===//
210ab2aceSGeorge Karpenkov //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
610ab2aceSGeorge Karpenkov //
710ab2aceSGeorge Karpenkov //===----------------------------------------------------------------------===//
8c5d72517SMarco Vanotti // Mutate a test input.
910ab2aceSGeorge Karpenkov //===----------------------------------------------------------------------===//
1010ab2aceSGeorge Karpenkov
11c5d72517SMarco Vanotti #include "FuzzerDefs.h"
1210ab2aceSGeorge Karpenkov #include "FuzzerExtFunctions.h"
1310ab2aceSGeorge Karpenkov #include "FuzzerIO.h"
14c5d72517SMarco Vanotti #include "FuzzerMutate.h"
15c5d72517SMarco Vanotti #include "FuzzerOptions.h"
160719b352SKostya Serebryany #include "FuzzerTracePC.h"
1710ab2aceSGeorge Karpenkov
1810ab2aceSGeorge Karpenkov namespace fuzzer {
1910ab2aceSGeorge Karpenkov
20c5d72517SMarco Vanotti const size_t Dictionary::kMaxDictSize;
21c5d72517SMarco Vanotti static const size_t kMaxMutationsToPrint = 10;
22c5d72517SMarco Vanotti
PrintASCII(const Word & W,const char * PrintAfter)23c5d72517SMarco Vanotti static void PrintASCII(const Word &W, const char *PrintAfter) {
24c5d72517SMarco Vanotti PrintASCII(W.data(), W.size(), PrintAfter);
2510ab2aceSGeorge Karpenkov }
2610ab2aceSGeorge Karpenkov
MutationDispatcher(Random & Rand,const FuzzingOptions & Options)27c5d72517SMarco Vanotti MutationDispatcher::MutationDispatcher(Random &Rand,
28c5d72517SMarco Vanotti const FuzzingOptions &Options)
29c5d72517SMarco Vanotti : Rand(Rand), Options(Options) {
30c5d72517SMarco Vanotti DefaultMutators.insert(
31c5d72517SMarco Vanotti DefaultMutators.begin(),
32c5d72517SMarco Vanotti {
33c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_EraseBytes, "EraseBytes"},
34c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_InsertByte, "InsertByte"},
35c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_InsertRepeatedBytes,
36c5d72517SMarco Vanotti "InsertRepeatedBytes"},
37c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_ChangeByte, "ChangeByte"},
38c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_ChangeBit, "ChangeBit"},
39c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_ShuffleBytes, "ShuffleBytes"},
40c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_ChangeASCIIInteger, "ChangeASCIIInt"},
41c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_ChangeBinaryInteger, "ChangeBinInt"},
42c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_CopyPart, "CopyPart"},
43c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_CrossOver, "CrossOver"},
44c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_AddWordFromManualDictionary,
45c5d72517SMarco Vanotti "ManualDict"},
46c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_AddWordFromPersistentAutoDictionary,
47c5d72517SMarco Vanotti "PersAutoDict"},
48c5d72517SMarco Vanotti });
49c5d72517SMarco Vanotti if(Options.UseCmp)
50c5d72517SMarco Vanotti DefaultMutators.push_back(
51c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_AddWordFromTORC, "CMP"});
52c5d72517SMarco Vanotti
53c5d72517SMarco Vanotti if (EF->LLVMFuzzerCustomMutator)
54c5d72517SMarco Vanotti Mutators.push_back({&MutationDispatcher::Mutate_Custom, "Custom"});
55c5d72517SMarco Vanotti else
56c5d72517SMarco Vanotti Mutators = DefaultMutators;
57c5d72517SMarco Vanotti
58c5d72517SMarco Vanotti if (EF->LLVMFuzzerCustomCrossOver)
59c5d72517SMarco Vanotti Mutators.push_back(
60c5d72517SMarco Vanotti {&MutationDispatcher::Mutate_CustomCrossOver, "CustomCrossOver"});
6110ab2aceSGeorge Karpenkov }
6210ab2aceSGeorge Karpenkov
RandCh(Random & Rand)63c5d72517SMarco Vanotti static char RandCh(Random &Rand) {
64c5d72517SMarco Vanotti if (Rand.RandBool())
65c5d72517SMarco Vanotti return static_cast<char>(Rand(256));
66c5d72517SMarco Vanotti const char Special[] = "!*'();:@&=+$,/?%#[]012Az-`~.\xff\x00";
67c5d72517SMarco Vanotti return Special[Rand(sizeof(Special) - 1)];
6810ab2aceSGeorge Karpenkov }
6910ab2aceSGeorge Karpenkov
Mutate_Custom(uint8_t * Data,size_t Size,size_t MaxSize)70c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_Custom(uint8_t *Data, size_t Size,
71c5d72517SMarco Vanotti size_t MaxSize) {
72c5d72517SMarco Vanotti if (EF->__msan_unpoison)
73c5d72517SMarco Vanotti EF->__msan_unpoison(Data, Size);
74c5d72517SMarco Vanotti if (EF->__msan_unpoison_param)
75c5d72517SMarco Vanotti EF->__msan_unpoison_param(4);
76c5d72517SMarco Vanotti return EF->LLVMFuzzerCustomMutator(Data, Size, MaxSize,
77c5d72517SMarco Vanotti Rand.Rand<unsigned int>());
7810ab2aceSGeorge Karpenkov }
7910ab2aceSGeorge Karpenkov
Mutate_CustomCrossOver(uint8_t * Data,size_t Size,size_t MaxSize)80c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_CustomCrossOver(uint8_t *Data, size_t Size,
81c5d72517SMarco Vanotti size_t MaxSize) {
82c5d72517SMarco Vanotti if (Size == 0)
83c5d72517SMarco Vanotti return 0;
84c5d72517SMarco Vanotti if (!CrossOverWith) return 0;
85c5d72517SMarco Vanotti const Unit &Other = *CrossOverWith;
86c5d72517SMarco Vanotti if (Other.empty())
87c5d72517SMarco Vanotti return 0;
88c5d72517SMarco Vanotti CustomCrossOverInPlaceHere.resize(MaxSize);
89c5d72517SMarco Vanotti auto &U = CustomCrossOverInPlaceHere;
90c5d72517SMarco Vanotti
91c5d72517SMarco Vanotti if (EF->__msan_unpoison) {
92c5d72517SMarco Vanotti EF->__msan_unpoison(Data, Size);
93c5d72517SMarco Vanotti EF->__msan_unpoison(Other.data(), Other.size());
94c5d72517SMarco Vanotti EF->__msan_unpoison(U.data(), U.size());
95c5d72517SMarco Vanotti }
96c5d72517SMarco Vanotti if (EF->__msan_unpoison_param)
97c5d72517SMarco Vanotti EF->__msan_unpoison_param(7);
98c5d72517SMarco Vanotti size_t NewSize = EF->LLVMFuzzerCustomCrossOver(
99c5d72517SMarco Vanotti Data, Size, Other.data(), Other.size(), U.data(), U.size(),
100c5d72517SMarco Vanotti Rand.Rand<unsigned int>());
101c5d72517SMarco Vanotti
102c5d72517SMarco Vanotti if (!NewSize)
103c5d72517SMarco Vanotti return 0;
104c5d72517SMarco Vanotti assert(NewSize <= MaxSize && "CustomCrossOver returned overisized unit");
105c5d72517SMarco Vanotti memcpy(Data, U.data(), NewSize);
106c5d72517SMarco Vanotti return NewSize;
10710ab2aceSGeorge Karpenkov }
10810ab2aceSGeorge Karpenkov
Mutate_ShuffleBytes(uint8_t * Data,size_t Size,size_t MaxSize)109c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_ShuffleBytes(uint8_t *Data, size_t Size,
110c5d72517SMarco Vanotti size_t MaxSize) {
111c5d72517SMarco Vanotti if (Size > MaxSize || Size == 0) return 0;
112c5d72517SMarco Vanotti size_t ShuffleAmount =
113c5d72517SMarco Vanotti Rand(std::min(Size, (size_t)8)) + 1; // [1,8] and <= Size.
114c5d72517SMarco Vanotti size_t ShuffleStart = Rand(Size - ShuffleAmount);
115c5d72517SMarco Vanotti assert(ShuffleStart + ShuffleAmount <= Size);
116c5d72517SMarco Vanotti std::shuffle(Data + ShuffleStart, Data + ShuffleStart + ShuffleAmount, Rand);
117c5d72517SMarco Vanotti return Size;
11810ab2aceSGeorge Karpenkov }
11910ab2aceSGeorge Karpenkov
Mutate_EraseBytes(uint8_t * Data,size_t Size,size_t MaxSize)120c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_EraseBytes(uint8_t *Data, size_t Size,
121c5d72517SMarco Vanotti size_t MaxSize) {
122c5d72517SMarco Vanotti if (Size <= 1) return 0;
123c5d72517SMarco Vanotti size_t N = Rand(Size / 2) + 1;
124c5d72517SMarco Vanotti assert(N < Size);
125c5d72517SMarco Vanotti size_t Idx = Rand(Size - N + 1);
126c5d72517SMarco Vanotti // Erase Data[Idx:Idx+N].
127c5d72517SMarco Vanotti memmove(Data + Idx, Data + Idx + N, Size - Idx - N);
128c5d72517SMarco Vanotti // Printf("Erase: %zd %zd => %zd; Idx %zd\n", N, Size, Size - N, Idx);
129c5d72517SMarco Vanotti return Size - N;
130c5d72517SMarco Vanotti }
131c5d72517SMarco Vanotti
Mutate_InsertByte(uint8_t * Data,size_t Size,size_t MaxSize)132c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_InsertByte(uint8_t *Data, size_t Size,
133c5d72517SMarco Vanotti size_t MaxSize) {
134c5d72517SMarco Vanotti if (Size >= MaxSize) return 0;
135c5d72517SMarco Vanotti size_t Idx = Rand(Size + 1);
136c5d72517SMarco Vanotti // Insert new value at Data[Idx].
137c5d72517SMarco Vanotti memmove(Data + Idx + 1, Data + Idx, Size - Idx);
138c5d72517SMarco Vanotti Data[Idx] = RandCh(Rand);
139c5d72517SMarco Vanotti return Size + 1;
140c5d72517SMarco Vanotti }
141c5d72517SMarco Vanotti
Mutate_InsertRepeatedBytes(uint8_t * Data,size_t Size,size_t MaxSize)142c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_InsertRepeatedBytes(uint8_t *Data,
143c5d72517SMarco Vanotti size_t Size,
144c5d72517SMarco Vanotti size_t MaxSize) {
145c5d72517SMarco Vanotti const size_t kMinBytesToInsert = 3;
146c5d72517SMarco Vanotti if (Size + kMinBytesToInsert >= MaxSize) return 0;
147c5d72517SMarco Vanotti size_t MaxBytesToInsert = std::min(MaxSize - Size, (size_t)128);
148c5d72517SMarco Vanotti size_t N = Rand(MaxBytesToInsert - kMinBytesToInsert + 1) + kMinBytesToInsert;
149c5d72517SMarco Vanotti assert(Size + N <= MaxSize && N);
150c5d72517SMarco Vanotti size_t Idx = Rand(Size + 1);
151c5d72517SMarco Vanotti // Insert new values at Data[Idx].
152c5d72517SMarco Vanotti memmove(Data + Idx + N, Data + Idx, Size - Idx);
153c5d72517SMarco Vanotti // Give preference to 0x00 and 0xff.
154c5d72517SMarco Vanotti uint8_t Byte = static_cast<uint8_t>(
155c5d72517SMarco Vanotti Rand.RandBool() ? Rand(256) : (Rand.RandBool() ? 0 : 255));
156c5d72517SMarco Vanotti for (size_t i = 0; i < N; i++)
157c5d72517SMarco Vanotti Data[Idx + i] = Byte;
158c5d72517SMarco Vanotti return Size + N;
159c5d72517SMarco Vanotti }
160c5d72517SMarco Vanotti
Mutate_ChangeByte(uint8_t * Data,size_t Size,size_t MaxSize)161c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_ChangeByte(uint8_t *Data, size_t Size,
162c5d72517SMarco Vanotti size_t MaxSize) {
163c5d72517SMarco Vanotti if (Size > MaxSize) return 0;
164c5d72517SMarco Vanotti size_t Idx = Rand(Size);
165c5d72517SMarco Vanotti Data[Idx] = RandCh(Rand);
166c5d72517SMarco Vanotti return Size;
167c5d72517SMarco Vanotti }
168c5d72517SMarco Vanotti
Mutate_ChangeBit(uint8_t * Data,size_t Size,size_t MaxSize)169c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_ChangeBit(uint8_t *Data, size_t Size,
170c5d72517SMarco Vanotti size_t MaxSize) {
171c5d72517SMarco Vanotti if (Size > MaxSize) return 0;
172c5d72517SMarco Vanotti size_t Idx = Rand(Size);
173c5d72517SMarco Vanotti Data[Idx] ^= 1 << Rand(8);
174c5d72517SMarco Vanotti return Size;
175c5d72517SMarco Vanotti }
176c5d72517SMarco Vanotti
Mutate_AddWordFromManualDictionary(uint8_t * Data,size_t Size,size_t MaxSize)177c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_AddWordFromManualDictionary(uint8_t *Data,
178c5d72517SMarco Vanotti size_t Size,
179c5d72517SMarco Vanotti size_t MaxSize) {
180c5d72517SMarco Vanotti return AddWordFromDictionary(ManualDictionary, Data, Size, MaxSize);
181c5d72517SMarco Vanotti }
182c5d72517SMarco Vanotti
ApplyDictionaryEntry(uint8_t * Data,size_t Size,size_t MaxSize,DictionaryEntry & DE)183c5d72517SMarco Vanotti size_t MutationDispatcher::ApplyDictionaryEntry(uint8_t *Data, size_t Size,
184c5d72517SMarco Vanotti size_t MaxSize,
185c5d72517SMarco Vanotti DictionaryEntry &DE) {
186c5d72517SMarco Vanotti const Word &W = DE.GetW();
187c5d72517SMarco Vanotti bool UsePositionHint = DE.HasPositionHint() &&
188c5d72517SMarco Vanotti DE.GetPositionHint() + W.size() < Size &&
189c5d72517SMarco Vanotti Rand.RandBool();
190c5d72517SMarco Vanotti if (Rand.RandBool()) { // Insert W.
191c5d72517SMarco Vanotti if (Size + W.size() > MaxSize) return 0;
192c5d72517SMarco Vanotti size_t Idx = UsePositionHint ? DE.GetPositionHint() : Rand(Size + 1);
193c5d72517SMarco Vanotti memmove(Data + Idx + W.size(), Data + Idx, Size - Idx);
194c5d72517SMarco Vanotti memcpy(Data + Idx, W.data(), W.size());
195c5d72517SMarco Vanotti Size += W.size();
196c5d72517SMarco Vanotti } else { // Overwrite some bytes with W.
197c5d72517SMarco Vanotti if (W.size() > Size) return 0;
198c5d72517SMarco Vanotti size_t Idx =
199c5d72517SMarco Vanotti UsePositionHint ? DE.GetPositionHint() : Rand(Size + 1 - W.size());
200c5d72517SMarco Vanotti memcpy(Data + Idx, W.data(), W.size());
201c5d72517SMarco Vanotti }
202c5d72517SMarco Vanotti return Size;
203c5d72517SMarco Vanotti }
204c5d72517SMarco Vanotti
205c5d72517SMarco Vanotti // Somewhere in the past we have observed a comparison instructions
206c5d72517SMarco Vanotti // with arguments Arg1 Arg2. This function tries to guess a dictionary
207c5d72517SMarco Vanotti // entry that will satisfy that comparison.
208c5d72517SMarco Vanotti // It first tries to find one of the arguments (possibly swapped) in the
209c5d72517SMarco Vanotti // input and if it succeeds it creates a DE with a position hint.
210c5d72517SMarco Vanotti // Otherwise it creates a DE with one of the arguments w/o a position hint.
MakeDictionaryEntryFromCMP(const void * Arg1,const void * Arg2,const void * Arg1Mutation,const void * Arg2Mutation,size_t ArgSize,const uint8_t * Data,size_t Size)211c5d72517SMarco Vanotti DictionaryEntry MutationDispatcher::MakeDictionaryEntryFromCMP(
212c5d72517SMarco Vanotti const void *Arg1, const void *Arg2,
213c5d72517SMarco Vanotti const void *Arg1Mutation, const void *Arg2Mutation,
214c5d72517SMarco Vanotti size_t ArgSize, const uint8_t *Data,
215c5d72517SMarco Vanotti size_t Size) {
216c5d72517SMarco Vanotti bool HandleFirst = Rand.RandBool();
217c5d72517SMarco Vanotti const void *ExistingBytes, *DesiredBytes;
218c5d72517SMarco Vanotti Word W;
219c5d72517SMarco Vanotti const uint8_t *End = Data + Size;
220c5d72517SMarco Vanotti for (int Arg = 0; Arg < 2; Arg++) {
221c5d72517SMarco Vanotti ExistingBytes = HandleFirst ? Arg1 : Arg2;
222c5d72517SMarco Vanotti DesiredBytes = HandleFirst ? Arg2Mutation : Arg1Mutation;
223c5d72517SMarco Vanotti HandleFirst = !HandleFirst;
224c5d72517SMarco Vanotti W.Set(reinterpret_cast<const uint8_t*>(DesiredBytes), ArgSize);
225c5d72517SMarco Vanotti const size_t kMaxNumPositions = 8;
226c5d72517SMarco Vanotti size_t Positions[kMaxNumPositions];
227c5d72517SMarco Vanotti size_t NumPositions = 0;
228c5d72517SMarco Vanotti for (const uint8_t *Cur = Data;
229c5d72517SMarco Vanotti Cur < End && NumPositions < kMaxNumPositions; Cur++) {
230c5d72517SMarco Vanotti Cur =
231c5d72517SMarco Vanotti (const uint8_t *)SearchMemory(Cur, End - Cur, ExistingBytes, ArgSize);
232c5d72517SMarco Vanotti if (!Cur) break;
233c5d72517SMarco Vanotti Positions[NumPositions++] = Cur - Data;
234c5d72517SMarco Vanotti }
235c5d72517SMarco Vanotti if (!NumPositions) continue;
236c5d72517SMarco Vanotti return DictionaryEntry(W, Positions[Rand(NumPositions)]);
237c5d72517SMarco Vanotti }
238c5d72517SMarco Vanotti DictionaryEntry DE(W);
239c5d72517SMarco Vanotti return DE;
240c5d72517SMarco Vanotti }
241c5d72517SMarco Vanotti
242c5d72517SMarco Vanotti
243c5d72517SMarco Vanotti template <class T>
MakeDictionaryEntryFromCMP(T Arg1,T Arg2,const uint8_t * Data,size_t Size)244c5d72517SMarco Vanotti DictionaryEntry MutationDispatcher::MakeDictionaryEntryFromCMP(
245c5d72517SMarco Vanotti T Arg1, T Arg2, const uint8_t *Data, size_t Size) {
246c5d72517SMarco Vanotti if (Rand.RandBool()) Arg1 = Bswap(Arg1);
247c5d72517SMarco Vanotti if (Rand.RandBool()) Arg2 = Bswap(Arg2);
248c5d72517SMarco Vanotti T Arg1Mutation = static_cast<T>(Arg1 + Rand(-1, 1));
249c5d72517SMarco Vanotti T Arg2Mutation = static_cast<T>(Arg2 + Rand(-1, 1));
250c5d72517SMarco Vanotti return MakeDictionaryEntryFromCMP(&Arg1, &Arg2, &Arg1Mutation, &Arg2Mutation,
251c5d72517SMarco Vanotti sizeof(Arg1), Data, Size);
252c5d72517SMarco Vanotti }
253c5d72517SMarco Vanotti
MakeDictionaryEntryFromCMP(const Word & Arg1,const Word & Arg2,const uint8_t * Data,size_t Size)254c5d72517SMarco Vanotti DictionaryEntry MutationDispatcher::MakeDictionaryEntryFromCMP(
255c5d72517SMarco Vanotti const Word &Arg1, const Word &Arg2, const uint8_t *Data, size_t Size) {
256c5d72517SMarco Vanotti return MakeDictionaryEntryFromCMP(Arg1.data(), Arg2.data(), Arg1.data(),
257c5d72517SMarco Vanotti Arg2.data(), Arg1.size(), Data, Size);
258c5d72517SMarco Vanotti }
259c5d72517SMarco Vanotti
Mutate_AddWordFromTORC(uint8_t * Data,size_t Size,size_t MaxSize)260c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_AddWordFromTORC(
261c5d72517SMarco Vanotti uint8_t *Data, size_t Size, size_t MaxSize) {
262c5d72517SMarco Vanotti Word W;
263c5d72517SMarco Vanotti DictionaryEntry DE;
264c5d72517SMarco Vanotti switch (Rand(4)) {
265c5d72517SMarco Vanotti case 0: {
266c5d72517SMarco Vanotti auto X = TPC.TORC8.Get(Rand.Rand<size_t>());
267c5d72517SMarco Vanotti DE = MakeDictionaryEntryFromCMP(X.A, X.B, Data, Size);
268c5d72517SMarco Vanotti } break;
269c5d72517SMarco Vanotti case 1: {
270c5d72517SMarco Vanotti auto X = TPC.TORC4.Get(Rand.Rand<size_t>());
271c5d72517SMarco Vanotti if ((X.A >> 16) == 0 && (X.B >> 16) == 0 && Rand.RandBool())
272c5d72517SMarco Vanotti DE = MakeDictionaryEntryFromCMP((uint16_t)X.A, (uint16_t)X.B, Data, Size);
273c5d72517SMarco Vanotti else
274c5d72517SMarco Vanotti DE = MakeDictionaryEntryFromCMP(X.A, X.B, Data, Size);
275c5d72517SMarco Vanotti } break;
276c5d72517SMarco Vanotti case 2: {
277c5d72517SMarco Vanotti auto X = TPC.TORCW.Get(Rand.Rand<size_t>());
278c5d72517SMarco Vanotti DE = MakeDictionaryEntryFromCMP(X.A, X.B, Data, Size);
279c5d72517SMarco Vanotti } break;
280c5d72517SMarco Vanotti case 3: if (Options.UseMemmem) {
281c5d72517SMarco Vanotti auto X = TPC.MMT.Get(Rand.Rand<size_t>());
282c5d72517SMarco Vanotti DE = DictionaryEntry(X);
283c5d72517SMarco Vanotti } break;
284c5d72517SMarco Vanotti default:
285c5d72517SMarco Vanotti assert(0);
286c5d72517SMarco Vanotti }
287c5d72517SMarco Vanotti if (!DE.GetW().size()) return 0;
288c5d72517SMarco Vanotti Size = ApplyDictionaryEntry(Data, Size, MaxSize, DE);
289c5d72517SMarco Vanotti if (!Size) return 0;
290c5d72517SMarco Vanotti DictionaryEntry &DERef =
291c5d72517SMarco Vanotti CmpDictionaryEntriesDeque[CmpDictionaryEntriesDequeIdx++ %
292c5d72517SMarco Vanotti kCmpDictionaryEntriesDequeSize];
293c5d72517SMarco Vanotti DERef = DE;
294c5d72517SMarco Vanotti CurrentDictionaryEntrySequence.push_back(&DERef);
295c5d72517SMarco Vanotti return Size;
296c5d72517SMarco Vanotti }
297c5d72517SMarco Vanotti
Mutate_AddWordFromPersistentAutoDictionary(uint8_t * Data,size_t Size,size_t MaxSize)298c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_AddWordFromPersistentAutoDictionary(
299c5d72517SMarco Vanotti uint8_t *Data, size_t Size, size_t MaxSize) {
300c5d72517SMarco Vanotti return AddWordFromDictionary(PersistentAutoDictionary, Data, Size, MaxSize);
301c5d72517SMarco Vanotti }
302c5d72517SMarco Vanotti
AddWordFromDictionary(Dictionary & D,uint8_t * Data,size_t Size,size_t MaxSize)303c5d72517SMarco Vanotti size_t MutationDispatcher::AddWordFromDictionary(Dictionary &D, uint8_t *Data,
304c5d72517SMarco Vanotti size_t Size, size_t MaxSize) {
305c5d72517SMarco Vanotti if (Size > MaxSize) return 0;
306c5d72517SMarco Vanotti if (D.empty()) return 0;
307c5d72517SMarco Vanotti DictionaryEntry &DE = D[Rand(D.size())];
308c5d72517SMarco Vanotti Size = ApplyDictionaryEntry(Data, Size, MaxSize, DE);
309c5d72517SMarco Vanotti if (!Size) return 0;
310c5d72517SMarco Vanotti DE.IncUseCount();
311c5d72517SMarco Vanotti CurrentDictionaryEntrySequence.push_back(&DE);
312c5d72517SMarco Vanotti return Size;
313c5d72517SMarco Vanotti }
314c5d72517SMarco Vanotti
315c5d72517SMarco Vanotti // Overwrites part of To[0,ToSize) with a part of From[0,FromSize).
316c5d72517SMarco Vanotti // Returns ToSize.
CopyPartOf(const uint8_t * From,size_t FromSize,uint8_t * To,size_t ToSize)317c5d72517SMarco Vanotti size_t MutationDispatcher::CopyPartOf(const uint8_t *From, size_t FromSize,
318c5d72517SMarco Vanotti uint8_t *To, size_t ToSize) {
319c5d72517SMarco Vanotti // Copy From[FromBeg, FromBeg + CopySize) into To[ToBeg, ToBeg + CopySize).
320c5d72517SMarco Vanotti size_t ToBeg = Rand(ToSize);
321c5d72517SMarco Vanotti size_t CopySize = Rand(ToSize - ToBeg) + 1;
322c5d72517SMarco Vanotti assert(ToBeg + CopySize <= ToSize);
323c5d72517SMarco Vanotti CopySize = std::min(CopySize, FromSize);
324c5d72517SMarco Vanotti size_t FromBeg = Rand(FromSize - CopySize + 1);
325c5d72517SMarco Vanotti assert(FromBeg + CopySize <= FromSize);
326c5d72517SMarco Vanotti memmove(To + ToBeg, From + FromBeg, CopySize);
327c5d72517SMarco Vanotti return ToSize;
328c5d72517SMarco Vanotti }
329c5d72517SMarco Vanotti
330c5d72517SMarco Vanotti // Inserts part of From[0,ToSize) into To.
331c5d72517SMarco Vanotti // Returns new size of To on success or 0 on failure.
InsertPartOf(const uint8_t * From,size_t FromSize,uint8_t * To,size_t ToSize,size_t MaxToSize)332c5d72517SMarco Vanotti size_t MutationDispatcher::InsertPartOf(const uint8_t *From, size_t FromSize,
333c5d72517SMarco Vanotti uint8_t *To, size_t ToSize,
334c5d72517SMarco Vanotti size_t MaxToSize) {
335c5d72517SMarco Vanotti if (ToSize >= MaxToSize) return 0;
336c5d72517SMarco Vanotti size_t AvailableSpace = MaxToSize - ToSize;
337c5d72517SMarco Vanotti size_t MaxCopySize = std::min(AvailableSpace, FromSize);
338c5d72517SMarco Vanotti size_t CopySize = Rand(MaxCopySize) + 1;
339c5d72517SMarco Vanotti size_t FromBeg = Rand(FromSize - CopySize + 1);
340c5d72517SMarco Vanotti assert(FromBeg + CopySize <= FromSize);
341c5d72517SMarco Vanotti size_t ToInsertPos = Rand(ToSize + 1);
342c5d72517SMarco Vanotti assert(ToInsertPos + CopySize <= MaxToSize);
343c5d72517SMarco Vanotti size_t TailSize = ToSize - ToInsertPos;
344c5d72517SMarco Vanotti if (To == From) {
345c5d72517SMarco Vanotti MutateInPlaceHere.resize(MaxToSize);
346c5d72517SMarco Vanotti memcpy(MutateInPlaceHere.data(), From + FromBeg, CopySize);
347c5d72517SMarco Vanotti memmove(To + ToInsertPos + CopySize, To + ToInsertPos, TailSize);
348c5d72517SMarco Vanotti memmove(To + ToInsertPos, MutateInPlaceHere.data(), CopySize);
349c5d72517SMarco Vanotti } else {
350c5d72517SMarco Vanotti memmove(To + ToInsertPos + CopySize, To + ToInsertPos, TailSize);
351c5d72517SMarco Vanotti memmove(To + ToInsertPos, From + FromBeg, CopySize);
352c5d72517SMarco Vanotti }
353c5d72517SMarco Vanotti return ToSize + CopySize;
354c5d72517SMarco Vanotti }
355c5d72517SMarco Vanotti
Mutate_CopyPart(uint8_t * Data,size_t Size,size_t MaxSize)356c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_CopyPart(uint8_t *Data, size_t Size,
357c5d72517SMarco Vanotti size_t MaxSize) {
358c5d72517SMarco Vanotti if (Size > MaxSize || Size == 0) return 0;
359c5d72517SMarco Vanotti // If Size == MaxSize, `InsertPartOf(...)` will
360c5d72517SMarco Vanotti // fail so there's no point using it in this case.
361c5d72517SMarco Vanotti if (Size == MaxSize || Rand.RandBool())
362c5d72517SMarco Vanotti return CopyPartOf(Data, Size, Data, Size);
363c5d72517SMarco Vanotti else
364c5d72517SMarco Vanotti return InsertPartOf(Data, Size, Data, Size, MaxSize);
365c5d72517SMarco Vanotti }
366c5d72517SMarco Vanotti
Mutate_ChangeASCIIInteger(uint8_t * Data,size_t Size,size_t MaxSize)367c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_ChangeASCIIInteger(uint8_t *Data, size_t Size,
368c5d72517SMarco Vanotti size_t MaxSize) {
369c5d72517SMarco Vanotti if (Size > MaxSize) return 0;
370c5d72517SMarco Vanotti size_t B = Rand(Size);
371c5d72517SMarco Vanotti while (B < Size && !isdigit(Data[B])) B++;
372c5d72517SMarco Vanotti if (B == Size) return 0;
373c5d72517SMarco Vanotti size_t E = B;
374c5d72517SMarco Vanotti while (E < Size && isdigit(Data[E])) E++;
375c5d72517SMarco Vanotti assert(B < E);
376c5d72517SMarco Vanotti // now we have digits in [B, E).
377c5d72517SMarco Vanotti // strtol and friends don't accept non-zero-teminated data, parse it manually.
378c5d72517SMarco Vanotti uint64_t Val = Data[B] - '0';
379c5d72517SMarco Vanotti for (size_t i = B + 1; i < E; i++)
380c5d72517SMarco Vanotti Val = Val * 10 + Data[i] - '0';
381c5d72517SMarco Vanotti
382c5d72517SMarco Vanotti // Mutate the integer value.
383c5d72517SMarco Vanotti switch(Rand(5)) {
384c5d72517SMarco Vanotti case 0: Val++; break;
385c5d72517SMarco Vanotti case 1: Val--; break;
386c5d72517SMarco Vanotti case 2: Val /= 2; break;
387c5d72517SMarco Vanotti case 3: Val *= 2; break;
388c5d72517SMarco Vanotti case 4: Val = Rand(Val * Val); break;
389c5d72517SMarco Vanotti default: assert(0);
390c5d72517SMarco Vanotti }
391c5d72517SMarco Vanotti // Just replace the bytes with the new ones, don't bother moving bytes.
392c5d72517SMarco Vanotti for (size_t i = B; i < E; i++) {
393c5d72517SMarco Vanotti size_t Idx = E + B - i - 1;
394c5d72517SMarco Vanotti assert(Idx >= B && Idx < E);
395c5d72517SMarco Vanotti Data[Idx] = (Val % 10) + '0';
396c5d72517SMarco Vanotti Val /= 10;
397c5d72517SMarco Vanotti }
398c5d72517SMarco Vanotti return Size;
399c5d72517SMarco Vanotti }
400c5d72517SMarco Vanotti
401c5d72517SMarco Vanotti template<class T>
ChangeBinaryInteger(uint8_t * Data,size_t Size,Random & Rand)402c5d72517SMarco Vanotti size_t ChangeBinaryInteger(uint8_t *Data, size_t Size, Random &Rand) {
403c5d72517SMarco Vanotti if (Size < sizeof(T)) return 0;
404c5d72517SMarco Vanotti size_t Off = Rand(Size - sizeof(T) + 1);
405c5d72517SMarco Vanotti assert(Off + sizeof(T) <= Size);
406c5d72517SMarco Vanotti T Val;
407c5d72517SMarco Vanotti if (Off < 64 && !Rand(4)) {
408c5d72517SMarco Vanotti Val = static_cast<T>(Size);
409c5d72517SMarco Vanotti if (Rand.RandBool())
410c5d72517SMarco Vanotti Val = Bswap(Val);
411c5d72517SMarco Vanotti } else {
412c5d72517SMarco Vanotti memcpy(&Val, Data + Off, sizeof(Val));
413c5d72517SMarco Vanotti T Add = static_cast<T>(Rand(21));
414c5d72517SMarco Vanotti Add -= 10;
415c5d72517SMarco Vanotti if (Rand.RandBool())
416c5d72517SMarco Vanotti Val = Bswap(T(Bswap(Val) + Add)); // Add assuming different endiannes.
417c5d72517SMarco Vanotti else
418c5d72517SMarco Vanotti Val = Val + Add; // Add assuming current endiannes.
419c5d72517SMarco Vanotti if (Add == 0 || Rand.RandBool()) // Maybe negate.
420c5d72517SMarco Vanotti Val = -Val;
421c5d72517SMarco Vanotti }
422c5d72517SMarco Vanotti memcpy(Data + Off, &Val, sizeof(Val));
423c5d72517SMarco Vanotti return Size;
424c5d72517SMarco Vanotti }
425c5d72517SMarco Vanotti
Mutate_ChangeBinaryInteger(uint8_t * Data,size_t Size,size_t MaxSize)426c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_ChangeBinaryInteger(uint8_t *Data,
427c5d72517SMarco Vanotti size_t Size,
428c5d72517SMarco Vanotti size_t MaxSize) {
429c5d72517SMarco Vanotti if (Size > MaxSize) return 0;
430c5d72517SMarco Vanotti switch (Rand(4)) {
431c5d72517SMarco Vanotti case 3: return ChangeBinaryInteger<uint64_t>(Data, Size, Rand);
432c5d72517SMarco Vanotti case 2: return ChangeBinaryInteger<uint32_t>(Data, Size, Rand);
433c5d72517SMarco Vanotti case 1: return ChangeBinaryInteger<uint16_t>(Data, Size, Rand);
434c5d72517SMarco Vanotti case 0: return ChangeBinaryInteger<uint8_t>(Data, Size, Rand);
435c5d72517SMarco Vanotti default: assert(0);
436c5d72517SMarco Vanotti }
437c5d72517SMarco Vanotti return 0;
438c5d72517SMarco Vanotti }
439c5d72517SMarco Vanotti
Mutate_CrossOver(uint8_t * Data,size_t Size,size_t MaxSize)440c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate_CrossOver(uint8_t *Data, size_t Size,
441c5d72517SMarco Vanotti size_t MaxSize) {
442c5d72517SMarco Vanotti if (Size > MaxSize) return 0;
443c5d72517SMarco Vanotti if (Size == 0) return 0;
444c5d72517SMarco Vanotti if (!CrossOverWith) return 0;
445c5d72517SMarco Vanotti const Unit &O = *CrossOverWith;
446c5d72517SMarco Vanotti if (O.empty()) return 0;
447c5d72517SMarco Vanotti size_t NewSize = 0;
448c5d72517SMarco Vanotti switch(Rand(3)) {
449c5d72517SMarco Vanotti case 0:
450c5d72517SMarco Vanotti MutateInPlaceHere.resize(MaxSize);
451c5d72517SMarco Vanotti NewSize = CrossOver(Data, Size, O.data(), O.size(),
452c5d72517SMarco Vanotti MutateInPlaceHere.data(), MaxSize);
453c5d72517SMarco Vanotti memcpy(Data, MutateInPlaceHere.data(), NewSize);
454c5d72517SMarco Vanotti break;
455c5d72517SMarco Vanotti case 1:
456c5d72517SMarco Vanotti NewSize = InsertPartOf(O.data(), O.size(), Data, Size, MaxSize);
457c5d72517SMarco Vanotti if (!NewSize)
458c5d72517SMarco Vanotti NewSize = CopyPartOf(O.data(), O.size(), Data, Size);
459c5d72517SMarco Vanotti break;
460c5d72517SMarco Vanotti case 2:
461c5d72517SMarco Vanotti NewSize = CopyPartOf(O.data(), O.size(), Data, Size);
462c5d72517SMarco Vanotti break;
463c5d72517SMarco Vanotti default: assert(0);
464c5d72517SMarco Vanotti }
465c5d72517SMarco Vanotti assert(NewSize > 0 && "CrossOver returned empty unit");
466c5d72517SMarco Vanotti assert(NewSize <= MaxSize && "CrossOver returned overisized unit");
467c5d72517SMarco Vanotti return NewSize;
468c5d72517SMarco Vanotti }
469c5d72517SMarco Vanotti
StartMutationSequence()470c5d72517SMarco Vanotti void MutationDispatcher::StartMutationSequence() {
471c5d72517SMarco Vanotti CurrentMutatorSequence.clear();
472c5d72517SMarco Vanotti CurrentDictionaryEntrySequence.clear();
473c5d72517SMarco Vanotti }
474c5d72517SMarco Vanotti
475c5d72517SMarco Vanotti // Copy successful dictionary entries to PersistentAutoDictionary.
RecordSuccessfulMutationSequence()476c5d72517SMarco Vanotti void MutationDispatcher::RecordSuccessfulMutationSequence() {
477c5d72517SMarco Vanotti for (auto DE : CurrentDictionaryEntrySequence) {
478c5d72517SMarco Vanotti // PersistentAutoDictionary.AddWithSuccessCountOne(DE);
479c5d72517SMarco Vanotti DE->IncSuccessCount();
480c5d72517SMarco Vanotti assert(DE->GetW().size());
481c5d72517SMarco Vanotti // Linear search is fine here as this happens seldom.
482c5d72517SMarco Vanotti if (!PersistentAutoDictionary.ContainsWord(DE->GetW()))
483c5d72517SMarco Vanotti PersistentAutoDictionary.push_back(*DE);
484c5d72517SMarco Vanotti }
485c5d72517SMarco Vanotti }
486c5d72517SMarco Vanotti
PrintRecommendedDictionary()487c5d72517SMarco Vanotti void MutationDispatcher::PrintRecommendedDictionary() {
4887c921753SKostya Serebryany std::vector<DictionaryEntry> V;
489c5d72517SMarco Vanotti for (auto &DE : PersistentAutoDictionary)
490c5d72517SMarco Vanotti if (!ManualDictionary.ContainsWord(DE.GetW()))
491c5d72517SMarco Vanotti V.push_back(DE);
492c5d72517SMarco Vanotti if (V.empty()) return;
49310ab2aceSGeorge Karpenkov Printf("###### Recommended dictionary. ######\n");
494c5d72517SMarco Vanotti for (auto &DE: V) {
49510ab2aceSGeorge Karpenkov assert(DE.GetW().size());
49610ab2aceSGeorge Karpenkov Printf("\"");
49710ab2aceSGeorge Karpenkov PrintASCII(DE.GetW(), "\"");
49810ab2aceSGeorge Karpenkov Printf(" # Uses: %zd\n", DE.GetUseCount());
49910ab2aceSGeorge Karpenkov }
50010ab2aceSGeorge Karpenkov Printf("###### End of recommended dictionary. ######\n");
50110ab2aceSGeorge Karpenkov }
50210ab2aceSGeorge Karpenkov
PrintMutationSequence(bool Verbose)503c5d72517SMarco Vanotti void MutationDispatcher::PrintMutationSequence(bool Verbose) {
504c5d72517SMarco Vanotti Printf("MS: %zd ", CurrentMutatorSequence.size());
505c5d72517SMarco Vanotti size_t EntriesToPrint =
506c5d72517SMarco Vanotti Verbose ? CurrentMutatorSequence.size()
507c5d72517SMarco Vanotti : std::min(kMaxMutationsToPrint, CurrentMutatorSequence.size());
508c5d72517SMarco Vanotti for (size_t i = 0; i < EntriesToPrint; i++)
509c5d72517SMarco Vanotti Printf("%s-", CurrentMutatorSequence[i].Name);
510c5d72517SMarco Vanotti if (!CurrentDictionaryEntrySequence.empty()) {
511c5d72517SMarco Vanotti Printf(" DE: ");
512c5d72517SMarco Vanotti EntriesToPrint = Verbose ? CurrentDictionaryEntrySequence.size()
513c5d72517SMarco Vanotti : std::min(kMaxMutationsToPrint,
514c5d72517SMarco Vanotti CurrentDictionaryEntrySequence.size());
515c5d72517SMarco Vanotti for (size_t i = 0; i < EntriesToPrint; i++) {
516c5d72517SMarco Vanotti Printf("\"");
517c5d72517SMarco Vanotti PrintASCII(CurrentDictionaryEntrySequence[i]->GetW(), "\"-");
518c5d72517SMarco Vanotti }
519c5d72517SMarco Vanotti }
520c5d72517SMarco Vanotti }
521c5d72517SMarco Vanotti
MutationSequence()522c5d72517SMarco Vanotti std::string MutationDispatcher::MutationSequence() {
523c5d72517SMarco Vanotti std::string MS;
524*513d9b9fSWu, Yingcong for (const auto &M : CurrentMutatorSequence) {
525c5d72517SMarco Vanotti MS += M.Name;
526c5d72517SMarco Vanotti MS += "-";
527c5d72517SMarco Vanotti }
528c5d72517SMarco Vanotti return MS;
529c5d72517SMarco Vanotti }
530c5d72517SMarco Vanotti
Mutate(uint8_t * Data,size_t Size,size_t MaxSize)531c5d72517SMarco Vanotti size_t MutationDispatcher::Mutate(uint8_t *Data, size_t Size, size_t MaxSize) {
532c5d72517SMarco Vanotti return MutateImpl(Data, Size, MaxSize, Mutators);
533c5d72517SMarco Vanotti }
534c5d72517SMarco Vanotti
DefaultMutate(uint8_t * Data,size_t Size,size_t MaxSize)535c5d72517SMarco Vanotti size_t MutationDispatcher::DefaultMutate(uint8_t *Data, size_t Size,
536c5d72517SMarco Vanotti size_t MaxSize) {
537c5d72517SMarco Vanotti return MutateImpl(Data, Size, MaxSize, DefaultMutators);
538c5d72517SMarco Vanotti }
539c5d72517SMarco Vanotti
540c5d72517SMarco Vanotti // Mutates Data in place, returns new size.
MutateImpl(uint8_t * Data,size_t Size,size_t MaxSize,std::vector<Mutator> & Mutators)541c5d72517SMarco Vanotti size_t MutationDispatcher::MutateImpl(uint8_t *Data, size_t Size,
542c5d72517SMarco Vanotti size_t MaxSize,
5437c921753SKostya Serebryany std::vector<Mutator> &Mutators) {
544c5d72517SMarco Vanotti assert(MaxSize > 0);
545c5d72517SMarco Vanotti // Some mutations may fail (e.g. can't insert more bytes if Size == MaxSize),
546c5d72517SMarco Vanotti // in which case they will return 0.
547c5d72517SMarco Vanotti // Try several times before returning un-mutated data.
548c5d72517SMarco Vanotti for (int Iter = 0; Iter < 100; Iter++) {
549c5d72517SMarco Vanotti auto M = Mutators[Rand(Mutators.size())];
550c5d72517SMarco Vanotti size_t NewSize = (this->*(M.Fn))(Data, Size, MaxSize);
551c5d72517SMarco Vanotti if (NewSize && NewSize <= MaxSize) {
552c5d72517SMarco Vanotti if (Options.OnlyASCII)
553c5d72517SMarco Vanotti ToASCII(Data, NewSize);
554c5d72517SMarco Vanotti CurrentMutatorSequence.push_back(M);
555c5d72517SMarco Vanotti return NewSize;
556c5d72517SMarco Vanotti }
557c5d72517SMarco Vanotti }
558c5d72517SMarco Vanotti *Data = ' ';
559c5d72517SMarco Vanotti return 1; // Fallback, should not happen frequently.
560c5d72517SMarco Vanotti }
561c5d72517SMarco Vanotti
562c5d72517SMarco Vanotti // Mask represents the set of Data bytes that are worth mutating.
MutateWithMask(uint8_t * Data,size_t Size,size_t MaxSize,const std::vector<uint8_t> & Mask)563c5d72517SMarco Vanotti size_t MutationDispatcher::MutateWithMask(uint8_t *Data, size_t Size,
564c5d72517SMarco Vanotti size_t MaxSize,
5657c921753SKostya Serebryany const std::vector<uint8_t> &Mask) {
566c5d72517SMarco Vanotti size_t MaskedSize = std::min(Size, Mask.size());
567c5d72517SMarco Vanotti // * Copy the worthy bytes into a temporary array T
568c5d72517SMarco Vanotti // * Mutate T
569c5d72517SMarco Vanotti // * Copy T back.
570c5d72517SMarco Vanotti // This is totally unoptimized.
571c5d72517SMarco Vanotti auto &T = MutateWithMaskTemp;
572c5d72517SMarco Vanotti if (T.size() < Size)
573c5d72517SMarco Vanotti T.resize(Size);
574c5d72517SMarco Vanotti size_t OneBits = 0;
575c5d72517SMarco Vanotti for (size_t I = 0; I < MaskedSize; I++)
576c5d72517SMarco Vanotti if (Mask[I])
577c5d72517SMarco Vanotti T[OneBits++] = Data[I];
578c5d72517SMarco Vanotti
579c5d72517SMarco Vanotti if (!OneBits) return 0;
580c5d72517SMarco Vanotti assert(!T.empty());
581c5d72517SMarco Vanotti size_t NewSize = Mutate(T.data(), OneBits, OneBits);
582c5d72517SMarco Vanotti assert(NewSize <= OneBits);
583c5d72517SMarco Vanotti (void)NewSize;
584c5d72517SMarco Vanotti // Even if NewSize < OneBits we still use all OneBits bytes.
585c5d72517SMarco Vanotti for (size_t I = 0, J = 0; I < MaskedSize; I++)
586c5d72517SMarco Vanotti if (Mask[I])
587c5d72517SMarco Vanotti Data[I] = T[J++];
588c5d72517SMarco Vanotti return Size;
589c5d72517SMarco Vanotti }
590c5d72517SMarco Vanotti
AddWordToManualDictionary(const Word & W)591c5d72517SMarco Vanotti void MutationDispatcher::AddWordToManualDictionary(const Word &W) {
592c5d72517SMarco Vanotti ManualDictionary.push_back(
593c5d72517SMarco Vanotti {W, std::numeric_limits<size_t>::max()});
59410ab2aceSGeorge Karpenkov }
59510ab2aceSGeorge Karpenkov
59610ab2aceSGeorge Karpenkov } // namespace fuzzer
597