Vitaly Buka | 00b6107 | 2016-10-19 23:22:51 | [diff] [blame] | 1 | // Copyright 2016 Google Inc. All rights reserved. |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
Vitaly Buka | f90698f | 2017-03-01 23:46:58 | [diff] [blame] | 15 | #include "src/mutator.h" |
Vitaly Buka | 00b6107 | 2016-10-19 23:22:51 | [diff] [blame] | 16 | |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 17 | #include <algorithm> |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 18 | #include <bitset> |
Vitaly Buka | 0e17fd7 | 2016-11-18 18:02:46 | [diff] [blame] | 19 | #include <map> |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 20 | #include <memory> |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 21 | #include <random> |
Vitaly Buka | 0e17fd7 | 2016-11-18 18:02:46 | [diff] [blame] | 22 | #include <string> |
Allen-Webb | c4fa591 | 2018-09-07 22:53:30 | [diff] [blame] | 23 | #include <vector> |
Vitaly Buka | 00b6107 | 2016-10-19 23:22:51 | [diff] [blame] | 24 | |
Vitaly Buka | 9dd2f8e | 2017-01-13 08:48:31 | [diff] [blame] | 25 | #include "src/field_instance.h" |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 26 | #include "src/utf8_fix.h" |
Vitaly Buka | 9dd2f8e | 2017-01-13 08:48:31 | [diff] [blame] | 27 | #include "src/weighted_reservoir_sampler.h" |
Vitaly Buka | 00b6107 | 2016-10-19 23:22:51 | [diff] [blame] | 28 | |
Vitaly Buka | f86815c | 2017-02-27 22:19:19 | [diff] [blame] | 29 | namespace protobuf_mutator { |
| 30 | |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 31 | using protobuf::Any; |
Vitaly Buka | 6c6dbbe | 2017-02-22 21:58:24 | [diff] [blame] | 32 | using protobuf::Descriptor; |
Vitaly Buka | 6c6dbbe | 2017-02-22 21:58:24 | [diff] [blame] | 33 | using protobuf::FieldDescriptor; |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 34 | using protobuf::FileDescriptor; |
Vitaly Buka | 6c6dbbe | 2017-02-22 21:58:24 | [diff] [blame] | 35 | using protobuf::Message; |
| 36 | using protobuf::OneofDescriptor; |
| 37 | using protobuf::Reflection; |
Vitaly Buka | 4782c14 | 2017-03-04 08:12:32 | [diff] [blame] | 38 | using protobuf::util::MessageDifferencer; |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 39 | using std::placeholders::_1; |
Vitaly Buka | 0e17fd7 | 2016-11-18 18:02:46 | [diff] [blame] | 40 | |
| 41 | namespace { |
| 42 | |
Vitaly Buka | e4eae60 | 2017-09-29 00:28:12 | [diff] [blame] | 43 | const int kMaxInitializeDepth = 200; |
Vitaly Buka | 329fa46 | 2017-03-15 23:52:17 | [diff] [blame] | 44 | const uint64_t kDefaultMutateWeight = 1000000; |
Vitaly Buka | 0e17fd7 | 2016-11-18 18:02:46 | [diff] [blame] | 45 | |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 46 | enum class Mutation : uint8_t { |
Vitaly Buka | 30de309 | 2016-11-18 19:39:07 | [diff] [blame] | 47 | None, |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 48 | Add, // Adds new field with default value. |
| 49 | Mutate, // Mutates field contents. |
| 50 | Delete, // Deletes field. |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 51 | Copy, // Copy values copied from another field. |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 52 | Clone, // Create new field with value copied from another. |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 53 | |
| 54 | Last = Clone, |
Vitaly Buka | 0e17fd7 | 2016-11-18 18:02:46 | [diff] [blame] | 55 | }; |
| 56 | |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 57 | using MutationBitset = std::bitset<static_cast<size_t>(Mutation::Last)>; |
| 58 | |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 59 | using Messages = std::vector<Message*>; |
| 60 | using ConstMessages = std::vector<const Message*>; |
| 61 | |
Vitaly Buka | b592ff0 | 2017-03-03 22:35:52 | [diff] [blame] | 62 | // Return random integer from [0, count) |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 63 | size_t GetRandomIndex(RandomEngine* random, size_t count) { |
Vitaly Buka | b592ff0 | 2017-03-03 22:35:52 | [diff] [blame] | 64 | assert(count > 0); |
| 65 | if (count == 1) return 0; |
| 66 | return std::uniform_int_distribution<size_t>(0, count - 1)(*random); |
| 67 | } |
| 68 | |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 69 | // Flips random bit in the buffer. |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 70 | void FlipBit(size_t size, uint8_t* bytes, RandomEngine* random) { |
Vitaly Buka | b592ff0 | 2017-03-03 22:35:52 | [diff] [blame] | 71 | size_t bit = GetRandomIndex(random, size * 8); |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 72 | bytes[bit / 8] ^= (1u << (bit % 8)); |
| 73 | } |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 74 | |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 75 | // Flips random bit in the value. |
| 76 | template <class T> |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 77 | T FlipBit(T value, RandomEngine* random) { |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 78 | FlipBit(sizeof(value), reinterpret_cast<uint8_t*>(&value), random); |
| 79 | return value; |
| 80 | } |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 81 | |
Vitaly Buka | beb9080 | 2017-02-28 23:28:10 | [diff] [blame] | 82 | // Return true with probability about 1-of-n. |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 83 | bool GetRandomBool(RandomEngine* random, size_t n = 2) { |
Vitaly Buka | beb9080 | 2017-02-28 23:28:10 | [diff] [blame] | 84 | return GetRandomIndex(random, n) == 0; |
| 85 | } |
| 86 | |
Vitaly Buka | 28ca0ee | 2017-03-05 05:35:42 | [diff] [blame] | 87 | bool IsProto3SimpleField(const FieldDescriptor& field) { |
| 88 | assert(field.file()->syntax() == FileDescriptor::SYNTAX_PROTO3 || |
| 89 | field.file()->syntax() == FileDescriptor::SYNTAX_PROTO2); |
| 90 | return field.file()->syntax() == FileDescriptor::SYNTAX_PROTO3 && |
| 91 | field.cpp_type() != FieldDescriptor::CPPTYPE_MESSAGE && |
| 92 | !field.containing_oneof() && !field.is_repeated(); |
| 93 | } |
| 94 | |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 95 | struct CreateDefaultField : public FieldFunction<CreateDefaultField> { |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 96 | template <class T> |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 97 | void ForType(const FieldInstance& field) const { |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 98 | T value; |
| 99 | field.GetDefault(&value); |
| 100 | field.Create(value); |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 101 | } |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 102 | }; |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 103 | |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 104 | struct DeleteField : public FieldFunction<DeleteField> { |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 105 | template <class T> |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 106 | void ForType(const FieldInstance& field) const { |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 107 | field.Delete(); |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 108 | } |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 109 | }; |
| 110 | |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 111 | struct CopyField : public FieldFunction<CopyField> { |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 112 | template <class T> |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 113 | void ForType(const ConstFieldInstance& source, |
| 114 | const FieldInstance& field) const { |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 115 | T value; |
| 116 | source.Load(&value); |
| 117 | field.Store(value); |
| 118 | } |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 119 | }; |
| 120 | |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 121 | struct AppendField : public FieldFunction<AppendField> { |
Vitaly Buka | adfc27c | 2017-02-27 06:36:36 | [diff] [blame] | 122 | template <class T> |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 123 | void ForType(const ConstFieldInstance& source, |
| 124 | const FieldInstance& field) const { |
Vitaly Buka | adfc27c | 2017-02-27 06:36:36 | [diff] [blame] | 125 | T value; |
| 126 | source.Load(&value); |
| 127 | field.Create(value); |
| 128 | } |
Vitaly Buka | adfc27c | 2017-02-27 06:36:36 | [diff] [blame] | 129 | }; |
| 130 | |
Vitaly Buka | 2792ed7 | 2019-01-23 19:04:24 | [diff] [blame] | 131 | class CanCopyAndDifferentField |
| 132 | : public FieldFunction<CanCopyAndDifferentField, bool> { |
Vitaly Buka | 4782c14 | 2017-03-04 08:12:32 | [diff] [blame] | 133 | public: |
| 134 | template <class T> |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 135 | bool ForType(const ConstFieldInstance& src, const ConstFieldInstance& dst, |
| 136 | int size_increase_hint) const { |
Vitaly Buka | 2792ed7 | 2019-01-23 19:04:24 | [diff] [blame] | 137 | T s; |
| 138 | src.Load(&s); |
| 139 | if (!dst.CanStore(s)) return false; |
| 140 | T d; |
| 141 | dst.Load(&d); |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 142 | return SizeDiff(s, d) <= size_increase_hint && !IsEqual(s, d); |
Vitaly Buka | 4782c14 | 2017-03-04 08:12:32 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | private: |
| 146 | bool IsEqual(const ConstFieldInstance::Enum& a, |
| 147 | const ConstFieldInstance::Enum& b) const { |
| 148 | assert(a.count == b.count); |
| 149 | return a.index == b.index; |
| 150 | } |
| 151 | |
Vitaly Buka | d360027 | 2020-01-27 07:24:10 | [diff] [blame] | 152 | bool IsEqual(const std::unique_ptr<Message>& a, |
| 153 | const std::unique_ptr<Message>& b) const { |
Vitaly Buka | 4782c14 | 2017-03-04 08:12:32 | [diff] [blame] | 154 | return MessageDifferencer::Equals(*a, *b); |
| 155 | } |
| 156 | |
| 157 | template <class T> |
| 158 | bool IsEqual(const T& a, const T& b) const { |
| 159 | return a == b; |
| 160 | } |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 161 | |
Vitaly Buka | d360027 | 2020-01-27 07:24:10 | [diff] [blame] | 162 | int64_t SizeDiff(const std::unique_ptr<Message>& src, |
| 163 | const std::unique_ptr<Message>& dst) const { |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 164 | return src->ByteSizeLong() - dst->ByteSizeLong(); |
| 165 | } |
| 166 | |
| 167 | int64_t SizeDiff(const std::string& src, const std::string& dst) const { |
| 168 | return src.size() - dst.size(); |
| 169 | } |
| 170 | |
| 171 | template <class T> |
| 172 | int64_t SizeDiff(const T&, const T&) const { |
| 173 | return 0; |
| 174 | } |
Vitaly Buka | 4782c14 | 2017-03-04 08:12:32 | [diff] [blame] | 175 | }; |
| 176 | |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 177 | // Selects random field and mutation from the given proto message. |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 178 | class MutationSampler { |
Vitaly Buka | c9d2248 | 2016-11-21 21:29:17 | [diff] [blame] | 179 | public: |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 180 | MutationSampler(bool keep_initialized, MutationBitset allowed_mutations, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 181 | RandomEngine* random) |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 182 | : keep_initialized_(keep_initialized), |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 183 | allowed_mutations_(allowed_mutations), |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 184 | random_(random), |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 185 | sampler_(random) {} |
Vitaly Buka | c9d2248 | 2016-11-21 21:29:17 | [diff] [blame] | 186 | |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 187 | // Returns selected field. |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 188 | const FieldInstance& field() const { return sampler_.selected().field; } |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 189 | |
| 190 | // Returns selected mutation. |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 191 | Mutation mutation() const { return sampler_.selected().mutation; } |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 192 | |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 193 | void Sample(Message* message) { |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 194 | SampleImpl(message); |
| 195 | assert(mutation() != Mutation::None || |
| 196 | !allowed_mutations_[static_cast<size_t>(Mutation::Mutate)] || |
| 197 | message->GetDescriptor()->field_count() == 0); |
| 198 | } |
| 199 | |
| 200 | private: |
| 201 | void SampleImpl(Message* message) { |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 202 | const Descriptor* descriptor = message->GetDescriptor(); |
| 203 | const Reflection* reflection = message->GetReflection(); |
| 204 | |
| 205 | int field_count = descriptor->field_count(); |
| 206 | for (int i = 0; i < field_count; ++i) { |
| 207 | const FieldDescriptor* field = descriptor->field(i); |
| 208 | if (const OneofDescriptor* oneof = field->containing_oneof()) { |
| 209 | // Handle entire oneof group on the first field. |
| 210 | if (field->index_in_oneof() == 0) { |
Vitaly Buka | 2f660a5 | 2017-03-04 03:46:14 | [diff] [blame] | 211 | assert(oneof->field_count()); |
| 212 | const FieldDescriptor* current_field = |
| 213 | reflection->GetOneofFieldDescriptor(*message, oneof); |
| 214 | for (;;) { |
| 215 | const FieldDescriptor* add_field = |
| 216 | oneof->field(GetRandomIndex(random_, oneof->field_count())); |
| 217 | if (add_field != current_field) { |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 218 | Try({message, add_field}, Mutation::Add); |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 219 | Try({message, add_field}, Mutation::Clone); |
Vitaly Buka | 2f660a5 | 2017-03-04 03:46:14 | [diff] [blame] | 220 | break; |
| 221 | } |
| 222 | if (oneof->field_count() < 2) break; |
| 223 | } |
| 224 | if (current_field) { |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 225 | if (current_field->cpp_type() != FieldDescriptor::CPPTYPE_MESSAGE) |
| 226 | Try({message, current_field}, Mutation::Mutate); |
| 227 | Try({message, current_field}, Mutation::Delete); |
| 228 | Try({message, current_field}, Mutation::Copy); |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 229 | } |
| 230 | } |
| 231 | } else { |
| 232 | if (field->is_repeated()) { |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 233 | int field_size = reflection->FieldSize(*message, field); |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 234 | size_t random_index = GetRandomIndex(random_, field_size + 1); |
| 235 | Try({message, field, random_index}, Mutation::Add); |
| 236 | Try({message, field, random_index}, Mutation::Clone); |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 237 | |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 238 | if (field_size) { |
| 239 | size_t random_index = GetRandomIndex(random_, field_size); |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 240 | if (field->cpp_type() != FieldDescriptor::CPPTYPE_MESSAGE) |
| 241 | Try({message, field, random_index}, Mutation::Mutate); |
| 242 | Try({message, field, random_index}, Mutation::Delete); |
| 243 | Try({message, field, random_index}, Mutation::Copy); |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 244 | } |
| 245 | } else { |
Vitaly Buka | 28ca0ee | 2017-03-05 05:35:42 | [diff] [blame] | 246 | if (reflection->HasField(*message, field) || |
| 247 | IsProto3SimpleField(*field)) { |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 248 | if (field->cpp_type() != FieldDescriptor::CPPTYPE_MESSAGE) |
| 249 | Try({message, field}, Mutation::Mutate); |
Vitaly Buka | 28ca0ee | 2017-03-05 05:35:42 | [diff] [blame] | 250 | if (!IsProto3SimpleField(*field) && |
| 251 | (!field->is_required() || !keep_initialized_)) { |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 252 | Try({message, field}, Mutation::Delete); |
Vitaly Buka | 28ca0ee | 2017-03-05 05:35:42 | [diff] [blame] | 253 | } |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 254 | Try({message, field}, Mutation::Copy); |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 255 | } else { |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 256 | Try({message, field}, Mutation::Add); |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 257 | Try({message, field}, Mutation::Clone); |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 258 | } |
| 259 | } |
| 260 | } |
| 261 | |
| 262 | if (field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE) { |
| 263 | if (field->is_repeated()) { |
| 264 | const int field_size = reflection->FieldSize(*message, field); |
| 265 | for (int j = 0; j < field_size; ++j) |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 266 | SampleImpl(reflection->MutableRepeatedMessage(message, field, j)); |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 267 | } else if (reflection->HasField(*message, field)) { |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 268 | SampleImpl(reflection->MutableMessage(message, field)); |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 269 | } |
| 270 | } |
| 271 | } |
| 272 | } |
| 273 | |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 274 | void Try(const FieldInstance& field, Mutation mutation) { |
| 275 | assert(mutation != Mutation::None); |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 276 | if (!allowed_mutations_[static_cast<size_t>(mutation)]) return; |
Vitaly Buka | 4908d25 | 2020-01-25 03:10:34 | [diff] [blame] | 277 | sampler_.Try(kDefaultMutateWeight, {field, mutation}); |
| 278 | } |
| 279 | |
Vitaly Buka | 781853c | 2016-11-22 07:09:35 | [diff] [blame] | 280 | bool keep_initialized_ = false; |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 281 | MutationBitset allowed_mutations_; |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 282 | |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 283 | RandomEngine* random_; |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 284 | |
| 285 | struct Result { |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 286 | Result() = default; |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 287 | Result(const FieldInstance& f, Mutation m) : field(f), mutation(m) {} |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 288 | |
Vitaly Buka | bec5222 | 2016-12-09 22:29:32 | [diff] [blame] | 289 | FieldInstance field; |
| 290 | Mutation mutation = Mutation::None; |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 291 | }; |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 292 | WeightedReservoirSampler<Result, RandomEngine> sampler_; |
Vitaly Buka | c9d2248 | 2016-11-21 21:29:17 | [diff] [blame] | 293 | }; |
| 294 | |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 295 | // Selects random field of compatible type to use for clone mutations. |
| 296 | class DataSourceSampler { |
| 297 | public: |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 298 | DataSourceSampler(const ConstFieldInstance& match, RandomEngine* random, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 299 | int size_increase_hint) |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 300 | : match_(match), |
| 301 | random_(random), |
| 302 | size_increase_hint_(size_increase_hint), |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 303 | sampler_(random) {} |
| 304 | |
| 305 | void Sample(const Message& message) { SampleImpl(message); } |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 306 | |
| 307 | // Returns selected field. |
Vitaly Buka | 8871286 | 2017-02-27 06:21:30 | [diff] [blame] | 308 | const ConstFieldInstance& field() const { |
Vitaly Buka | 72019dc | 2016-12-15 03:17:24 | [diff] [blame] | 309 | assert(!IsEmpty()); |
| 310 | return sampler_.selected(); |
| 311 | } |
| 312 | |
| 313 | bool IsEmpty() const { return sampler_.IsEmpty(); } |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 314 | |
| 315 | private: |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 316 | void SampleImpl(const Message& message) { |
Vitaly Buka | 0f63f91 | 2020-01-24 23:02:45 | [diff] [blame] | 317 | const Descriptor* descriptor = message.GetDescriptor(); |
| 318 | const Reflection* reflection = message.GetReflection(); |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 319 | |
| 320 | int field_count = descriptor->field_count(); |
| 321 | for (int i = 0; i < field_count; ++i) { |
| 322 | const FieldDescriptor* field = descriptor->field(i); |
| 323 | if (field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE) { |
| 324 | if (field->is_repeated()) { |
Vitaly Buka | 0f63f91 | 2020-01-24 23:02:45 | [diff] [blame] | 325 | const int field_size = reflection->FieldSize(message, field); |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 326 | for (int j = 0; j < field_size; ++j) { |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 327 | SampleImpl(reflection->GetRepeatedMessage(message, field, j)); |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 328 | } |
Vitaly Buka | 0f63f91 | 2020-01-24 23:02:45 | [diff] [blame] | 329 | } else if (reflection->HasField(message, field)) { |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 330 | SampleImpl(reflection->GetMessage(message, field)); |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 331 | } |
| 332 | } |
| 333 | |
| 334 | if (field->cpp_type() != match_.cpp_type()) continue; |
| 335 | if (match_.cpp_type() == FieldDescriptor::CPPTYPE_ENUM) { |
| 336 | if (field->enum_type() != match_.enum_type()) continue; |
| 337 | } else if (match_.cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE) { |
| 338 | if (field->message_type() != match_.message_type()) continue; |
| 339 | } |
| 340 | |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 341 | if (field->is_repeated()) { |
Vitaly Buka | 0f63f91 | 2020-01-24 23:02:45 | [diff] [blame] | 342 | if (int field_size = reflection->FieldSize(message, field)) { |
| 343 | ConstFieldInstance source(&message, field, |
Vitaly Buka | 4782c14 | 2017-03-04 08:12:32 | [diff] [blame] | 344 | GetRandomIndex(random_, field_size)); |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 345 | if (CanCopyAndDifferentField()(source, match_, size_increase_hint_)) |
Vitaly Buka | 4782c14 | 2017-03-04 08:12:32 | [diff] [blame] | 346 | sampler_.Try(field_size, source); |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 347 | } |
| 348 | } else { |
Vitaly Buka | 0f63f91 | 2020-01-24 23:02:45 | [diff] [blame] | 349 | if (reflection->HasField(message, field)) { |
| 350 | ConstFieldInstance source(&message, field); |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 351 | if (CanCopyAndDifferentField()(source, match_, size_increase_hint_)) |
Vitaly Buka | 2792ed7 | 2019-01-23 19:04:24 | [diff] [blame] | 352 | sampler_.Try(1, source); |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 353 | } |
| 354 | } |
| 355 | } |
| 356 | } |
| 357 | |
Vitaly Buka | 8871286 | 2017-02-27 06:21:30 | [diff] [blame] | 358 | ConstFieldInstance match_; |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 359 | RandomEngine* random_; |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 360 | int size_increase_hint_; |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 361 | |
Vitaly Buka | f62fe47 | 2017-03-02 07:05:15 | [diff] [blame] | 362 | WeightedReservoirSampler<ConstFieldInstance, RandomEngine> sampler_; |
Vitaly Buka | a3e59c7 | 2016-12-07 00:53:56 | [diff] [blame] | 363 | }; |
| 364 | |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 365 | using UnpackedAny = |
| 366 | std::unordered_map<const Message*, std::unique_ptr<Message>>; |
| 367 | |
| 368 | const Descriptor* GetAnyTypeDescriptor(const Any& any) { |
| 369 | std::string type_name; |
| 370 | if (!Any::ParseAnyTypeUrl(any.type_url(), &type_name)) return nullptr; |
| 371 | return any.descriptor()->file()->pool()->FindMessageTypeByName(type_name); |
| 372 | } |
| 373 | |
| 374 | std::unique_ptr<Message> UnpackAny(const Any& any) { |
| 375 | const Descriptor* desc = GetAnyTypeDescriptor(any); |
| 376 | if (!desc) return {}; |
| 377 | std::unique_ptr<Message> message( |
| 378 | any.GetReflection()->GetMessageFactory()->GetPrototype(desc)->New()); |
| 379 | message->ParsePartialFromString(any.value()); |
| 380 | return message; |
| 381 | } |
| 382 | |
| 383 | const Any* CastToAny(const Message* message) { |
| 384 | return Any::GetDescriptor() == message->GetDescriptor() |
| 385 | ? static_cast<const Any*>(message) |
| 386 | : nullptr; |
| 387 | } |
| 388 | |
| 389 | Any* CastToAny(Message* message) { |
| 390 | return Any::GetDescriptor() == message->GetDescriptor() |
| 391 | ? static_cast<Any*>(message) |
| 392 | : nullptr; |
| 393 | } |
| 394 | |
| 395 | std::unique_ptr<Message> UnpackIfAny(const Message& message) { |
| 396 | if (const Any* any = CastToAny(&message)) return UnpackAny(*any); |
| 397 | return {}; |
| 398 | } |
| 399 | |
| 400 | void UnpackAny(const Message& message, UnpackedAny* result) { |
| 401 | if (std::unique_ptr<Message> any = UnpackIfAny(message)) { |
| 402 | UnpackAny(*any, result); |
| 403 | result->emplace(&message, std::move(any)); |
| 404 | return; |
| 405 | } |
| 406 | |
| 407 | const Descriptor* descriptor = message.GetDescriptor(); |
| 408 | const Reflection* reflection = message.GetReflection(); |
| 409 | |
| 410 | for (int i = 0; i < descriptor->field_count(); ++i) { |
| 411 | const FieldDescriptor* field = descriptor->field(i); |
| 412 | if (field->cpp_type() == FieldDescriptor::CPPTYPE_MESSAGE) { |
| 413 | if (field->is_repeated()) { |
| 414 | const int field_size = reflection->FieldSize(message, field); |
| 415 | for (int j = 0; j < field_size; ++j) { |
| 416 | UnpackAny(reflection->GetRepeatedMessage(message, field, j), result); |
| 417 | } |
| 418 | } else if (reflection->HasField(message, field)) { |
| 419 | UnpackAny(reflection->GetMessage(message, field), result); |
| 420 | } |
| 421 | } |
| 422 | } |
| 423 | } |
| 424 | |
Vitaly Buka | 045acda | 2020-01-29 08:26:35 | [diff] [blame] | 425 | class PostProcessing { |
| 426 | public: |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 427 | using PostProcessors = |
| 428 | std::unordered_multimap<const Descriptor*, Mutator::PostProcess>; |
Vitaly Buka | 045acda | 2020-01-29 08:26:35 | [diff] [blame] | 429 | |
| 430 | PostProcessing(bool keep_initialized, const PostProcessors& post_processors, |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 431 | UnpackedAny& any, RandomEngine* random) |
Vitaly Buka | 045acda | 2020-01-29 08:26:35 | [diff] [blame] | 432 | : keep_initialized_(keep_initialized), |
| 433 | post_processors_(post_processors), |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 434 | any_(any), |
Vitaly Buka | 045acda | 2020-01-29 08:26:35 | [diff] [blame] | 435 | random_(random) {} |
| 436 | |
| 437 | void Run(Message* message, int max_depth) { |
| 438 | --max_depth; |
| 439 | const Descriptor* descriptor = message->GetDescriptor(); |
| 440 | |
| 441 | // Apply custom mutators in nested messages before packing any. |
| 442 | const Reflection* reflection = message->GetReflection(); |
| 443 | for (int i = 0; i < descriptor->field_count(); i++) { |
| 444 | const FieldDescriptor* field = descriptor->field(i); |
| 445 | if (keep_initialized_ && |
| 446 | (field->is_required() || descriptor->options().map_entry()) && |
| 447 | !reflection->HasField(*message, field)) { |
| 448 | CreateDefaultField()(FieldInstance(message, field)); |
| 449 | } |
| 450 | |
| 451 | if (field->cpp_type() != FieldDescriptor::CPPTYPE_MESSAGE) continue; |
| 452 | |
| 453 | if (max_depth < 0 && !field->is_required()) { |
| 454 | // Clear deep optional fields to avoid stack overflow. |
| 455 | reflection->ClearField(message, field); |
| 456 | if (field->is_repeated()) |
| 457 | assert(!reflection->FieldSize(*message, field)); |
| 458 | else |
| 459 | assert(!reflection->HasField(*message, field)); |
| 460 | continue; |
| 461 | } |
| 462 | |
| 463 | if (field->is_repeated()) { |
| 464 | const int field_size = reflection->FieldSize(*message, field); |
| 465 | for (int j = 0; j < field_size; ++j) { |
| 466 | Message* nested_message = |
| 467 | reflection->MutableRepeatedMessage(message, field, j); |
| 468 | Run(nested_message, max_depth); |
| 469 | } |
| 470 | } else if (reflection->HasField(*message, field)) { |
| 471 | Message* nested_message = reflection->MutableMessage(message, field); |
| 472 | Run(nested_message, max_depth); |
| 473 | } |
| 474 | } |
| 475 | |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 476 | if (Any* any = CastToAny(message)) { |
| 477 | if (max_depth < 0) { |
| 478 | // Clear deep Any fields to avoid stack overflow. |
| 479 | any->Clear(); |
| 480 | } else { |
| 481 | auto It = any_.find(message); |
| 482 | if (It != any_.end()) { |
| 483 | Run(It->second.get(), max_depth); |
| 484 | // assert(GetAnyTypeDescriptor(*any) == It->second->GetDescriptor()); |
| 485 | // if (GetAnyTypeDescriptor(*any) != It->second->GetDescriptor()) {} |
| 486 | It->second->SerializePartialToString(any->mutable_value()); |
| 487 | } |
| 488 | } |
| 489 | } |
| 490 | |
| 491 | // Call user callback after message trimmed, initialized and packed. |
Vitaly Buka | 045acda | 2020-01-29 08:26:35 | [diff] [blame] | 492 | auto range = post_processors_.equal_range(descriptor); |
| 493 | for (auto it = range.first; it != range.second; ++it) |
| 494 | it->second(message, (*random_)()); |
| 495 | } |
| 496 | |
| 497 | private: |
| 498 | bool keep_initialized_; |
| 499 | const PostProcessors& post_processors_; |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 500 | UnpackedAny& any_; |
Vitaly Buka | 045acda | 2020-01-29 08:26:35 | [diff] [blame] | 501 | RandomEngine* random_; |
| 502 | }; |
| 503 | |
Vitaly Buka | 0e17fd7 | 2016-11-18 18:02:46 | [diff] [blame] | 504 | } // namespace |
| 505 | |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 506 | class FieldMutator { |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 507 | public: |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 508 | FieldMutator(int size_increase_hint, bool enforce_changes, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 509 | bool enforce_utf8_strings, const ConstMessages& sources, |
Vitaly Buka | 0f63f91 | 2020-01-24 23:02:45 | [diff] [blame] | 510 | Mutator* mutator) |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 511 | : size_increase_hint_(size_increase_hint), |
| 512 | enforce_changes_(enforce_changes), |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 513 | enforce_utf8_strings_(enforce_utf8_strings), |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 514 | sources_(sources), |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 515 | mutator_(mutator) {} |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 516 | |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 517 | void Mutate(int32_t* value) const { |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 518 | RepeatMutate(value, std::bind(&Mutator::MutateInt32, mutator_, _1)); |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 519 | } |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 520 | |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 521 | void Mutate(int64_t* value) const { |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 522 | RepeatMutate(value, std::bind(&Mutator::MutateInt64, mutator_, _1)); |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 523 | } |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 524 | |
| 525 | void Mutate(uint32_t* value) const { |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 526 | RepeatMutate(value, std::bind(&Mutator::MutateUInt32, mutator_, _1)); |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 527 | } |
| 528 | |
| 529 | void Mutate(uint64_t* value) const { |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 530 | RepeatMutate(value, std::bind(&Mutator::MutateUInt64, mutator_, _1)); |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 531 | } |
| 532 | |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 533 | void Mutate(float* value) const { |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 534 | RepeatMutate(value, std::bind(&Mutator::MutateFloat, mutator_, _1)); |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 535 | } |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 536 | |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 537 | void Mutate(double* value) const { |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 538 | RepeatMutate(value, std::bind(&Mutator::MutateDouble, mutator_, _1)); |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 539 | } |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 540 | |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 541 | void Mutate(bool* value) const { |
Vitaly Buka | d7f943f | 2019-01-31 22:05:33 | [diff] [blame] | 542 | RepeatMutate(value, std::bind(&Mutator::MutateBool, mutator_, _1)); |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 543 | } |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 544 | |
| 545 | void Mutate(FieldInstance::Enum* value) const { |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 546 | RepeatMutate(&value->index, |
Vitaly Buka | d7f943f | 2019-01-31 22:05:33 | [diff] [blame] | 547 | std::bind(&Mutator::MutateEnum, mutator_, _1, value->count)); |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 548 | assert(value->index < value->count); |
| 549 | } |
| 550 | |
| 551 | void Mutate(std::string* value) const { |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 552 | if (enforce_utf8_strings_) { |
| 553 | RepeatMutate(value, std::bind(&Mutator::MutateUtf8String, mutator_, _1, |
| 554 | size_increase_hint_)); |
| 555 | } else { |
| 556 | RepeatMutate(value, std::bind(&Mutator::MutateString, mutator_, _1, |
| 557 | size_increase_hint_)); |
| 558 | } |
Vitaly Buka | 91ad7b0 | 2016-12-12 23:41:41 | [diff] [blame] | 559 | } |
| 560 | |
Vitaly Buka | b2c4fb5 | 2017-03-16 18:50:40 | [diff] [blame] | 561 | void Mutate(std::unique_ptr<Message>* message) const { |
| 562 | assert(!enforce_changes_); |
| 563 | assert(*message); |
Vitaly Buka | d7f943f | 2019-01-31 22:05:33 | [diff] [blame] | 564 | if (GetRandomBool(mutator_->random(), mutator_->random_to_default_ratio_)) |
| 565 | return; |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 566 | mutator_->MutateImpl(sources_, {message->get()}, false, |
| 567 | size_increase_hint_); |
Vitaly Buka | b2c4fb5 | 2017-03-16 18:50:40 | [diff] [blame] | 568 | } |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 569 | |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 570 | private: |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 571 | template <class T, class F> |
Vitaly Buka | d7f943f | 2019-01-31 22:05:33 | [diff] [blame] | 572 | void RepeatMutate(T* value, F mutate) const { |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 573 | if (!enforce_changes_ && |
Vitaly Buka | d7f943f | 2019-01-31 22:05:33 | [diff] [blame] | 574 | GetRandomBool(mutator_->random(), mutator_->random_to_default_ratio_)) { |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 575 | return; |
Vitaly Buka | b2c4fb5 | 2017-03-16 18:50:40 | [diff] [blame] | 576 | } |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 577 | T tmp = *value; |
| 578 | for (int i = 0; i < 10; ++i) { |
| 579 | *value = mutate(*value); |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 580 | if (!enforce_changes_ || *value != tmp) return; |
Vitaly Buka | 796b112 | 2017-03-03 22:42:02 | [diff] [blame] | 581 | } |
| 582 | } |
| 583 | |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 584 | int size_increase_hint_; |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 585 | size_t enforce_changes_; |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 586 | bool enforce_utf8_strings_; |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 587 | const ConstMessages& sources_; |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 588 | Mutator* mutator_; |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 589 | }; |
| 590 | |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 591 | namespace { |
| 592 | |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 593 | struct MutateField : public FieldFunction<MutateField> { |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 594 | template <class T> |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 595 | void ForType(const FieldInstance& field, int size_increase_hint, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 596 | const ConstMessages& sources, Mutator* mutator) const { |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 597 | T value; |
| 598 | field.Load(&value); |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 599 | FieldMutator(size_increase_hint, true, field.EnforceUtf8(), sources, |
| 600 | mutator) |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 601 | .Mutate(&value); |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 602 | field.Store(value); |
| 603 | } |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 604 | }; |
| 605 | |
Vitaly Buka | d4ab1e7 | 2017-03-04 07:51:19 | [diff] [blame] | 606 | struct CreateField : public FieldFunction<CreateField> { |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 607 | public: |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 608 | template <class T> |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 609 | void ForType(const FieldInstance& field, int size_increase_hint, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 610 | const ConstMessages& sources, Mutator* mutator) const { |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 611 | T value; |
| 612 | field.GetDefault(&value); |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 613 | FieldMutator field_mutator(size_increase_hint, |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 614 | false /* defaults could be useful */, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 615 | field.EnforceUtf8(), sources, mutator); |
Vitaly Buka | 0e9439f | 2017-03-16 00:51:57 | [diff] [blame] | 616 | field_mutator.Mutate(&value); |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 617 | field.Create(value); |
| 618 | } |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 619 | }; |
| 620 | |
| 621 | } // namespace |
| 622 | |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 623 | void Mutator::Seed(uint32_t value) { random_.seed(value); } |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 624 | |
Vitaly Buka | baa1329 | 2020-01-26 03:39:28 | [diff] [blame] | 625 | void Mutator::Mutate(Message* message, size_t max_size_hint) { |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 626 | UnpackedAny any; |
| 627 | UnpackAny(*message, &any); |
| 628 | |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 629 | Messages messages; |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 630 | messages.reserve(any.size() + 1); |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 631 | messages.push_back(message); |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 632 | for (const auto& kv : any) messages.push_back(kv.second.get()); |
| 633 | |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 634 | ConstMessages sources(messages.begin(), messages.end()); |
| 635 | MutateImpl(sources, messages, false, |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 636 | static_cast<int>(max_size_hint) - |
| 637 | static_cast<int>(message->ByteSizeLong())); |
Vitaly Buka | 0e17fd7 | 2016-11-18 18:02:46 | [diff] [blame] | 638 | |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 639 | PostProcessing(keep_initialized_, post_processors_, any, &random_) |
Vitaly Buka | 045acda | 2020-01-29 08:26:35 | [diff] [blame] | 640 | .Run(message, kMaxInitializeDepth); |
Vitaly Buka | 9eaf063 | 2020-01-16 01:30:20 | [diff] [blame] | 641 | assert(IsInitialized(*message)); |
Peter Foley | fe76ed6 | 2019-10-01 00:03:37 | [diff] [blame] | 642 | } |
| 643 | |
Vitaly Buka | 4b3d783 | 2020-01-29 08:34:12 | [diff] [blame] | 644 | void Mutator::CrossOver(const Message& message1, Message* message2, |
| 645 | size_t max_size_hint) { |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 646 | UnpackedAny any; |
| 647 | UnpackAny(*message2, &any); |
| 648 | |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 649 | Messages messages; |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 650 | messages.reserve(any.size() + 1); |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 651 | messages.push_back(message2); |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 652 | for (auto& kv : any) messages.push_back(kv.second.get()); |
| 653 | |
| 654 | UnpackAny(message1, &any); |
| 655 | |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 656 | ConstMessages sources; |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 657 | sources.reserve(any.size() + 2); |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 658 | sources.push_back(&message1); |
Vitaly Buka | 1989ccb | 2020-02-04 23:40:30 | [diff] [blame] | 659 | sources.push_back(message2); |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 660 | for (const auto& kv : any) sources.push_back(kv.second.get()); |
Vitaly Buka | 4b3d783 | 2020-01-29 08:34:12 | [diff] [blame] | 661 | |
Vitaly Buka | dbc4c0f | 2020-01-29 09:22:21 | [diff] [blame^] | 662 | MutateImpl(sources, messages, true, |
| 663 | static_cast<int>(max_size_hint) - |
| 664 | static_cast<int>(message2->ByteSizeLong())); |
| 665 | |
| 666 | PostProcessing(keep_initialized_, post_processors_, any, &random_) |
Vitaly Buka | 4b3d783 | 2020-01-29 08:34:12 | [diff] [blame] | 667 | .Run(message2, kMaxInitializeDepth); |
| 668 | assert(IsInitialized(*message2)); |
| 669 | } |
| 670 | |
Vitaly Buka | d360027 | 2020-01-27 07:24:10 | [diff] [blame] | 671 | void Mutator::RegisterPostProcessor(const Descriptor* desc, |
Peter Foley | fe76ed6 | 2019-10-01 00:03:37 | [diff] [blame] | 672 | PostProcess callback) { |
| 673 | post_processors_.emplace(desc, callback); |
| 674 | } |
| 675 | |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 676 | bool Mutator::MutateImpl(const ConstMessages& sources, const Messages& messages, |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 677 | bool copy_clone_only, int size_increase_hint) { |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 678 | if (size_increase_hint > 0) size_increase_hint /= 2; |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 679 | MutationBitset mutations; |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 680 | if (copy_clone_only) { |
| 681 | mutations[static_cast<size_t>(Mutation::Copy)] = true; |
| 682 | mutations[static_cast<size_t>(Mutation::Clone)] = true; |
| 683 | } else if (size_increase_hint <= 16) { |
Vitaly Buka | c183991 | 2020-01-27 06:32:57 | [diff] [blame] | 684 | mutations[static_cast<size_t>(Mutation::Delete)] = true; |
| 685 | } else { |
| 686 | mutations.set(); |
| 687 | } |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 688 | while (mutations.any()) { |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 689 | MutationSampler mutation(keep_initialized_, mutations, &random_); |
| 690 | for (Message* message : messages) mutation.Sample(message); |
| 691 | |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 692 | switch (mutation.mutation()) { |
| 693 | case Mutation::None: |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 694 | return true; |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 695 | case Mutation::Add: |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 696 | CreateField()(mutation.field(), size_increase_hint, sources, this); |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 697 | return true; |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 698 | case Mutation::Mutate: |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 699 | MutateField()(mutation.field(), size_increase_hint, sources, this); |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 700 | return true; |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 701 | case Mutation::Delete: |
| 702 | DeleteField()(mutation.field()); |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 703 | return true; |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 704 | case Mutation::Clone: { |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 705 | CreateDefaultField()(mutation.field()); |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 706 | DataSourceSampler source_sampler(mutation.field(), &random_, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 707 | size_increase_hint); |
| 708 | for (const Message* source : sources) source_sampler.Sample(*source); |
Vitaly Buka | 1989ccb | 2020-02-04 23:40:30 | [diff] [blame] | 709 | if (source_sampler.IsEmpty()) { |
| 710 | if (!IsProto3SimpleField(*mutation.field().descriptor())) |
| 711 | return true; // CreateField is enough for proto2. |
| 712 | break; |
| 713 | } |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 714 | CopyField()(source_sampler.field(), mutation.field()); |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 715 | return true; |
Vitaly Buka | 5635a7a | 2020-01-26 09:52:40 | [diff] [blame] | 716 | } |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 717 | case Mutation::Copy: { |
Vitaly Buka | 5cd166e | 2020-01-26 06:33:05 | [diff] [blame] | 718 | DataSourceSampler source_sampler(mutation.field(), &random_, |
Vitaly Buka | f62086c | 2020-01-29 09:11:23 | [diff] [blame] | 719 | size_increase_hint); |
| 720 | for (const Message* source : sources) source_sampler.Sample(*source); |
Vitaly Buka | 0f63f91 | 2020-01-24 23:02:45 | [diff] [blame] | 721 | if (source_sampler.IsEmpty()) break; |
| 722 | CopyField()(source_sampler.field(), mutation.field()); |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 723 | return true; |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 724 | } |
| 725 | default: |
| 726 | assert(false && "unexpected mutation"); |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 727 | return false; |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 728 | } |
Vitaly Buka | 1989ccb | 2020-02-04 23:40:30 | [diff] [blame] | 729 | |
| 730 | // Don't try same mutation next time. |
| 731 | mutations[static_cast<size_t>(mutation.mutation())] = false; |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 732 | } |
Vitaly Buka | 9f357ae | 2020-01-27 07:17:11 | [diff] [blame] | 733 | return false; |
Vitaly Buka | 3183b0d | 2019-09-06 22:11:10 | [diff] [blame] | 734 | } |
| 735 | |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 736 | int32_t Mutator::MutateInt32(int32_t value) { return FlipBit(value, &random_); } |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 737 | |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 738 | int64_t Mutator::MutateInt64(int64_t value) { return FlipBit(value, &random_); } |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 739 | |
| 740 | uint32_t Mutator::MutateUInt32(uint32_t value) { |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 741 | return FlipBit(value, &random_); |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 742 | } |
| 743 | |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 744 | uint64_t Mutator::MutateUInt64(uint64_t value) { |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 745 | return FlipBit(value, &random_); |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 746 | } |
| 747 | |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 748 | float Mutator::MutateFloat(float value) { return FlipBit(value, &random_); } |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 749 | |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 750 | double Mutator::MutateDouble(double value) { return FlipBit(value, &random_); } |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 751 | |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 752 | bool Mutator::MutateBool(bool value) { return !value; } |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 753 | |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 754 | size_t Mutator::MutateEnum(size_t index, size_t item_count) { |
Vitaly Buka | ee1c76a | 2017-03-15 17:48:53 | [diff] [blame] | 755 | if (item_count <= 1) return 0; |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 756 | return (index + 1 + GetRandomIndex(&random_, item_count - 1)) % item_count; |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 757 | } |
| 758 | |
Vitaly Buka | e79e018 | 2017-03-02 00:02:14 | [diff] [blame] | 759 | std::string Mutator::MutateString(const std::string& value, |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 760 | int size_increase_hint) { |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 761 | std::string result = value; |
Vitaly Buka | 5d01320 | 2017-02-25 00:50:11 | [diff] [blame] | 762 | |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 763 | while (!result.empty() && GetRandomBool(&random_)) { |
| 764 | result.erase(GetRandomIndex(&random_, result.size()), 1); |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 765 | } |
| 766 | |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 767 | while (size_increase_hint > 0 && |
| 768 | result.size() < static_cast<size_t>(size_increase_hint) && |
| 769 | GetRandomBool(&random_)) { |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 770 | size_t index = GetRandomIndex(&random_, result.size() + 1); |
| 771 | result.insert(result.begin() + index, GetRandomIndex(&random_, 1 << 8)); |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 772 | } |
| 773 | |
Vitaly Buka | c020de1 | 2017-03-04 03:36:23 | [diff] [blame] | 774 | if (result != value) return result; |
| 775 | |
| 776 | if (result.empty()) { |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 777 | result.push_back(GetRandomIndex(&random_, 1 << 8)); |
Vitaly Buka | c020de1 | 2017-03-04 03:36:23 | [diff] [blame] | 778 | return result; |
| 779 | } |
| 780 | |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 781 | if (!result.empty()) |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 782 | FlipBit(result.size(), reinterpret_cast<uint8_t*>(&result[0]), &random_); |
Vitaly Buka | 4af611d | 2016-12-04 02:57:32 | [diff] [blame] | 783 | return result; |
| 784 | } |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 785 | |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 786 | std::string Mutator::MutateUtf8String(const std::string& value, |
Vitaly Buka | 1c91e72 | 2020-01-26 05:56:22 | [diff] [blame] | 787 | int size_increase_hint) { |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 788 | std::string str = MutateString(value, size_increase_hint); |
Vitaly Buka | 379f5ab | 2019-08-31 23:11:59 | [diff] [blame] | 789 | FixUtf8String(&str, &random_); |
Vitaly Buka | af8136f | 2017-06-09 23:40:12 | [diff] [blame] | 790 | return str; |
| 791 | } |
| 792 | |
Vitaly Buka | 9eaf063 | 2020-01-16 01:30:20 | [diff] [blame] | 793 | bool Mutator::IsInitialized(const Message& message) const { |
| 794 | if (!keep_initialized_ || message.IsInitialized()) return true; |
| 795 | std::cerr << "Uninitialized: " << message.DebugString() << "\n"; |
| 796 | return false; |
| 797 | } |
| 798 | |
Vitaly Buka | 432b545 | 2016-12-09 22:42:09 | [diff] [blame] | 799 | } // namespace protobuf_mutator |