blob: da75692194e2264c7525a24d92ba9e612046b337 [file] [log] [blame]
Doug Zongker512536a2010-02-17 16:11:44 -08001/*
2 * Copyright (C) 2009 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
Tao Bao97555da2016-12-15 10:15:06 -080017// See imgdiff.cpp in this directory for a description of the patch file
Doug Zongker512536a2010-02-17 16:11:44 -080018// format.
19
Tao Bao97555da2016-12-15 10:15:06 -080020#include <applypatch/imgpatch.h>
21
22#include <errno.h>
Doug Zongker512536a2010-02-17 16:11:44 -080023#include <stdio.h>
Tao Bao97555da2016-12-15 10:15:06 -080024#include <string.h>
Mark Salyzynf3bb31c2014-03-14 09:39:48 -070025#include <sys/cdefs.h>
Doug Zongker512536a2010-02-17 16:11:44 -080026#include <sys/stat.h>
Doug Zongker512536a2010-02-17 16:11:44 -080027#include <unistd.h>
Doug Zongker512536a2010-02-17 16:11:44 -080028
Tianjie Xua897f952017-05-17 22:41:55 -070029#include <memory>
Tianjie Xuaced5d92016-10-12 10:55:04 -070030#include <string>
Yabin Cuid483c202016-02-03 17:08:52 -080031#include <vector>
32
Tianjie Xua897f952017-05-17 22:41:55 -070033#include <android-base/logging.h>
34#include <android-base/memory.h>
Tao Bao97555da2016-12-15 10:15:06 -080035#include <applypatch/applypatch.h>
36#include <applypatch/imgdiff.h>
37#include <openssl/sha.h>
38#include <zlib.h>
39
Tao Bao38d78d12017-10-09 11:03:38 -070040#include "edify/expr.h"
Tianjie Xu9e1ccd42018-04-25 17:19:20 -070041#include "otautil/print_sha1.h"
Tao Bao38d78d12017-10-09 11:03:38 -070042
Tianjie Xu12b90552017-03-07 14:44:14 -080043static inline int64_t Read8(const void *address) {
44 return android::base::get_unaligned<int64_t>(address);
45}
46
47static inline int32_t Read4(const void *address) {
48 return android::base::get_unaligned<int32_t>(address);
49}
Doug Zongker512536a2010-02-17 16:11:44 -080050
Tianjie Xua897f952017-05-17 22:41:55 -070051// This function is a wrapper of ApplyBSDiffPatch(). It has a custom sink function to deflate the
52// patched data and stream the deflated data to output.
53static bool ApplyBSDiffPatchAndStreamOutput(const uint8_t* src_data, size_t src_len,
Tao Bao1e0941f2017-11-10 11:49:53 -080054 const Value& patch, size_t patch_offset,
Tao Bao8b0b0f12018-04-19 21:02:13 -070055 const char* deflate_header, SinkFn sink) {
Tianjie Xua897f952017-05-17 22:41:55 -070056 size_t expected_target_length = static_cast<size_t>(Read8(deflate_header + 32));
Tianjie Xucc61cf62018-05-23 22:23:31 -070057 CHECK_GT(expected_target_length, 0);
Tianjie Xua897f952017-05-17 22:41:55 -070058 int level = Read4(deflate_header + 40);
59 int method = Read4(deflate_header + 44);
60 int window_bits = Read4(deflate_header + 48);
61 int mem_level = Read4(deflate_header + 52);
62 int strategy = Read4(deflate_header + 56);
63
Tianjie Xu3f638ee2018-04-26 17:23:23 -070064 // TODO(b/67849209) Remove after debugging the unit test flakiness.
65 if (android::base::GetMinimumLogSeverity() <= android::base::LogSeverity::DEBUG) {
66 LOG(DEBUG) << "zlib version " << zlibVersion();
67 }
68
Tao Baofdec1032017-10-24 12:25:41 -070069 z_stream strm;
70 strm.zalloc = Z_NULL;
71 strm.zfree = Z_NULL;
72 strm.opaque = Z_NULL;
73 strm.avail_in = 0;
74 strm.next_in = nullptr;
75 int ret = deflateInit2(&strm, level, method, window_bits, mem_level, strategy);
Tianjie Xua897f952017-05-17 22:41:55 -070076 if (ret != Z_OK) {
77 LOG(ERROR) << "Failed to init uncompressed data deflation: " << ret;
78 return false;
79 }
80
81 // Define a custom sink wrapper that feeds to bspatch. It deflates the available patch data on
82 // the fly and outputs the compressed data to the given sink.
83 size_t actual_target_length = 0;
84 size_t total_written = 0;
85 static constexpr size_t buffer_size = 32768;
Tianjie Xu9e1ccd42018-04-25 17:19:20 -070086 SHA_CTX sha_ctx;
87 SHA1_Init(&sha_ctx);
Tao Baofdec1032017-10-24 12:25:41 -070088 auto compression_sink = [&strm, &actual_target_length, &expected_target_length, &total_written,
Tianjie Xu9e1ccd42018-04-25 17:19:20 -070089 &ret, &sink, &sha_ctx](const uint8_t* data, size_t len) -> size_t {
Tianjie Xua897f952017-05-17 22:41:55 -070090 // The input patch length for an update never exceeds INT_MAX.
Tao Baofdec1032017-10-24 12:25:41 -070091 strm.avail_in = len;
92 strm.next_in = data;
Tianjie Xua897f952017-05-17 22:41:55 -070093 do {
94 std::vector<uint8_t> buffer(buffer_size);
Tao Baofdec1032017-10-24 12:25:41 -070095 strm.avail_out = buffer_size;
96 strm.next_out = buffer.data();
Tianjie Xua897f952017-05-17 22:41:55 -070097 if (actual_target_length + len < expected_target_length) {
Tao Baofdec1032017-10-24 12:25:41 -070098 ret = deflate(&strm, Z_NO_FLUSH);
Tianjie Xua897f952017-05-17 22:41:55 -070099 } else {
Tao Baofdec1032017-10-24 12:25:41 -0700100 ret = deflate(&strm, Z_FINISH);
Tianjie Xua897f952017-05-17 22:41:55 -0700101 }
102 if (ret != Z_OK && ret != Z_STREAM_END) {
103 LOG(ERROR) << "Failed to deflate stream: " << ret;
104 // zero length indicates an error in the sink function of bspatch().
105 return 0;
106 }
107
Tao Baofdec1032017-10-24 12:25:41 -0700108 size_t have = buffer_size - strm.avail_out;
Tianjie Xua897f952017-05-17 22:41:55 -0700109 total_written += have;
110 if (sink(buffer.data(), have) != have) {
111 LOG(ERROR) << "Failed to write " << have << " compressed bytes to output.";
112 return 0;
113 }
Tao Baofdec1032017-10-24 12:25:41 -0700114 } while ((strm.avail_in != 0 || strm.avail_out == 0) && ret != Z_STREAM_END);
Tianjie Xua897f952017-05-17 22:41:55 -0700115
Tianjie Xu3f638ee2018-04-26 17:23:23 -0700116 // TODO(b/67849209) Remove after debugging the unit test flakiness.
117 if (android::base::GetMinimumLogSeverity() <= android::base::LogSeverity::DEBUG) {
118 SHA1_Update(&sha_ctx, data, len);
119 }
120
Tianjie Xua897f952017-05-17 22:41:55 -0700121 actual_target_length += len;
122 return len;
123 };
124
Tao Bao8b0b0f12018-04-19 21:02:13 -0700125 int bspatch_result = ApplyBSDiffPatch(src_data, src_len, patch, patch_offset, compression_sink);
Tao Baofdec1032017-10-24 12:25:41 -0700126 deflateEnd(&strm);
127
Tianjie Xu9e1ccd42018-04-25 17:19:20 -0700128 if (android::base::GetMinimumLogSeverity() <= android::base::LogSeverity::DEBUG) {
129 uint8_t digest[SHA_DIGEST_LENGTH];
130 SHA1_Final(digest, &sha_ctx);
131 LOG(DEBUG) << "sha1 of " << actual_target_length << " bytes input data: " << short_sha1(digest);
132 }
Tao Baofdec1032017-10-24 12:25:41 -0700133 if (bspatch_result != 0) {
Tianjie Xua897f952017-05-17 22:41:55 -0700134 return false;
135 }
136
137 if (ret != Z_STREAM_END) {
138 LOG(ERROR) << "ret is expected to be Z_STREAM_END, but it's " << ret;
139 return false;
140 }
141
142 if (expected_target_length != actual_target_length) {
143 LOG(ERROR) << "target length is expected to be " << expected_target_length << ", but it's "
144 << actual_target_length;
145 return false;
146 }
147 LOG(DEBUG) << "bspatch writes " << total_written << " bytes in total to streaming output.";
148
149 return true;
150}
151
Tao Baof7eb7602017-03-27 15:12:48 -0700152int ApplyImagePatch(const unsigned char* old_data, size_t old_size, const unsigned char* patch_data,
Tao Baoc0e1c462017-02-01 10:20:10 -0800153 size_t patch_size, SinkFn sink) {
Tao Bao511d7592018-06-19 15:56:49 -0700154 Value patch(Value::Type::BLOB,
155 std::string(reinterpret_cast<const char*>(patch_data), patch_size));
Tao Bao8b0b0f12018-04-19 21:02:13 -0700156 return ApplyImagePatch(old_data, old_size, patch, sink, nullptr);
Sen Jiang0cce9cd2016-01-22 20:49:07 +0800157}
158
Tao Bao1e0941f2017-11-10 11:49:53 -0800159int ApplyImagePatch(const unsigned char* old_data, size_t old_size, const Value& patch, SinkFn sink,
Tao Bao8b0b0f12018-04-19 21:02:13 -0700160 const Value* bonus_data) {
Tao Bao1e0941f2017-11-10 11:49:53 -0800161 if (patch.data.size() < 12) {
Tao Bao97555da2016-12-15 10:15:06 -0800162 printf("patch too short to contain header\n");
163 return -1;
164 }
165
Tao Bao1e0941f2017-11-10 11:49:53 -0800166 // IMGDIFF2 uses CHUNK_NORMAL, CHUNK_DEFLATE, and CHUNK_RAW. (IMGDIFF1, which is no longer
167 // supported, used CHUNK_NORMAL and CHUNK_GZIP.)
168 const char* const patch_header = patch.data.data();
169 if (memcmp(patch_header, "IMGDIFF2", 8) != 0) {
Tao Bao97555da2016-12-15 10:15:06 -0800170 printf("corrupt patch file header (magic number)\n");
171 return -1;
172 }
173
Tao Bao1e0941f2017-11-10 11:49:53 -0800174 int num_chunks = Read4(patch_header + 8);
175 size_t pos = 12;
Tao Bao97555da2016-12-15 10:15:06 -0800176 for (int i = 0; i < num_chunks; ++i) {
177 // each chunk's header record starts with 4 bytes.
Tao Bao1e0941f2017-11-10 11:49:53 -0800178 if (pos + 4 > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800179 printf("failed to read chunk %d record\n", i);
180 return -1;
181 }
Tao Bao1e0941f2017-11-10 11:49:53 -0800182 int type = Read4(patch_header + pos);
Tao Bao97555da2016-12-15 10:15:06 -0800183 pos += 4;
184
185 if (type == CHUNK_NORMAL) {
Tao Bao1e0941f2017-11-10 11:49:53 -0800186 const char* normal_header = patch_header + pos;
Tao Bao97555da2016-12-15 10:15:06 -0800187 pos += 24;
Tao Bao1e0941f2017-11-10 11:49:53 -0800188 if (pos > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800189 printf("failed to read chunk %d normal header data\n", i);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800190 return -1;
Tao Bao97555da2016-12-15 10:15:06 -0800191 }
Doug Zongker512536a2010-02-17 16:11:44 -0800192
Tianjie Xu12b90552017-03-07 14:44:14 -0800193 size_t src_start = static_cast<size_t>(Read8(normal_header));
194 size_t src_len = static_cast<size_t>(Read8(normal_header + 8));
195 size_t patch_offset = static_cast<size_t>(Read8(normal_header + 16));
Tao Bao97555da2016-12-15 10:15:06 -0800196
Tao Baof7eb7602017-03-27 15:12:48 -0700197 if (src_start + src_len > old_size) {
Tao Bao97555da2016-12-15 10:15:06 -0800198 printf("source data too short\n");
Doug Zongker512536a2010-02-17 16:11:44 -0800199 return -1;
Tao Bao97555da2016-12-15 10:15:06 -0800200 }
Tao Bao8b0b0f12018-04-19 21:02:13 -0700201 if (ApplyBSDiffPatch(old_data + src_start, src_len, patch, patch_offset, sink) != 0) {
Jinguang Dong391bb7b2017-04-26 10:40:45 +0800202 printf("Failed to apply bsdiff patch.\n");
203 return -1;
204 }
Tianjie Xuffed57a2018-04-23 17:51:45 -0700205
206 LOG(DEBUG) << "Processed chunk type normal";
Tao Bao97555da2016-12-15 10:15:06 -0800207 } else if (type == CHUNK_RAW) {
Tao Bao1e0941f2017-11-10 11:49:53 -0800208 const char* raw_header = patch_header + pos;
Tao Bao97555da2016-12-15 10:15:06 -0800209 pos += 4;
Tao Bao1e0941f2017-11-10 11:49:53 -0800210 if (pos > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800211 printf("failed to read chunk %d raw header data\n", i);
212 return -1;
213 }
Doug Zongker512536a2010-02-17 16:11:44 -0800214
Tao Baof7eb7602017-03-27 15:12:48 -0700215 size_t data_len = static_cast<size_t>(Read4(raw_header));
Doug Zongkerc4351c72010-02-22 14:46:32 -0800216
Tao Bao1e0941f2017-11-10 11:49:53 -0800217 if (pos + data_len > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800218 printf("failed to read chunk %d raw data\n", i);
219 return -1;
220 }
Tao Bao1e0941f2017-11-10 11:49:53 -0800221 if (sink(reinterpret_cast<const unsigned char*>(patch_header + pos), data_len) != data_len) {
Tao Bao97555da2016-12-15 10:15:06 -0800222 printf("failed to write chunk %d raw data\n", i);
223 return -1;
224 }
225 pos += data_len;
Tianjie Xuffed57a2018-04-23 17:51:45 -0700226
227 LOG(DEBUG) << "Processed chunk type raw";
Tao Bao97555da2016-12-15 10:15:06 -0800228 } else if (type == CHUNK_DEFLATE) {
229 // deflate chunks have an additional 60 bytes in their chunk header.
Tao Bao1e0941f2017-11-10 11:49:53 -0800230 const char* deflate_header = patch_header + pos;
Tao Bao97555da2016-12-15 10:15:06 -0800231 pos += 60;
Tao Bao1e0941f2017-11-10 11:49:53 -0800232 if (pos > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800233 printf("failed to read chunk %d deflate header data\n", i);
234 return -1;
235 }
236
Tianjie Xu12b90552017-03-07 14:44:14 -0800237 size_t src_start = static_cast<size_t>(Read8(deflate_header));
238 size_t src_len = static_cast<size_t>(Read8(deflate_header + 8));
239 size_t patch_offset = static_cast<size_t>(Read8(deflate_header + 16));
240 size_t expanded_len = static_cast<size_t>(Read8(deflate_header + 24));
Tao Bao97555da2016-12-15 10:15:06 -0800241
Tao Baof7eb7602017-03-27 15:12:48 -0700242 if (src_start + src_len > old_size) {
Tao Bao97555da2016-12-15 10:15:06 -0800243 printf("source data too short\n");
244 return -1;
245 }
246
247 // Decompress the source data; the chunk header tells us exactly
248 // how big we expect it to be when decompressed.
249
Tao Bao511d7592018-06-19 15:56:49 -0700250 // Note: expanded_len will include the bonus data size if the patch was constructed with
251 // bonus data. The deflation will come up 'bonus_size' bytes short; these must be appended
252 // from the bonus_data value.
253 size_t bonus_size = (i == 1 && bonus_data != nullptr) ? bonus_data->data.size() : 0;
Tao Bao97555da2016-12-15 10:15:06 -0800254
255 std::vector<unsigned char> expanded_source(expanded_len);
256
257 // inflate() doesn't like strm.next_out being a nullptr even with
258 // avail_out being zero (Z_STREAM_ERROR).
259 if (expanded_len != 0) {
260 z_stream strm;
261 strm.zalloc = Z_NULL;
262 strm.zfree = Z_NULL;
263 strm.opaque = Z_NULL;
264 strm.avail_in = src_len;
Tao Bao087bc0c2017-01-19 10:46:39 -0800265 strm.next_in = old_data + src_start;
Tao Bao97555da2016-12-15 10:15:06 -0800266 strm.avail_out = expanded_len;
267 strm.next_out = expanded_source.data();
268
269 int ret = inflateInit2(&strm, -15);
270 if (ret != Z_OK) {
271 printf("failed to init source inflation: %d\n", ret);
272 return -1;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800273 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800274
Tao Bao97555da2016-12-15 10:15:06 -0800275 // Because we've provided enough room to accommodate the output
276 // data, we expect one call to inflate() to suffice.
277 ret = inflate(&strm, Z_SYNC_FLUSH);
278 if (ret != Z_STREAM_END) {
279 printf("source inflation returned %d\n", ret);
280 return -1;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800281 }
Tao Bao97555da2016-12-15 10:15:06 -0800282 // We should have filled the output buffer exactly, except
283 // for the bonus_size.
284 if (strm.avail_out != bonus_size) {
285 printf("source inflation short by %zu bytes\n", strm.avail_out - bonus_size);
286 return -1;
287 }
288 inflateEnd(&strm);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800289
Tao Bao97555da2016-12-15 10:15:06 -0800290 if (bonus_size) {
Tao Bao511d7592018-06-19 15:56:49 -0700291 memcpy(expanded_source.data() + (expanded_len - bonus_size), bonus_data->data.data(),
Tao Bao97555da2016-12-15 10:15:06 -0800292 bonus_size);
293 }
294 }
295
Tianjie Xua897f952017-05-17 22:41:55 -0700296 if (!ApplyBSDiffPatchAndStreamOutput(expanded_source.data(), expanded_len, patch,
Tao Bao8b0b0f12018-04-19 21:02:13 -0700297 patch_offset, deflate_header, sink)) {
Tianjie Xua897f952017-05-17 22:41:55 -0700298 LOG(ERROR) << "Fail to apply streaming bspatch.";
Tao Bao97555da2016-12-15 10:15:06 -0800299 return -1;
300 }
301
Tianjie Xuffed57a2018-04-23 17:51:45 -0700302 LOG(DEBUG) << "Processed chunk type deflate";
Tao Bao97555da2016-12-15 10:15:06 -0800303 } else {
304 printf("patch chunk %d is unknown type %d\n", i, type);
305 return -1;
306 }
307 }
308
309 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800310}