Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 1 | // Copyright 2017 The Chromium Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #include "components/zucchini/patch_writer.h" |
| 6 | |
| 7 | #include <algorithm> |
| 8 | #include <iterator> |
| 9 | |
| 10 | #include "base/numerics/checked_math.h" |
| 11 | #include "base/numerics/safe_conversions.h" |
| 12 | #include "components/zucchini/crc32.h" |
Etienne Pierre-doray | b90a947 | 2021-10-28 21:16:04 +0000 | [diff] [blame] | 13 | #include "components/zucchini/element_detection.h" |
Samuel Huang | 9a6bb56 | 2021-11-17 16:20:51 +0000 | [diff] [blame] | 14 | #include "components/zucchini/version_info.h" |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 15 | |
| 16 | namespace zucchini { |
| 17 | |
| 18 | namespace patch { |
| 19 | |
| 20 | bool SerializeElementMatch(const ElementMatch& element_match, |
| 21 | BufferSink* sink) { |
| 22 | if (!element_match.IsValid()) |
| 23 | return false; |
| 24 | |
| 25 | PatchElementHeader element_header; |
| 26 | element_header.old_offset = |
| 27 | base::checked_cast<uint32_t>(element_match.old_element.offset); |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 28 | element_header.old_length = |
| 29 | base::checked_cast<uint32_t>(element_match.old_element.size); |
Samuel Huang | fd9b41c | 2018-05-04 16:11:56 +0000 | [diff] [blame] | 30 | element_header.new_offset = |
| 31 | base::checked_cast<uint32_t>(element_match.new_element.offset); |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 32 | element_header.new_length = |
| 33 | base::checked_cast<uint32_t>(element_match.new_element.size); |
| 34 | element_header.exe_type = element_match.exe_type(); |
Etienne Pierre-doray | b90a947 | 2021-10-28 21:16:04 +0000 | [diff] [blame] | 35 | element_header.version = DisassemblerVersionOfType(element_match.exe_type()); |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 36 | |
| 37 | return sink->PutValue<PatchElementHeader>(element_header); |
| 38 | } |
| 39 | |
| 40 | size_t SerializedElementMatchSize(const ElementMatch& element_match) { |
| 41 | return sizeof(PatchElementHeader); |
| 42 | } |
| 43 | |
| 44 | bool SerializeBuffer(const std::vector<uint8_t>& buffer, BufferSink* sink) { |
| 45 | // buffer.size() is not encoded as varint to simplify SerializedBufferSize(). |
| 46 | base::CheckedNumeric<uint32_t> size = buffer.size(); |
| 47 | if (!size.IsValid()) |
| 48 | return false; |
| 49 | return sink->PutValue<uint32_t>(size.ValueOrDie()) && |
| 50 | sink->PutRange(buffer.begin(), buffer.end()); |
| 51 | } |
| 52 | |
| 53 | size_t SerializedBufferSize(const std::vector<uint8_t>& buffer) { |
| 54 | return sizeof(uint32_t) + buffer.size(); |
| 55 | } |
| 56 | |
| 57 | } // namespace patch |
| 58 | |
| 59 | /******** EquivalenceSink ********/ |
| 60 | |
| 61 | EquivalenceSink::EquivalenceSink() = default; |
| 62 | EquivalenceSink::EquivalenceSink(const std::vector<uint8_t>& src_skip, |
| 63 | const std::vector<uint8_t>& dst_skip, |
| 64 | const std::vector<uint8_t>& copy_count) |
| 65 | : src_skip_(src_skip), dst_skip_(dst_skip), copy_count_(copy_count) {} |
| 66 | |
| 67 | EquivalenceSink::EquivalenceSink(EquivalenceSink&&) = default; |
| 68 | EquivalenceSink::~EquivalenceSink() = default; |
| 69 | |
| 70 | void EquivalenceSink::PutNext(const Equivalence& equivalence) { |
| 71 | // Equivalences are expected to be given ordered by |dst_offset|. |
| 72 | DCHECK_GE(equivalence.dst_offset, dst_offset_); |
| 73 | // Unsigned values are ensured by above check. |
| 74 | |
| 75 | // Result of substracting 2 unsigned integers is unsigned. Overflow is allowed |
| 76 | // for negative values, as long as uint32_t can hold the result. |
| 77 | uint32_t src_offset_diff = |
| 78 | base::strict_cast<uint32_t>(equivalence.src_offset - src_offset_); |
| 79 | EncodeVarInt<int32_t>(static_cast<int32_t>(src_offset_diff), |
| 80 | std::back_inserter(src_skip_)); |
| 81 | |
| 82 | EncodeVarUInt<uint32_t>( |
| 83 | base::strict_cast<uint32_t>(equivalence.dst_offset - dst_offset_), |
| 84 | std::back_inserter(dst_skip_)); |
| 85 | |
| 86 | EncodeVarUInt<uint32_t>(base::strict_cast<uint32_t>(equivalence.length), |
| 87 | std::back_inserter(copy_count_)); |
| 88 | |
| 89 | src_offset_ = equivalence.src_offset + equivalence.length; |
| 90 | dst_offset_ = equivalence.dst_offset + equivalence.length; |
| 91 | } |
| 92 | |
| 93 | size_t EquivalenceSink::SerializedSize() const { |
| 94 | return patch::SerializedBufferSize(src_skip_) + |
| 95 | patch::SerializedBufferSize(dst_skip_) + |
| 96 | patch::SerializedBufferSize(copy_count_); |
| 97 | } |
| 98 | |
| 99 | bool EquivalenceSink::SerializeInto(BufferSink* sink) const { |
| 100 | return patch::SerializeBuffer(src_skip_, sink) && |
| 101 | patch::SerializeBuffer(dst_skip_, sink) && |
| 102 | patch::SerializeBuffer(copy_count_, sink); |
| 103 | } |
| 104 | |
| 105 | /******** ExtraDataSink ********/ |
| 106 | |
| 107 | ExtraDataSink::ExtraDataSink() = default; |
| 108 | ExtraDataSink::ExtraDataSink(const std::vector<uint8_t>& extra_data) |
| 109 | : extra_data_(extra_data) {} |
| 110 | |
| 111 | ExtraDataSink::ExtraDataSink(ExtraDataSink&&) = default; |
| 112 | ExtraDataSink::~ExtraDataSink() = default; |
| 113 | |
| 114 | void ExtraDataSink::PutNext(ConstBufferView region) { |
| 115 | extra_data_.insert(extra_data_.end(), region.begin(), region.end()); |
| 116 | } |
| 117 | |
| 118 | size_t ExtraDataSink::SerializedSize() const { |
| 119 | return patch::SerializedBufferSize(extra_data_); |
| 120 | } |
| 121 | |
| 122 | bool ExtraDataSink::SerializeInto(BufferSink* sink) const { |
| 123 | return patch::SerializeBuffer(extra_data_, sink); |
| 124 | } |
| 125 | |
| 126 | /******** RawDeltaSink ********/ |
| 127 | |
| 128 | RawDeltaSink::RawDeltaSink() = default; |
| 129 | RawDeltaSink::RawDeltaSink(const std::vector<uint8_t>& raw_delta_skip, |
| 130 | const std::vector<uint8_t>& raw_delta_diff) |
| 131 | : raw_delta_skip_(raw_delta_skip), raw_delta_diff_(raw_delta_diff) {} |
| 132 | |
| 133 | RawDeltaSink::RawDeltaSink(RawDeltaSink&&) = default; |
| 134 | RawDeltaSink::~RawDeltaSink() = default; |
| 135 | |
| 136 | void RawDeltaSink::PutNext(const RawDeltaUnit& delta) { |
| 137 | DCHECK_GE(delta.copy_offset, copy_offset_compensation_); |
| 138 | EncodeVarUInt<uint32_t>(base::strict_cast<uint32_t>( |
| 139 | delta.copy_offset - copy_offset_compensation_), |
| 140 | std::back_inserter(raw_delta_skip_)); |
| 141 | |
| 142 | copy_offset_compensation_ = delta.copy_offset + 1; |
| 143 | |
| 144 | raw_delta_diff_.push_back(delta.diff); |
| 145 | } |
| 146 | |
| 147 | size_t RawDeltaSink::SerializedSize() const { |
| 148 | return patch::SerializedBufferSize(raw_delta_skip_) + |
| 149 | patch::SerializedBufferSize(raw_delta_diff_); |
| 150 | } |
| 151 | |
| 152 | bool RawDeltaSink::SerializeInto(BufferSink* sink) const { |
| 153 | return patch::SerializeBuffer(raw_delta_skip_, sink) && |
| 154 | patch::SerializeBuffer(raw_delta_diff_, sink); |
| 155 | } |
| 156 | |
| 157 | /******** ReferenceDeltaSink ********/ |
| 158 | |
| 159 | ReferenceDeltaSink::ReferenceDeltaSink() = default; |
| 160 | ReferenceDeltaSink::ReferenceDeltaSink( |
| 161 | const std::vector<uint8_t>& reference_delta) |
| 162 | : reference_delta_(reference_delta) {} |
| 163 | |
| 164 | ReferenceDeltaSink::ReferenceDeltaSink(ReferenceDeltaSink&&) = default; |
| 165 | ReferenceDeltaSink::~ReferenceDeltaSink() = default; |
| 166 | |
| 167 | void ReferenceDeltaSink::PutNext(int32_t diff) { |
| 168 | EncodeVarInt<int32_t>(diff, std::back_inserter(reference_delta_)); |
| 169 | } |
| 170 | |
| 171 | size_t ReferenceDeltaSink::SerializedSize() const { |
| 172 | return patch::SerializedBufferSize(reference_delta_); |
| 173 | } |
| 174 | |
| 175 | bool ReferenceDeltaSink::SerializeInto(BufferSink* sink) const { |
| 176 | return patch::SerializeBuffer(reference_delta_, sink); |
| 177 | } |
| 178 | |
| 179 | /******** TargetSink ********/ |
| 180 | |
| 181 | TargetSink::TargetSink() = default; |
| 182 | TargetSink::TargetSink(const std::vector<uint8_t>& extra_targets) |
| 183 | : extra_targets_(extra_targets) {} |
| 184 | |
| 185 | TargetSink::TargetSink(TargetSink&&) = default; |
| 186 | TargetSink::~TargetSink() = default; |
| 187 | |
| 188 | void TargetSink::PutNext(uint32_t target) { |
| 189 | DCHECK_GE(target, target_compensation_); |
| 190 | |
| 191 | EncodeVarUInt<uint32_t>( |
| 192 | base::strict_cast<uint32_t>(target - target_compensation_), |
| 193 | std::back_inserter(extra_targets_)); |
| 194 | |
| 195 | target_compensation_ = target + 1; |
| 196 | } |
| 197 | |
| 198 | size_t TargetSink::SerializedSize() const { |
| 199 | return patch::SerializedBufferSize(extra_targets_); |
| 200 | } |
| 201 | |
| 202 | bool TargetSink::SerializeInto(BufferSink* sink) const { |
| 203 | return patch::SerializeBuffer(extra_targets_, sink); |
| 204 | } |
| 205 | |
| 206 | /******** PatchElementWriter ********/ |
| 207 | |
| 208 | PatchElementWriter::PatchElementWriter() = default; |
| 209 | PatchElementWriter::PatchElementWriter(ElementMatch element_match) |
| 210 | : element_match_(element_match) {} |
| 211 | |
| 212 | PatchElementWriter::PatchElementWriter(PatchElementWriter&&) = default; |
| 213 | PatchElementWriter::~PatchElementWriter() = default; |
| 214 | |
| 215 | size_t PatchElementWriter::SerializedSize() const { |
| 216 | size_t serialized_size = |
| 217 | patch::SerializedElementMatchSize(element_match_) + |
| 218 | equivalences_->SerializedSize() + extra_data_->SerializedSize() + |
| 219 | raw_delta_->SerializedSize() + reference_delta_->SerializedSize(); |
| 220 | |
| 221 | serialized_size += sizeof(uint32_t); |
| 222 | for (const auto& extra_symbols : extra_targets_) |
| 223 | serialized_size += extra_symbols.second.SerializedSize() + 1; |
| 224 | return serialized_size; |
| 225 | } |
| 226 | |
| 227 | bool PatchElementWriter::SerializeInto(BufferSink* sink) const { |
| 228 | bool ok = |
| 229 | patch::SerializeElementMatch(element_match_, sink) && |
| 230 | equivalences_->SerializeInto(sink) && extra_data_->SerializeInto(sink) && |
| 231 | raw_delta_->SerializeInto(sink) && reference_delta_->SerializeInto(sink); |
| 232 | if (!ok) |
| 233 | return false; |
| 234 | |
| 235 | if (!sink->PutValue<uint32_t>( |
| 236 | base::checked_cast<uint32_t>(extra_targets_.size()))) |
| 237 | return false; |
| 238 | for (const auto& extra_target_sink : extra_targets_) { |
| 239 | if (!sink->PutValue<uint8_t>(extra_target_sink.first.value())) |
| 240 | return false; |
| 241 | if (!extra_target_sink.second.SerializeInto(sink)) |
| 242 | return false; |
| 243 | } |
| 244 | return true; |
| 245 | } |
| 246 | |
| 247 | /******** EnsemblePatchWriter ********/ |
| 248 | |
| 249 | EnsemblePatchWriter::~EnsemblePatchWriter() = default; |
| 250 | |
| 251 | EnsemblePatchWriter::EnsemblePatchWriter(const PatchHeader& header) |
| 252 | : header_(header) { |
| 253 | DCHECK_EQ(header_.magic, PatchHeader::kMagic); |
Etienne Pierre-doray | b90a947 | 2021-10-28 21:16:04 +0000 | [diff] [blame] | 254 | DCHECK_EQ(header_.major_version, kMajorVersion); |
| 255 | DCHECK_EQ(header_.minor_version, kMinorVersion); |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | EnsemblePatchWriter::EnsemblePatchWriter(ConstBufferView old_image, |
| 259 | ConstBufferView new_image) { |
| 260 | header_.magic = PatchHeader::kMagic; |
Etienne Pierre-doray | b90a947 | 2021-10-28 21:16:04 +0000 | [diff] [blame] | 261 | header_.major_version = kMajorVersion; |
| 262 | header_.minor_version = kMinorVersion; |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 263 | header_.old_size = base::checked_cast<uint32_t>(old_image.size()); |
| 264 | header_.old_crc = CalculateCrc32(old_image.begin(), old_image.end()); |
| 265 | header_.new_size = base::checked_cast<uint32_t>(new_image.size()); |
| 266 | header_.new_crc = CalculateCrc32(new_image.begin(), new_image.end()); |
| 267 | } |
| 268 | |
| 269 | void EnsemblePatchWriter::AddElement(PatchElementWriter&& patch_element) { |
| 270 | DCHECK(patch_element.new_element().offset == current_dst_offset_); |
| 271 | current_dst_offset_ = patch_element.new_element().EndOffset(); |
| 272 | elements_.push_back(std::move(patch_element)); |
| 273 | } |
| 274 | |
| 275 | size_t EnsemblePatchWriter::SerializedSize() const { |
Samuel Huang | 1a73d78 | 2018-03-28 22:20:09 +0000 | [diff] [blame] | 276 | size_t serialized_size = sizeof(PatchHeader) + sizeof(uint32_t); |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 277 | for (const auto& patch_element : elements_) { |
| 278 | serialized_size += patch_element.SerializedSize(); |
| 279 | } |
| 280 | return serialized_size; |
| 281 | } |
| 282 | |
| 283 | bool EnsemblePatchWriter::SerializeInto(BufferSink* sink) const { |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 284 | DCHECK_EQ(current_dst_offset_, header_.new_size); |
| 285 | bool ok = |
| 286 | sink->PutValue<PatchHeader>(header_) && |
Samuel Huang | 06f1ae9 | 2018-03-13 18:19:34 +0000 | [diff] [blame] | 287 | sink->PutValue<uint32_t>(base::checked_cast<uint32_t>(elements_.size())); |
| 288 | if (!ok) |
| 289 | return false; |
| 290 | |
| 291 | for (const auto& element : elements_) { |
| 292 | if (!element.SerializeInto(sink)) |
| 293 | return false; |
| 294 | } |
| 295 | return true; |
| 296 | } |
| 297 | |
| 298 | } // namespace zucchini |