aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/llvm12/include/llvm/FuzzMutate/IRMutator.h
blob: 40ce41e6a8eaa810782d8616055830461d0feb9f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#pragma once 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic push 
#pragma GCC diagnostic ignored "-Wunused-parameter" 
#endif 
 
//===-- IRMutator.h - Mutation engine for fuzzing IR ------------*- C++ -*-===// 
// 
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 
// See https://llvm.org/LICENSE.txt for license information. 
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 
// 
//===----------------------------------------------------------------------===// 
// 
// Provides the IRMutator class, which drives mutations on IR based on a 
// configurable set of strategies. Some common strategies are also included 
// here. 
// 
//===----------------------------------------------------------------------===// 
 
#ifndef LLVM_FUZZMUTATE_IRMUTATOR_H 
#define LLVM_FUZZMUTATE_IRMUTATOR_H 
 
#include "llvm/ADT/Optional.h" 
#include "llvm/FuzzMutate/OpDescriptor.h" 
#include "llvm/Support/ErrorHandling.h" 
 
namespace llvm { 
class BasicBlock; 
class Function; 
class Instruction; 
class Module; 
 
struct RandomIRBuilder; 
 
/// Base class for describing how to mutate a module. mutation functions for 
/// each IR unit forward to the contained unit. 
class IRMutationStrategy { 
public: 
  virtual ~IRMutationStrategy() = default; 
 
  /// Provide a weight to bias towards choosing this strategy for a mutation. 
  /// 
  /// The value of the weight is arbitrary, but a good default is "the number of 
  /// distinct ways in which this strategy can mutate a unit". This can also be 
  /// used to prefer strategies that shrink the overall size of the result when 
  /// we start getting close to \c MaxSize. 
  virtual uint64_t getWeight(size_t CurrentSize, size_t MaxSize, 
                             uint64_t CurrentWeight) = 0; 
 
  /// @{ 
  /// Mutators for each IR unit. By default these forward to a contained 
  /// instance of the next smaller unit. 
  virtual void mutate(Module &M, RandomIRBuilder &IB); 
  virtual void mutate(Function &F, RandomIRBuilder &IB); 
  virtual void mutate(BasicBlock &BB, RandomIRBuilder &IB); 
  virtual void mutate(Instruction &I, RandomIRBuilder &IB) { 
    llvm_unreachable("Strategy does not implement any mutators"); 
  } 
  /// @} 
}; 
 
using TypeGetter = std::function<Type *(LLVMContext &)>; 
 
/// Entry point for configuring and running IR mutations. 
class IRMutator { 
  std::vector<TypeGetter> AllowedTypes; 
  std::vector<std::unique_ptr<IRMutationStrategy>> Strategies; 
 
public: 
  IRMutator(std::vector<TypeGetter> &&AllowedTypes, 
            std::vector<std::unique_ptr<IRMutationStrategy>> &&Strategies) 
      : AllowedTypes(std::move(AllowedTypes)), 
        Strategies(std::move(Strategies)) {} 
 
  void mutateModule(Module &M, int Seed, size_t CurSize, size_t MaxSize); 
}; 
 
/// Strategy that injects operations into the function. 
class InjectorIRStrategy : public IRMutationStrategy { 
  std::vector<fuzzerop::OpDescriptor> Operations; 
 
  Optional<fuzzerop::OpDescriptor> chooseOperation(Value *Src, 
                                                   RandomIRBuilder &IB); 
 
public: 
  InjectorIRStrategy(std::vector<fuzzerop::OpDescriptor> &&Operations) 
      : Operations(std::move(Operations)) {} 
  static std::vector<fuzzerop::OpDescriptor> getDefaultOps(); 
 
  uint64_t getWeight(size_t CurrentSize, size_t MaxSize, 
                     uint64_t CurrentWeight) override { 
    return Operations.size(); 
  } 
 
  using IRMutationStrategy::mutate; 
  void mutate(Function &F, RandomIRBuilder &IB) override; 
  void mutate(BasicBlock &BB, RandomIRBuilder &IB) override; 
}; 
 
class InstDeleterIRStrategy : public IRMutationStrategy { 
public: 
  uint64_t getWeight(size_t CurrentSize, size_t MaxSize, 
                     uint64_t CurrentWeight) override; 
 
  using IRMutationStrategy::mutate; 
  void mutate(Function &F, RandomIRBuilder &IB) override; 
  void mutate(Instruction &Inst, RandomIRBuilder &IB) override; 
}; 
 
class InstModificationIRStrategy : public IRMutationStrategy {
public:
  uint64_t getWeight(size_t CurrentSize, size_t MaxSize,
                     uint64_t CurrentWeight) override {
    return 4;
  }

  using IRMutationStrategy::mutate;
  void mutate(Instruction &Inst, RandomIRBuilder &IB) override;
};

} // end llvm namespace 
 
#endif // LLVM_FUZZMUTATE_IRMUTATOR_H 
 
#ifdef __GNUC__ 
#pragma GCC diagnostic pop 
#endif