Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #include "ProtoFuzzerMutator.h" |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 18 | #include <iostream> |
| 19 | |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 20 | using std::cerr; |
| 21 | using std::cout; |
Tri Vo | f657d67 | 2017-07-26 16:13:02 -0700 | [diff] [blame] | 22 | using std::endl; |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 23 | using std::make_unique; |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 24 | using std::unordered_map; |
| 25 | using namespace std::placeholders; |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 26 | |
| 27 | namespace android { |
| 28 | namespace vts { |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 29 | namespace fuzzer { |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 30 | |
| 31 | ProtoFuzzerMutator::ProtoFuzzerMutator( |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 32 | Random &rand, unordered_map<string, TypeSpec> predefined_types, |
Tri Vo | f4037d4 | 2017-03-31 17:28:25 -0700 | [diff] [blame] | 33 | ProtoFuzzerMutatorConfig mutator_config) |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 34 | : rand_(rand), |
| 35 | predefined_types_(predefined_types), |
Tri Vo | f4037d4 | 2017-03-31 17:28:25 -0700 | [diff] [blame] | 36 | mutator_config_(mutator_config) { |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 37 | // Default function used for mutation/random generation. Used for types for |
| 38 | // which the notion of mutation/random generation is not defined, e.g. |
| 39 | // TYPE_HANDLE, TYPE_HIDL_CALLBACK. |
| 40 | VarTransformFn default_transform = |
| 41 | [](const VariableSpecificationMessage &var_spec) { |
| 42 | return VariableSpecificationMessage{var_spec}; |
| 43 | }; |
| 44 | |
| 45 | // Initialize random_gen_fns_ and mutate_fns_ tables. |
| 46 | random_gen_fns_[TYPE_ARRAY] = |
| 47 | std::bind(&ProtoFuzzerMutator::ArrayRandomGen, this, _1); |
| 48 | mutate_fns_[TYPE_ARRAY] = |
| 49 | std::bind(&ProtoFuzzerMutator::ArrayMutate, this, _1); |
| 50 | |
| 51 | random_gen_fns_[TYPE_ENUM] = |
| 52 | std::bind(&ProtoFuzzerMutator::EnumRandomGen, this, _1); |
| 53 | mutate_fns_[TYPE_ENUM] = std::bind(&ProtoFuzzerMutator::EnumMutate, this, _1); |
| 54 | |
| 55 | random_gen_fns_[TYPE_HANDLE] = default_transform; |
| 56 | mutate_fns_[TYPE_HANDLE] = default_transform; |
| 57 | |
| 58 | random_gen_fns_[TYPE_HIDL_CALLBACK] = default_transform; |
| 59 | mutate_fns_[TYPE_HIDL_CALLBACK] = default_transform; |
| 60 | |
Tri Vo | 165b1ed | 2017-04-03 14:44:45 -0700 | [diff] [blame] | 61 | random_gen_fns_[TYPE_HIDL_INTERFACE] = default_transform; |
| 62 | mutate_fns_[TYPE_HIDL_INTERFACE] = default_transform; |
| 63 | |
Tri Vo | 80d2a36 | 2017-07-20 16:13:40 -0700 | [diff] [blame] | 64 | random_gen_fns_[TYPE_HIDL_MEMORY] = default_transform; |
| 65 | mutate_fns_[TYPE_HIDL_MEMORY] = default_transform; |
| 66 | |
Tri Vo | 69d71b3 | 2017-04-12 18:24:50 -0700 | [diff] [blame] | 67 | // Interpret masks as enums. |
| 68 | random_gen_fns_[TYPE_MASK] = |
| 69 | std::bind(&ProtoFuzzerMutator::EnumRandomGen, this, _1); |
| 70 | mutate_fns_[TYPE_MASK] = std::bind(&ProtoFuzzerMutator::EnumMutate, this, _1); |
| 71 | |
Tri Vo | 78f89c5 | 2017-05-24 15:10:26 -0700 | [diff] [blame] | 72 | random_gen_fns_[TYPE_POINTER] = default_transform; |
| 73 | mutate_fns_[TYPE_POINTER] = default_transform; |
| 74 | |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 75 | random_gen_fns_[TYPE_SCALAR] = |
| 76 | std::bind(&ProtoFuzzerMutator::ScalarRandomGen, this, _1); |
| 77 | mutate_fns_[TYPE_SCALAR] = |
| 78 | std::bind(&ProtoFuzzerMutator::ScalarMutate, this, _1); |
| 79 | |
Tri Vo | 5ecdf5b | 2017-04-14 08:30:48 -0700 | [diff] [blame] | 80 | random_gen_fns_[TYPE_STRING] = |
| 81 | std::bind(&ProtoFuzzerMutator::StringRandomGen, this, _1); |
| 82 | mutate_fns_[TYPE_STRING] = |
| 83 | std::bind(&ProtoFuzzerMutator::StringMutate, this, _1); |
| 84 | |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 85 | random_gen_fns_[TYPE_STRUCT] = |
| 86 | std::bind(&ProtoFuzzerMutator::StructRandomGen, this, _1); |
| 87 | mutate_fns_[TYPE_STRUCT] = |
| 88 | std::bind(&ProtoFuzzerMutator::StructMutate, this, _1); |
| 89 | |
| 90 | random_gen_fns_[TYPE_UNION] = |
| 91 | std::bind(&ProtoFuzzerMutator::UnionRandomGen, this, _1); |
| 92 | mutate_fns_[TYPE_UNION] = |
| 93 | std::bind(&ProtoFuzzerMutator::UnionMutate, this, _1); |
| 94 | |
| 95 | random_gen_fns_[TYPE_VECTOR] = |
| 96 | std::bind(&ProtoFuzzerMutator::VectorRandomGen, this, _1); |
| 97 | mutate_fns_[TYPE_VECTOR] = |
| 98 | std::bind(&ProtoFuzzerMutator::VectorMutate, this, _1); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 99 | } |
| 100 | |
Tri Vo | 9f5fd85 | 2017-05-20 12:32:26 -0700 | [diff] [blame] | 101 | // TODO(trong): add a mutator config option which controls how an interface is |
| 102 | // selected. |
| 103 | const CompSpec *ProtoFuzzerMutator::RandomSelectIface(const IfaceDescTbl &tbl) { |
| 104 | size_t rand_idx = rand_(tbl.size()); |
| 105 | auto it = tbl.begin(); |
| 106 | std::advance(it, rand_idx); |
| 107 | return it->second.comp_spec_; |
| 108 | } |
| 109 | |
| 110 | ExecSpec ProtoFuzzerMutator::RandomGen(const IfaceDescTbl &tbl, |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 111 | size_t num_calls) { |
Tri Vo | 0a9cfee | 2017-08-15 17:08:18 -0700 | [diff] [blame] | 112 | cerr << "Generating a random execution." << endl; |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 113 | ExecSpec result{}; |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 114 | for (size_t i = 0; i < num_calls; ++i) { |
Tri Vo | 9f5fd85 | 2017-05-20 12:32:26 -0700 | [diff] [blame] | 115 | const CompSpec *comp_spec = RandomSelectIface(tbl); |
| 116 | string iface_name = comp_spec->component_name(); |
| 117 | const IfaceSpec &iface_spec = comp_spec->interface(); |
| 118 | |
| 119 | // Generate a random interface function call. |
| 120 | FuncCall rand_call{}; |
| 121 | rand_call.set_hidl_interface_name(iface_name); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 122 | size_t num_apis = iface_spec.api_size(); |
| 123 | size_t rand_api_idx = rand_(num_apis); |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 124 | FuncSpec rand_api = RandomGen(iface_spec.api(rand_api_idx)); |
Tri Vo | 9f5fd85 | 2017-05-20 12:32:26 -0700 | [diff] [blame] | 125 | *rand_call.mutable_api() = rand_api; |
| 126 | *result.add_function_call() = rand_call; |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 127 | } |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 128 | return result; |
| 129 | } |
| 130 | |
Tri Vo | 9f5fd85 | 2017-05-20 12:32:26 -0700 | [diff] [blame] | 131 | void ProtoFuzzerMutator::Mutate(const IfaceDescTbl &tbl, ExecSpec *exec_spec) { |
Tri Vo | f4037d4 | 2017-03-31 17:28:25 -0700 | [diff] [blame] | 132 | // Mutate a randomly chosen function call with probability |
| 133 | // odds_for/(odds_for + odds_against). |
| 134 | uint64_t odds_for = mutator_config_.func_mutated_.first; |
| 135 | uint64_t odds_against = mutator_config_.func_mutated_.second; |
| 136 | uint64_t rand_num = rand_(odds_for + odds_against); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 137 | |
Tri Vo | f4037d4 | 2017-03-31 17:28:25 -0700 | [diff] [blame] | 138 | if (rand_num < odds_for) { |
Tri Vo | afcb024 | 2017-01-17 16:11:01 -0800 | [diff] [blame] | 139 | // Mutate a random function in execution. |
Tri Vo | 9f5fd85 | 2017-05-20 12:32:26 -0700 | [diff] [blame] | 140 | size_t idx = rand_(exec_spec->function_call_size()); |
| 141 | const FuncSpec &rand_api = exec_spec->function_call(idx).api(); |
| 142 | *exec_spec->mutable_function_call(idx)->mutable_api() = Mutate(rand_api); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 143 | } else { |
Tri Vo | afcb024 | 2017-01-17 16:11:01 -0800 | [diff] [blame] | 144 | // Generate a random function call in place of randomly chosen function in |
| 145 | // execution. |
Tri Vo | 9f5fd85 | 2017-05-20 12:32:26 -0700 | [diff] [blame] | 146 | const CompSpec *comp_spec = RandomSelectIface(tbl); |
| 147 | string iface_name = comp_spec->component_name(); |
| 148 | const IfaceSpec &iface_spec = comp_spec->interface(); |
| 149 | |
| 150 | size_t func_idx = rand_(exec_spec->function_call_size()); |
Tri Vo | afcb024 | 2017-01-17 16:11:01 -0800 | [diff] [blame] | 151 | size_t blueprint_idx = rand_(iface_spec.api_size()); |
Tri Vo | 9f5fd85 | 2017-05-20 12:32:26 -0700 | [diff] [blame] | 152 | FuncCall *func_call = exec_spec->mutable_function_call(func_idx); |
| 153 | func_call->set_hidl_interface_name(iface_name); |
| 154 | *func_call->mutable_api() = RandomGen(iface_spec.api(blueprint_idx)); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 155 | } |
| 156 | } |
| 157 | |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 158 | FuncSpec ProtoFuzzerMutator::RandomGen(const FuncSpec &func_spec) { |
| 159 | FuncSpec result{func_spec}; |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 160 | // We'll repopulate arg field. |
| 161 | result.clear_arg(); |
Tri Vo | f4037d4 | 2017-03-31 17:28:25 -0700 | [diff] [blame] | 162 | result.clear_return_type_hidl(); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 163 | for (const auto &var_spec : func_spec.arg()) { |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 164 | VarInstance rand_var_spec = RandomGen(var_spec); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 165 | auto *new_var = result.add_arg(); |
| 166 | new_var->Swap(&rand_var_spec); |
| 167 | } |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 168 | return result; |
| 169 | } |
| 170 | |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 171 | FuncSpec ProtoFuzzerMutator::Mutate(const FuncSpec &func_spec) { |
| 172 | FuncSpec result{func_spec}; |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 173 | size_t num_args = result.arg_size(); |
| 174 | if (num_args > 0) { |
| 175 | size_t rand_arg_idx = rand_(num_args); |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 176 | VarInstance rand_arg = Mutate(result.arg(rand_arg_idx)); |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 177 | result.mutable_arg(rand_arg_idx)->Swap(&rand_arg); |
| 178 | } |
| 179 | return result; |
| 180 | } |
| 181 | |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 182 | static VariableSpecificationMessage Transform( |
| 183 | const VariableSpecificationMessage &var_spec, |
| 184 | unordered_map<VariableType, VarTransformFn> &transform_fns) { |
| 185 | auto type = var_spec.type(); |
| 186 | auto transform_fn = transform_fns.find(type); |
| 187 | if (transform_fn == transform_fns.end()) { |
| 188 | cerr << "Transformation function not found for type: " << type << endl; |
Tri Vo | 4fb63ba | 2017-07-20 15:36:48 -0700 | [diff] [blame] | 189 | std::abort(); |
Tri Vo | afcb024 | 2017-01-17 16:11:01 -0800 | [diff] [blame] | 190 | } |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 191 | return transform_fn->second(var_spec); |
Tri Vo | afcb024 | 2017-01-17 16:11:01 -0800 | [diff] [blame] | 192 | } |
| 193 | |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 194 | VarInstance ProtoFuzzerMutator::RandomGen(const VarSpec &var_spec) { |
| 195 | return Transform(var_spec, random_gen_fns_); |
| 196 | } |
| 197 | |
| 198 | VarInstance ProtoFuzzerMutator::Mutate(const VarInstance &var_instance) { |
| 199 | return Transform(var_instance, mutate_fns_); |
| 200 | } |
| 201 | |
| 202 | const TypeSpec &ProtoFuzzerMutator::FindPredefinedType(string name) { |
| 203 | auto type_spec = predefined_types_.find(name); |
| 204 | if (type_spec == predefined_types_.end()) { |
| 205 | cerr << "Predefined type not found: " << name << endl; |
Tri Vo | 4fb63ba | 2017-07-20 15:36:48 -0700 | [diff] [blame] | 206 | std::abort(); |
Tri Vo | 70c1ab6 | 2017-03-15 09:19:10 -0700 | [diff] [blame] | 207 | } |
| 208 | return type_spec->second; |
| 209 | } |
| 210 | |
| 211 | } // namespace fuzzer |
Tri Vo | 77e0ca0 | 2016-12-05 10:08:59 -0800 | [diff] [blame] | 212 | } // namespace vts |
| 213 | } // namespace android |