1//===- FuzzerUtil.h - Internal header for the Fuzzer Utils ------*- C++ -* ===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8// Util functions.
9//===----------------------------------------------------------------------===//
10
11#ifndef LLVM_FUZZER_UTIL_H
12#define LLVM_FUZZER_UTIL_H
13
14#include "FuzzerBuiltins.h"
15#include "FuzzerBuiltinsMsvc.h"
16#include "FuzzerCommand.h"
17#include "FuzzerDefs.h"
18
19namespace fuzzer {
20
21void PrintHexArray(const Unit &U, const char *PrintAfter = "");
22
23void PrintHexArray(const uint8_t *Data, size_t Size,
24 const char *PrintAfter = "");
25
26void PrintASCII(const uint8_t *Data, size_t Size, const char *PrintAfter = "");
27
28void PrintASCII(const Unit &U, const char *PrintAfter = "");
29
30// Changes U to contain only ASCII (isprint+isspace) characters.
31// Returns true iff U has been changed.
32bool ToASCII(uint8_t *Data, size_t Size);
33
34bool IsASCII(const Unit &U);
35
36bool IsASCII(const uint8_t *Data, size_t Size);
37
38std::string Base64(const Unit &U);
39
40void PrintPC(const char *SymbolizedFMT, const char *FallbackFMT, uintptr_t PC);
41
42std::string DescribePC(const char *SymbolizedFMT, uintptr_t PC);
43
44void PrintStackTrace();
45
46void PrintMemoryProfile();
47
48unsigned NumberOfCpuCores();
49
50// Platform specific functions.
51void SetSignalHandler(const FuzzingOptions& Options);
52
53void SleepSeconds(int Seconds);
54
55unsigned long GetPid();
56
57size_t GetPeakRSSMb();
58
59int ExecuteCommand(const Command &Cmd);
60bool ExecuteCommand(const Command &Cmd, std::string *CmdOutput);
61
62void SetThreadName(std::thread &thread, const std::string &name);
63
64// Fuchsia does not have popen/pclose.
65FILE *OpenProcessPipe(const char *Command, const char *Mode);
66int CloseProcessPipe(FILE *F);
67
68const void *SearchMemory(const void *haystack, size_t haystacklen,
69 const void *needle, size_t needlelen);
70
71std::string CloneArgsWithoutX(const std::vector<std::string> &Args,
72 const char *X1, const char *X2);
73
74inline std::string CloneArgsWithoutX(const std::vector<std::string> &Args,
75 const char *X) {
76 return CloneArgsWithoutX(Args, X1: X, X2: X);
77}
78
79inline std::pair<std::string, std::string> SplitBefore(std::string X,
80 std::string S) {
81 auto Pos = S.find(str: X);
82 if (Pos == std::string::npos)
83 return std::make_pair(t1&: S, t2: "");
84 return std::make_pair(t1: S.substr(pos: 0, n: Pos), t2: S.substr(pos: Pos));
85}
86
87void DiscardOutput(int Fd);
88
89std::string DisassembleCmd(const std::string &FileName);
90
91std::string SearchRegexCmd(const std::string &Regex);
92
93uint64_t SimpleFastHash(const void *Data, size_t Size, uint64_t Initial = 0);
94
95inline size_t Log(size_t X) {
96 return static_cast<size_t>((sizeof(unsigned long long) * 8) - Clzll(X) - 1);
97}
98
99size_t PageSize();
100
101inline uint8_t *RoundUpByPage(uint8_t *P) {
102 uintptr_t X = reinterpret_cast<uintptr_t>(P);
103 size_t Mask = PageSize() - 1;
104 X = (X + Mask) & ~Mask;
105 return reinterpret_cast<uint8_t *>(X);
106}
107inline uint8_t *RoundDownByPage(uint8_t *P) {
108 uintptr_t X = reinterpret_cast<uintptr_t>(P);
109 size_t Mask = PageSize() - 1;
110 X = X & ~Mask;
111 return reinterpret_cast<uint8_t *>(X);
112}
113
114#if __BYTE_ORDER == __LITTLE_ENDIAN
115template <typename T> T HostToLE(T X) { return X; }
116#else
117template <typename T> T HostToLE(T X) { return Bswap(X); }
118#endif
119
120} // namespace fuzzer
121
122#endif // LLVM_FUZZER_UTIL_H
123