blob: 939b92f55ec45b851f9a003b05513f56d64da27d [file] [log] [blame]
Kostya Serebryany6f5a8042016-09-21 01:50:50 +00001//===- 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//===----------------------------------------------------------------------===//
Marcos Pividori178fe582016-12-13 17:46:11 +000011
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000012#ifndef LLVM_FUZZER_DEFS_H
13#define LLVM_FUZZER_DEFS_H
14
Kostya Serebryany556894f2016-09-21 02:05:39 +000015#include <cassert>
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000016#include <cstddef>
17#include <cstdint>
Kostya Serebryany86586182016-09-21 21:17:23 +000018#include <cstring>
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000019#include <string>
20#include <vector>
21
22// Platform detection.
23#ifdef __linux__
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000024#define LIBFUZZER_APPLE 0
Zachary Turnerc6d8b4c2016-11-30 16:32:54 +000025#define LIBFUZZER_LINUX 1
26#define LIBFUZZER_WINDOWS 0
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000027#elif __APPLE__
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000028#define LIBFUZZER_APPLE 1
Zachary Turnerc6d8b4c2016-11-30 16:32:54 +000029#define LIBFUZZER_LINUX 0
30#define LIBFUZZER_WINDOWS 0
31#elif _WIN32
32#define LIBFUZZER_APPLE 0
33#define LIBFUZZER_LINUX 0
34#define LIBFUZZER_WINDOWS 1
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000035#else
36#error "Support for your platform has not been implemented"
37#endif
38
Kuba Mracek9eb170f2017-04-21 16:57:37 +000039#ifndef __has_attribute
40# define __has_attribute(x) 0
41#endif
42
Zachary Turnerc6d8b4c2016-11-30 16:32:54 +000043#define LIBFUZZER_POSIX LIBFUZZER_APPLE || LIBFUZZER_LINUX
44
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000045#ifdef __x86_64
Kuba Mracek9eb170f2017-04-21 16:57:37 +000046# if __has_attribute(target)
47# define ATTRIBUTE_TARGET_POPCNT __attribute__((target("popcnt")))
48# else
49# define ATTRIBUTE_TARGET_POPCNT
50# endif
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000051#else
Kuba Mracek9eb170f2017-04-21 16:57:37 +000052# define ATTRIBUTE_TARGET_POPCNT
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000053#endif
54
Kostya Serebryany3a4e2dd2016-12-16 22:45:25 +000055
56#ifdef __clang__ // avoid gcc warning.
57# define ATTRIBUTE_NO_SANITIZE_MEMORY __attribute__((no_sanitize("memory")))
Mike Aizatsky0e37f8e2017-01-17 23:11:32 +000058# define ALWAYS_INLINE __attribute__((always_inline))
Kostya Serebryany3a4e2dd2016-12-16 22:45:25 +000059#else
60# define ATTRIBUTE_NO_SANITIZE_MEMORY
Mike Aizatsky0e37f8e2017-01-17 23:11:32 +000061# define ALWAYS_INLINE
62#endif // __clang__
Kostya Serebryany3a4e2dd2016-12-16 22:45:25 +000063
Kostya Serebryanyd0ecb4c2017-01-26 01:04:54 +000064#define ATTRIBUTE_NO_SANITIZE_ADDRESS __attribute__((no_sanitize_address))
65
Kostya Serebryany6ca44f92017-03-23 22:43:12 +000066#if defined(__has_feature)
67# if __has_feature(address_sanitizer)
68# define ATTRIBUTE_NO_SANITIZE_ALL ATTRIBUTE_NO_SANITIZE_ADDRESS
69# elif __has_feature(memory_sanitizer)
70# define ATTRIBUTE_NO_SANITIZE_ALL ATTRIBUTE_NO_SANITIZE_MEMORY
71# else
72# define ATTRIBUTE_NO_SANITIZE_ALL
73# endif
74#else
75# define ATTRIBUTE_NO_SANITIZE_ALL
76#endif
Kostya Serebryanyd0ecb4c2017-01-26 01:04:54 +000077
Marcos Pividori6137f982017-01-22 01:27:38 +000078#if LIBFUZZER_WINDOWS
79#define ATTRIBUTE_INTERFACE __declspec(dllexport)
80#else
81#define ATTRIBUTE_INTERFACE __attribute__((visibility("default")))
82#endif
83
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000084namespace fuzzer {
85
Kostya Serebryanyd28099d2016-09-23 00:22:46 +000086template <class T> T Min(T a, T b) { return a < b ? a : b; }
87template <class T> T Max(T a, T b) { return a > b ? a : b; }
88
Kostya Serebryany6f5a8042016-09-21 01:50:50 +000089class Random;
90class Dictionary;
91class DictionaryEntry;
92class MutationDispatcher;
Kostya Serebryany556894f2016-09-21 02:05:39 +000093struct FuzzingOptions;
94class InputCorpus;
Kostya Serebryany29bb6642016-09-21 22:42:17 +000095struct InputInfo;
Kostya Serebryany556894f2016-09-21 02:05:39 +000096struct ExternalFunctions;
97
98// Global interface to functions that may or may not be available.
99extern ExternalFunctions *EF;
Kostya Serebryany6f5a8042016-09-21 01:50:50 +0000100
101typedef std::vector<uint8_t> Unit;
102typedef std::vector<Unit> UnitVector;
103typedef int (*UserCallback)(const uint8_t *Data, size_t Size);
Zachary Turner24a148b2016-11-30 19:06:14 +0000104
Kostya Serebryany6f5a8042016-09-21 01:50:50 +0000105int FuzzerDriver(int *argc, char ***argv, UserCallback Callback);
106
Kostya Serebryanyaf2dfce2017-03-31 02:21:28 +0000107struct ScopedDoingMyOwnMemOrStr {
108 ScopedDoingMyOwnMemOrStr() { DoingMyOwnMemOrStr++; }
109 ~ScopedDoingMyOwnMemOrStr() { DoingMyOwnMemOrStr--; }
110 static int DoingMyOwnMemOrStr;
Kostya Serebryanya5f94fb2016-10-14 20:20:33 +0000111};
112
Kostya Serebryany9a4b10a2016-10-15 04:00:07 +0000113inline uint8_t Bswap(uint8_t x) { return x; }
114inline uint16_t Bswap(uint16_t x) { return __builtin_bswap16(x); }
115inline uint32_t Bswap(uint32_t x) { return __builtin_bswap32(x); }
116inline uint64_t Bswap(uint64_t x) { return __builtin_bswap64(x); }
117
Kostya Serebryany6ca44f92017-03-23 22:43:12 +0000118uint8_t *ExtraCountersBegin();
119uint8_t *ExtraCountersEnd();
120void ClearExtraCounters();
121
Kostya Serebryany6f5a8042016-09-21 01:50:50 +0000122} // namespace fuzzer
Marcos Pividori178fe582016-12-13 17:46:11 +0000123
Kostya Serebryany6f5a8042016-09-21 01:50:50 +0000124#endif // LLVM_FUZZER_DEFS_H