1 //===- FuzzerDefs.h - Internal header for the Fuzzer ------------*- C++ -* ===//
2 //
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 //===----------------------------------------------------------------------===//
9 // Basic definitions.
10 //===----------------------------------------------------------------------===//
11
12 #ifndef LLVM_FUZZER_DEFS_H
13 #define LLVM_FUZZER_DEFS_H
14
15 #include <cassert>
16 #include <cstddef>
17 #include <cstdint>
18 #include <cstring>
19 #include <string>
20 #include <vector>
21 #include <set>
22 #include <memory>
23
24 // Platform detection.
25 #ifdef __linux__
26 #define LIBFUZZER_APPLE 0
27 #define LIBFUZZER_FUCHSIA 0
28 #define LIBFUZZER_LINUX 1
29 #define LIBFUZZER_NETBSD 0
30 #define LIBFUZZER_FREEBSD 0
31 #define LIBFUZZER_OPENBSD 0
32 #define LIBFUZZER_WINDOWS 0
33 #elif __APPLE__
34 #define LIBFUZZER_APPLE 1
35 #define LIBFUZZER_FUCHSIA 0
36 #define LIBFUZZER_LINUX 0
37 #define LIBFUZZER_NETBSD 0
38 #define LIBFUZZER_FREEBSD 0
39 #define LIBFUZZER_OPENBSD 0
40 #define LIBFUZZER_WINDOWS 0
41 #elif __NetBSD__
42 #define LIBFUZZER_APPLE 0
43 #define LIBFUZZER_FUCHSIA 0
44 #define LIBFUZZER_LINUX 0
45 #define LIBFUZZER_NETBSD 1
46 #define LIBFUZZER_FREEBSD 0
47 #define LIBFUZZER_OPENBSD 0
48 #define LIBFUZZER_WINDOWS 0
49 #elif __FreeBSD__
50 #define LIBFUZZER_APPLE 0
51 #define LIBFUZZER_FUCHSIA 0
52 #define LIBFUZZER_LINUX 0
53 #define LIBFUZZER_NETBSD 0
54 #define LIBFUZZER_FREEBSD 1
55 #define LIBFUZZER_OPENBSD 0
56 #define LIBFUZZER_WINDOWS 0
57 #elif __OpenBSD__
58 #define LIBFUZZER_APPLE 0
59 #define LIBFUZZER_FUCHSIA 0
60 #define LIBFUZZER_LINUX 0
61 #define LIBFUZZER_NETBSD 0
62 #define LIBFUZZER_FREEBSD 0
63 #define LIBFUZZER_OPENBSD 1
64 #define LIBFUZZER_WINDOWS 0
65 #elif _WIN32
66 #define LIBFUZZER_APPLE 0
67 #define LIBFUZZER_FUCHSIA 0
68 #define LIBFUZZER_LINUX 0
69 #define LIBFUZZER_NETBSD 0
70 #define LIBFUZZER_FREEBSD 0
71 #define LIBFUZZER_OPENBSD 0
72 #define LIBFUZZER_WINDOWS 1
73 #elif __Fuchsia__
74 #define LIBFUZZER_APPLE 0
75 #define LIBFUZZER_FUCHSIA 1
76 #define LIBFUZZER_LINUX 0
77 #define LIBFUZZER_NETBSD 0
78 #define LIBFUZZER_FREEBSD 0
79 #define LIBFUZZER_OPENBSD 0
80 #define LIBFUZZER_WINDOWS 0
81 #else
82 #error "Support for your platform has not been implemented"
83 #endif
84
85 #if defined(_MSC_VER) && !defined(__clang__)
86 // MSVC compiler is being used.
87 #define LIBFUZZER_MSVC 1
88 #else
89 #define LIBFUZZER_MSVC 0
90 #endif
91
92 #ifndef __has_attribute
93 # define __has_attribute(x) 0
94 #endif
95
96 #define LIBFUZZER_POSIX \
97 (LIBFUZZER_APPLE || LIBFUZZER_LINUX || LIBFUZZER_NETBSD || \
98 LIBFUZZER_FREEBSD || LIBFUZZER_OPENBSD)
99
100 #ifdef __x86_64
101 # if __has_attribute(target)
102 # define ATTRIBUTE_TARGET_POPCNT __attribute__((target("popcnt")))
103 # else
104 # define ATTRIBUTE_TARGET_POPCNT
105 # endif
106 #else
107 # define ATTRIBUTE_TARGET_POPCNT
108 #endif
109
110
111 #ifdef __clang__ // avoid gcc warning.
112 # if __has_attribute(no_sanitize)
113 # define ATTRIBUTE_NO_SANITIZE_MEMORY __attribute__((no_sanitize("memory")))
114 # else
115 # define ATTRIBUTE_NO_SANITIZE_MEMORY
116 # endif
117 # define ALWAYS_INLINE __attribute__((always_inline))
118 #else
119 # define ATTRIBUTE_NO_SANITIZE_MEMORY
120 # define ALWAYS_INLINE
121 #endif // __clang__
122
123 #define ATTRIBUTE_NO_SANITIZE_ADDRESS __attribute__((no_sanitize_address))
124
125 #if defined(__has_feature)
126 # if __has_feature(address_sanitizer)
127 # define ATTRIBUTE_NO_SANITIZE_ALL ATTRIBUTE_NO_SANITIZE_ADDRESS
128 # elif __has_feature(memory_sanitizer)
129 # define ATTRIBUTE_NO_SANITIZE_ALL ATTRIBUTE_NO_SANITIZE_MEMORY
130 # else
131 # define ATTRIBUTE_NO_SANITIZE_ALL
132 # endif
133 #else
134 # define ATTRIBUTE_NO_SANITIZE_ALL
135 #endif
136
137 #if LIBFUZZER_WINDOWS
138 #define ATTRIBUTE_INTERFACE __declspec(dllexport)
139 // This is used for __sancov_lowest_stack which is needed for
140 // -fsanitize-coverage=stack-depth. That feature is not yet available on
141 // Windows, so make the symbol static to avoid linking errors.
142 #define ATTRIBUTES_INTERFACE_TLS_INITIAL_EXEC \
143 __attribute__((tls_model("initial-exec"))) thread_local static
144 #else
145 #define ATTRIBUTE_INTERFACE __attribute__((visibility("default")))
146 #define ATTRIBUTES_INTERFACE_TLS_INITIAL_EXEC \
147 ATTRIBUTE_INTERFACE __attribute__((tls_model("initial-exec"))) thread_local
148 #endif
149
150 namespace fuzzer {
151
Min(T a,T b)152 template <class T> T Min(T a, T b) { return a < b ? a : b; }
Max(T a,T b)153 template <class T> T Max(T a, T b) { return a > b ? a : b; }
154
155 class Random;
156 class Dictionary;
157 class DictionaryEntry;
158 class MutationDispatcher;
159 struct FuzzingOptions;
160 class InputCorpus;
161 struct InputInfo;
162 struct ExternalFunctions;
163
164 // Global interface to functions that may or may not be available.
165 extern ExternalFunctions *EF;
166
167 // We are using a custom allocator to give a different symbol name to STL
168 // containers in order to avoid ODR violations.
169 template<typename T>
170 class fuzzer_allocator: public std::allocator<T> {
171 public:
172 fuzzer_allocator() = default;
173
174 template<class U>
fuzzer_allocator(const fuzzer_allocator<U> &)175 fuzzer_allocator(const fuzzer_allocator<U>&) {}
176
177 template<class Other>
178 struct rebind { typedef fuzzer_allocator<Other> other; };
179 };
180
181 template<typename T>
182 using Vector = std::vector<T, fuzzer_allocator<T>>;
183
184 template<typename T>
185 using Set = std::set<T, std::less<T>, fuzzer_allocator<T>>;
186
187 typedef Vector<uint8_t> Unit;
188 typedef Vector<Unit> UnitVector;
189 typedef int (*UserCallback)(const uint8_t *Data, size_t Size);
190
191 int FuzzerDriver(int *argc, char ***argv, UserCallback Callback);
192
193 uint8_t *ExtraCountersBegin();
194 uint8_t *ExtraCountersEnd();
195 void ClearExtraCounters();
196
197 extern bool RunningUserCallback;
198
199 } // namespace fuzzer
200
201 #endif // LLVM_FUZZER_DEFS_H
202