mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-10-01 10:57:21 +00:00
[lib/Fuzzer] doxygen-ify the comments for the user interface
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@238086 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
parent
b5f8c9b2ec
commit
762dbd0574
@ -21,8 +21,12 @@
|
|||||||
|
|
||||||
namespace fuzzer {
|
namespace fuzzer {
|
||||||
|
|
||||||
// Simple C-like interface with a single user-supplied callback.
|
typedef void (*UserCallback)(const uint8_t *Data, size_t Size);
|
||||||
/* Usage: ---------------------------------------------------------------------
|
/** Simple C-like interface with a single user-supplied callback.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
#\code
|
||||||
#include "FuzzerInterface.h"
|
#include "FuzzerInterface.h"
|
||||||
|
|
||||||
void LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
|
void LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
|
||||||
@ -34,12 +38,15 @@ int main(int argc, char **argv) {
|
|||||||
InitializeMeIfNeeded();
|
InitializeMeIfNeeded();
|
||||||
return fuzzer::FuzzerDriver(argc, argv, LLVMFuzzerTestOneInput);
|
return fuzzer::FuzzerDriver(argc, argv, LLVMFuzzerTestOneInput);
|
||||||
}
|
}
|
||||||
----------------------------------------------------------------------------- */
|
#\endcode
|
||||||
typedef void (*UserCallback)(const uint8_t *Data, size_t Size);
|
*/
|
||||||
int FuzzerDriver(int argc, char **argv, UserCallback Callback);
|
int FuzzerDriver(int argc, char **argv, UserCallback Callback);
|
||||||
|
|
||||||
// An abstract class that allows to use user-supplied mutators with libFuzzer.
|
/** An abstract class that allows to use user-supplied mutators with libFuzzer.
|
||||||
/* Usage: ---------------------------------------------------------------------
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
#\code
|
||||||
#include "FuzzerInterface.h"
|
#include "FuzzerInterface.h"
|
||||||
class MyFuzzer : public fuzzer::UserSuppliedFuzzer {
|
class MyFuzzer : public fuzzer::UserSuppliedFuzzer {
|
||||||
public:
|
public:
|
||||||
@ -55,18 +62,19 @@ int main(int argc, char **argv) {
|
|||||||
MyFuzzer F;
|
MyFuzzer F;
|
||||||
fuzzer::FuzzerDriver(argc, argv, F);
|
fuzzer::FuzzerDriver(argc, argv, F);
|
||||||
}
|
}
|
||||||
----------------------------------------------------------------------------- */
|
#\endcode
|
||||||
|
*/
|
||||||
class UserSuppliedFuzzer {
|
class UserSuppliedFuzzer {
|
||||||
public:
|
public:
|
||||||
// Executes the target function on 'Size' bytes of 'Data'.
|
/// Executes the target function on 'Size' bytes of 'Data'.
|
||||||
virtual void TargetFunction(const uint8_t *Data, size_t Size) = 0;
|
virtual void TargetFunction(const uint8_t *Data, size_t Size) = 0;
|
||||||
// Mutates 'Size' bytes of data in 'Data' inplace into up to 'MaxSize' bytes,
|
/// Mutates 'Size' bytes of data in 'Data' inplace into up to 'MaxSize' bytes,
|
||||||
// returns the new size of the data.
|
/// returns the new size of the data.
|
||||||
virtual size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize) {
|
virtual size_t Mutate(uint8_t *Data, size_t Size, size_t MaxSize) {
|
||||||
return BasicMutate(Data, Size, MaxSize);
|
return BasicMutate(Data, Size, MaxSize);
|
||||||
}
|
}
|
||||||
// Crosses 'Data1' and 'Data2', writes up to 'MaxOutSize' bytes into Out,
|
/// Crosses 'Data1' and 'Data2', writes up to 'MaxOutSize' bytes into Out,
|
||||||
// returns the number of bytes written.
|
/// returns the number of bytes written.
|
||||||
virtual size_t CrossOver(const uint8_t *Data1, size_t Size1,
|
virtual size_t CrossOver(const uint8_t *Data1, size_t Size1,
|
||||||
const uint8_t *Data2, size_t Size2,
|
const uint8_t *Data2, size_t Size2,
|
||||||
uint8_t *Out, size_t MaxOutSize) {
|
uint8_t *Out, size_t MaxOutSize) {
|
||||||
@ -75,13 +83,14 @@ class UserSuppliedFuzzer {
|
|||||||
virtual ~UserSuppliedFuzzer() {}
|
virtual ~UserSuppliedFuzzer() {}
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
// These can be called internally by Mutate and CrossOver.
|
/// These can be called internally by Mutate and CrossOver.
|
||||||
size_t BasicMutate(uint8_t *Data, size_t Size, size_t MaxSize);
|
size_t BasicMutate(uint8_t *Data, size_t Size, size_t MaxSize);
|
||||||
size_t BasicCrossOver(const uint8_t *Data1, size_t Size1,
|
size_t BasicCrossOver(const uint8_t *Data1, size_t Size1,
|
||||||
const uint8_t *Data2, size_t Size2,
|
const uint8_t *Data2, size_t Size2,
|
||||||
uint8_t *Out, size_t MaxOutSize);
|
uint8_t *Out, size_t MaxOutSize);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/// Runs the fuzzing with the UserSuppliedFuzzer.
|
||||||
int FuzzerDriver(int argc, char **argv, UserSuppliedFuzzer &USF);
|
int FuzzerDriver(int argc, char **argv, UserSuppliedFuzzer &USF);
|
||||||
|
|
||||||
} // namespace fuzzer
|
} // namespace fuzzer
|
||||||
|
Loading…
Reference in New Issue
Block a user