blob: 9794a4878acd8256323f5581b472c19176f3ff58 [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"
41
Tianjie Xu12b90552017-03-07 14:44:14 -080042static inline int64_t Read8(const void *address) {
43 return android::base::get_unaligned<int64_t>(address);
44}
45
46static inline int32_t Read4(const void *address) {
47 return android::base::get_unaligned<int32_t>(address);
48}
Doug Zongker512536a2010-02-17 16:11:44 -080049
Tianjie Xua897f952017-05-17 22:41:55 -070050// This function is a wrapper of ApplyBSDiffPatch(). It has a custom sink function to deflate the
51// patched data and stream the deflated data to output.
52static bool ApplyBSDiffPatchAndStreamOutput(const uint8_t* src_data, size_t src_len,
Tao Bao1e0941f2017-11-10 11:49:53 -080053 const Value& patch, size_t patch_offset,
Tao Bao8b0b0f12018-04-19 21:02:13 -070054 const char* deflate_header, SinkFn sink) {
Tianjie Xua897f952017-05-17 22:41:55 -070055 size_t expected_target_length = static_cast<size_t>(Read8(deflate_header + 32));
56 int level = Read4(deflate_header + 40);
57 int method = Read4(deflate_header + 44);
58 int window_bits = Read4(deflate_header + 48);
59 int mem_level = Read4(deflate_header + 52);
60 int strategy = Read4(deflate_header + 56);
61
Tao Baofdec1032017-10-24 12:25:41 -070062 z_stream strm;
63 strm.zalloc = Z_NULL;
64 strm.zfree = Z_NULL;
65 strm.opaque = Z_NULL;
66 strm.avail_in = 0;
67 strm.next_in = nullptr;
68 int ret = deflateInit2(&strm, level, method, window_bits, mem_level, strategy);
Tianjie Xua897f952017-05-17 22:41:55 -070069 if (ret != Z_OK) {
70 LOG(ERROR) << "Failed to init uncompressed data deflation: " << ret;
71 return false;
72 }
73
74 // Define a custom sink wrapper that feeds to bspatch. It deflates the available patch data on
75 // the fly and outputs the compressed data to the given sink.
76 size_t actual_target_length = 0;
77 size_t total_written = 0;
78 static constexpr size_t buffer_size = 32768;
Tao Baofdec1032017-10-24 12:25:41 -070079 auto compression_sink = [&strm, &actual_target_length, &expected_target_length, &total_written,
Tao Bao8b0b0f12018-04-19 21:02:13 -070080 &ret, &sink](const uint8_t* data, size_t len) -> size_t {
Tianjie Xua897f952017-05-17 22:41:55 -070081 // The input patch length for an update never exceeds INT_MAX.
Tao Baofdec1032017-10-24 12:25:41 -070082 strm.avail_in = len;
83 strm.next_in = data;
Tianjie Xua897f952017-05-17 22:41:55 -070084 do {
85 std::vector<uint8_t> buffer(buffer_size);
Tao Baofdec1032017-10-24 12:25:41 -070086 strm.avail_out = buffer_size;
87 strm.next_out = buffer.data();
Tianjie Xua897f952017-05-17 22:41:55 -070088 if (actual_target_length + len < expected_target_length) {
Tao Baofdec1032017-10-24 12:25:41 -070089 ret = deflate(&strm, Z_NO_FLUSH);
Tianjie Xua897f952017-05-17 22:41:55 -070090 } else {
Tao Baofdec1032017-10-24 12:25:41 -070091 ret = deflate(&strm, Z_FINISH);
Tianjie Xua897f952017-05-17 22:41:55 -070092 }
93 if (ret != Z_OK && ret != Z_STREAM_END) {
94 LOG(ERROR) << "Failed to deflate stream: " << ret;
95 // zero length indicates an error in the sink function of bspatch().
96 return 0;
97 }
98
Tao Baofdec1032017-10-24 12:25:41 -070099 size_t have = buffer_size - strm.avail_out;
Tianjie Xua897f952017-05-17 22:41:55 -0700100 total_written += have;
101 if (sink(buffer.data(), have) != have) {
102 LOG(ERROR) << "Failed to write " << have << " compressed bytes to output.";
103 return 0;
104 }
Tao Baofdec1032017-10-24 12:25:41 -0700105 } while ((strm.avail_in != 0 || strm.avail_out == 0) && ret != Z_STREAM_END);
Tianjie Xua897f952017-05-17 22:41:55 -0700106
107 actual_target_length += len;
108 return len;
109 };
110
Tao Bao8b0b0f12018-04-19 21:02:13 -0700111 int bspatch_result = ApplyBSDiffPatch(src_data, src_len, patch, patch_offset, compression_sink);
Tao Baofdec1032017-10-24 12:25:41 -0700112 deflateEnd(&strm);
113
114 if (bspatch_result != 0) {
Tianjie Xua897f952017-05-17 22:41:55 -0700115 return false;
116 }
117
118 if (ret != Z_STREAM_END) {
119 LOG(ERROR) << "ret is expected to be Z_STREAM_END, but it's " << ret;
120 return false;
121 }
122
123 if (expected_target_length != actual_target_length) {
124 LOG(ERROR) << "target length is expected to be " << expected_target_length << ", but it's "
125 << actual_target_length;
126 return false;
127 }
128 LOG(DEBUG) << "bspatch writes " << total_written << " bytes in total to streaming output.";
129
130 return true;
131}
132
Tao Baof7eb7602017-03-27 15:12:48 -0700133int ApplyImagePatch(const unsigned char* old_data, size_t old_size, const unsigned char* patch_data,
Tao Baoc0e1c462017-02-01 10:20:10 -0800134 size_t patch_size, SinkFn sink) {
Tao Bao97555da2016-12-15 10:15:06 -0800135 Value patch(VAL_BLOB, std::string(reinterpret_cast<const char*>(patch_data), patch_size));
Tao Bao8b0b0f12018-04-19 21:02:13 -0700136 return ApplyImagePatch(old_data, old_size, patch, sink, nullptr);
Sen Jiang0cce9cd2016-01-22 20:49:07 +0800137}
138
Tao Bao1e0941f2017-11-10 11:49:53 -0800139int ApplyImagePatch(const unsigned char* old_data, size_t old_size, const Value& patch, SinkFn sink,
Tao Bao8b0b0f12018-04-19 21:02:13 -0700140 const Value* bonus_data) {
Tao Bao1e0941f2017-11-10 11:49:53 -0800141 if (patch.data.size() < 12) {
Tao Bao97555da2016-12-15 10:15:06 -0800142 printf("patch too short to contain header\n");
143 return -1;
144 }
145
Tao Bao1e0941f2017-11-10 11:49:53 -0800146 // IMGDIFF2 uses CHUNK_NORMAL, CHUNK_DEFLATE, and CHUNK_RAW. (IMGDIFF1, which is no longer
147 // supported, used CHUNK_NORMAL and CHUNK_GZIP.)
148 const char* const patch_header = patch.data.data();
149 if (memcmp(patch_header, "IMGDIFF2", 8) != 0) {
Tao Bao97555da2016-12-15 10:15:06 -0800150 printf("corrupt patch file header (magic number)\n");
151 return -1;
152 }
153
Tao Bao1e0941f2017-11-10 11:49:53 -0800154 int num_chunks = Read4(patch_header + 8);
155 size_t pos = 12;
Tao Bao97555da2016-12-15 10:15:06 -0800156 for (int i = 0; i < num_chunks; ++i) {
157 // each chunk's header record starts with 4 bytes.
Tao Bao1e0941f2017-11-10 11:49:53 -0800158 if (pos + 4 > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800159 printf("failed to read chunk %d record\n", i);
160 return -1;
161 }
Tao Bao1e0941f2017-11-10 11:49:53 -0800162 int type = Read4(patch_header + pos);
Tao Bao97555da2016-12-15 10:15:06 -0800163 pos += 4;
164
165 if (type == CHUNK_NORMAL) {
Tao Bao1e0941f2017-11-10 11:49:53 -0800166 const char* normal_header = patch_header + pos;
Tao Bao97555da2016-12-15 10:15:06 -0800167 pos += 24;
Tao Bao1e0941f2017-11-10 11:49:53 -0800168 if (pos > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800169 printf("failed to read chunk %d normal header data\n", i);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800170 return -1;
Tao Bao97555da2016-12-15 10:15:06 -0800171 }
Doug Zongker512536a2010-02-17 16:11:44 -0800172
Tianjie Xu12b90552017-03-07 14:44:14 -0800173 size_t src_start = static_cast<size_t>(Read8(normal_header));
174 size_t src_len = static_cast<size_t>(Read8(normal_header + 8));
175 size_t patch_offset = static_cast<size_t>(Read8(normal_header + 16));
Tao Bao97555da2016-12-15 10:15:06 -0800176
Tao Baof7eb7602017-03-27 15:12:48 -0700177 if (src_start + src_len > old_size) {
Tao Bao97555da2016-12-15 10:15:06 -0800178 printf("source data too short\n");
Doug Zongker512536a2010-02-17 16:11:44 -0800179 return -1;
Tao Bao97555da2016-12-15 10:15:06 -0800180 }
Tao Bao8b0b0f12018-04-19 21:02:13 -0700181 if (ApplyBSDiffPatch(old_data + src_start, src_len, patch, patch_offset, sink) != 0) {
Jinguang Dong391bb7b2017-04-26 10:40:45 +0800182 printf("Failed to apply bsdiff patch.\n");
183 return -1;
184 }
Tianjie Xuffed57a2018-04-23 17:51:45 -0700185
186 LOG(DEBUG) << "Processed chunk type normal";
Tao Bao97555da2016-12-15 10:15:06 -0800187 } else if (type == CHUNK_RAW) {
Tao Bao1e0941f2017-11-10 11:49:53 -0800188 const char* raw_header = patch_header + pos;
Tao Bao97555da2016-12-15 10:15:06 -0800189 pos += 4;
Tao Bao1e0941f2017-11-10 11:49:53 -0800190 if (pos > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800191 printf("failed to read chunk %d raw header data\n", i);
192 return -1;
193 }
Doug Zongker512536a2010-02-17 16:11:44 -0800194
Tao Baof7eb7602017-03-27 15:12:48 -0700195 size_t data_len = static_cast<size_t>(Read4(raw_header));
Doug Zongkerc4351c72010-02-22 14:46:32 -0800196
Tao Bao1e0941f2017-11-10 11:49:53 -0800197 if (pos + data_len > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800198 printf("failed to read chunk %d raw data\n", i);
199 return -1;
200 }
Tao Bao1e0941f2017-11-10 11:49:53 -0800201 if (sink(reinterpret_cast<const unsigned char*>(patch_header + pos), data_len) != data_len) {
Tao Bao97555da2016-12-15 10:15:06 -0800202 printf("failed to write chunk %d raw data\n", i);
203 return -1;
204 }
205 pos += data_len;
Tianjie Xuffed57a2018-04-23 17:51:45 -0700206
207 LOG(DEBUG) << "Processed chunk type raw";
Tao Bao97555da2016-12-15 10:15:06 -0800208 } else if (type == CHUNK_DEFLATE) {
209 // deflate chunks have an additional 60 bytes in their chunk header.
Tao Bao1e0941f2017-11-10 11:49:53 -0800210 const char* deflate_header = patch_header + pos;
Tao Bao97555da2016-12-15 10:15:06 -0800211 pos += 60;
Tao Bao1e0941f2017-11-10 11:49:53 -0800212 if (pos > patch.data.size()) {
Tao Bao97555da2016-12-15 10:15:06 -0800213 printf("failed to read chunk %d deflate header data\n", i);
214 return -1;
215 }
216
Tianjie Xu12b90552017-03-07 14:44:14 -0800217 size_t src_start = static_cast<size_t>(Read8(deflate_header));
218 size_t src_len = static_cast<size_t>(Read8(deflate_header + 8));
219 size_t patch_offset = static_cast<size_t>(Read8(deflate_header + 16));
220 size_t expanded_len = static_cast<size_t>(Read8(deflate_header + 24));
Tao Bao97555da2016-12-15 10:15:06 -0800221
Tao Baof7eb7602017-03-27 15:12:48 -0700222 if (src_start + src_len > old_size) {
Tao Bao97555da2016-12-15 10:15:06 -0800223 printf("source data too short\n");
224 return -1;
225 }
226
227 // Decompress the source data; the chunk header tells us exactly
228 // how big we expect it to be when decompressed.
229
230 // Note: expanded_len will include the bonus data size if
231 // the patch was constructed with bonus data. The
232 // deflation will come up 'bonus_size' bytes short; these
233 // must be appended from the bonus_data value.
234 size_t bonus_size = (i == 1 && bonus_data != NULL) ? bonus_data->data.size() : 0;
235
236 std::vector<unsigned char> expanded_source(expanded_len);
237
238 // inflate() doesn't like strm.next_out being a nullptr even with
239 // avail_out being zero (Z_STREAM_ERROR).
240 if (expanded_len != 0) {
241 z_stream strm;
242 strm.zalloc = Z_NULL;
243 strm.zfree = Z_NULL;
244 strm.opaque = Z_NULL;
245 strm.avail_in = src_len;
Tao Bao087bc0c2017-01-19 10:46:39 -0800246 strm.next_in = old_data + src_start;
Tao Bao97555da2016-12-15 10:15:06 -0800247 strm.avail_out = expanded_len;
248 strm.next_out = expanded_source.data();
249
250 int ret = inflateInit2(&strm, -15);
251 if (ret != Z_OK) {
252 printf("failed to init source inflation: %d\n", ret);
253 return -1;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800254 }
Doug Zongkerc4351c72010-02-22 14:46:32 -0800255
Tao Bao97555da2016-12-15 10:15:06 -0800256 // Because we've provided enough room to accommodate the output
257 // data, we expect one call to inflate() to suffice.
258 ret = inflate(&strm, Z_SYNC_FLUSH);
259 if (ret != Z_STREAM_END) {
260 printf("source inflation returned %d\n", ret);
261 return -1;
Doug Zongkerc4351c72010-02-22 14:46:32 -0800262 }
Tao Bao97555da2016-12-15 10:15:06 -0800263 // We should have filled the output buffer exactly, except
264 // for the bonus_size.
265 if (strm.avail_out != bonus_size) {
266 printf("source inflation short by %zu bytes\n", strm.avail_out - bonus_size);
267 return -1;
268 }
269 inflateEnd(&strm);
Doug Zongkerc4351c72010-02-22 14:46:32 -0800270
Tao Bao97555da2016-12-15 10:15:06 -0800271 if (bonus_size) {
272 memcpy(expanded_source.data() + (expanded_len - bonus_size), &bonus_data->data[0],
273 bonus_size);
274 }
275 }
276
Tianjie Xua897f952017-05-17 22:41:55 -0700277 if (!ApplyBSDiffPatchAndStreamOutput(expanded_source.data(), expanded_len, patch,
Tao Bao8b0b0f12018-04-19 21:02:13 -0700278 patch_offset, deflate_header, sink)) {
Tianjie Xua897f952017-05-17 22:41:55 -0700279 LOG(ERROR) << "Fail to apply streaming bspatch.";
Tao Bao97555da2016-12-15 10:15:06 -0800280 return -1;
281 }
282
Tianjie Xuffed57a2018-04-23 17:51:45 -0700283 LOG(DEBUG) << "Processed chunk type deflate";
Tao Bao97555da2016-12-15 10:15:06 -0800284 } else {
285 printf("patch chunk %d is unknown type %d\n", i, type);
286 return -1;
287 }
288 }
289
290 return 0;
Doug Zongker512536a2010-02-17 16:11:44 -0800291}