blob: eb1f16ac53dc56644bfaf1f7acf8d431afa609f8 [file] [log] [blame]
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include <ctype.h>
Sami Tolvanen90221202014-12-09 16:39:47 +000018#include <dirent.h>
Tao Bao641fa972018-04-25 18:59:40 -070019#include <errno.h>
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070020#include <fcntl.h>
Tao Bao0bbc7642017-03-29 23:57:47 -070021#include <inttypes.h>
Tao Baoba9a42a2015-06-23 23:23:33 -070022#include <linux/fs.h>
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070023#include <pthread.h>
24#include <stdarg.h>
25#include <stdio.h>
26#include <stdlib.h>
27#include <string.h>
Tao Bao641fa972018-04-25 18:59:40 -070028#include <sys/ioctl.h>
Sami Tolvanen90221202014-12-09 16:39:47 +000029#include <sys/stat.h>
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070030#include <sys/types.h>
31#include <sys/wait.h>
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070032#include <time.h>
33#include <unistd.h>
34
Tao Baoec8272f2017-03-15 17:39:01 -070035#include <functional>
Tianjie Xu284752e2017-12-05 11:04:17 -080036#include <limits>
Tao Baoe6aa3322015-08-05 15:20:27 -070037#include <memory>
38#include <string>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070039#include <unordered_map>
Tao Bao0940fe12015-08-27 16:41:21 -070040#include <vector>
Tao Baoe6aa3322015-08-05 15:20:27 -070041
Tianjie Xu284752e2017-12-05 11:04:17 -080042#include <android-base/file.h>
Tao Bao039f2da2016-11-22 16:29:50 -080043#include <android-base/logging.h>
Elliott Hughes4b166f02015-12-04 15:30:20 -080044#include <android-base/parseint.h>
Tianjie Xu58d59122019-05-03 01:05:04 -070045#include <android-base/stringprintf.h>
Elliott Hughes4b166f02015-12-04 15:30:20 -080046#include <android-base/strings.h>
Elliott Hughesbcabd092016-03-22 20:19:22 -070047#include <android-base/unique_fd.h>
Tao Bao51412212016-12-28 14:44:05 -080048#include <applypatch/applypatch.h>
Tianjie Xu107a34f2017-06-29 17:04:21 -070049#include <brotli/decode.h>
Tao Bao641fa972018-04-25 18:59:40 -070050#include <fec/io.h>
Tao Bao51412212016-12-28 14:44:05 -080051#include <openssl/sha.h>
Tianjie Xu69ffa152018-08-01 16:40:00 -070052#include <verity/hash_tree_builder.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070053#include <ziparchive/zip_archive.h>
Tao Baoe6aa3322015-08-05 15:20:27 -070054
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070055#include "edify/expr.h"
Tianjie Xu1536db82019-05-14 10:54:43 -070056#include "edify/updater_interface.h"
Yifan Hong63f52602019-01-11 13:52:33 -080057#include "otautil/dirutil.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070058#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070059#include "otautil/paths.h"
Tao Bao09e468f2017-09-29 14:39:33 -070060#include "otautil/print_sha1.h"
61#include "otautil/rangeset.h"
Tao Baoc3901232018-05-21 16:05:56 -070062#include "private/commands.h"
Tao Bao8f237572017-03-26 13:36:49 -070063#include "updater/install.h"
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070064
Tianjie Xu27556d02019-05-22 14:48:35 -070065#ifdef __ANDROID__
66#include <private/android_filesystem_config.h>
67// Set this to 0 to interpret 'erase' transfers to mean do a BLKDISCARD ioctl (the normal behavior).
68// Set to 1 to interpret erase to mean fill the region with zeroes.
Sami Tolvanene82fa182015-06-10 15:58:12 +000069#define DEBUG_ERASE 0
Tianjie Xu27556d02019-05-22 14:48:35 -070070#else
71#define DEBUG_ERASE 1
72#define AID_SYSTEM -1
73#endif // __ANDROID__
Sami Tolvanene82fa182015-06-10 15:58:12 +000074
Tao Bao51412212016-12-28 14:44:05 -080075static constexpr size_t BLOCKSIZE = 4096;
Tao Bao51412212016-12-28 14:44:05 -080076static constexpr mode_t STASH_DIRECTORY_MODE = 0700;
77static constexpr mode_t STASH_FILE_MODE = 0600;
Yifan Hong8ff84d72018-12-19 16:21:55 -080078static constexpr mode_t MARKER_DIRECTORY_MODE = 0700;
Sami Tolvanen90221202014-12-09 16:39:47 +000079
Tianjie Xu16255832016-04-30 11:49:59 -070080static CauseCode failure_type = kNoCause;
Tianjie Xu7ce287d2016-05-31 09:29:49 -070081static bool is_retry = false;
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070082static std::unordered_map<std::string, RangeSet> stash_map;
Tianjie Xu7eca97e2016-03-22 18:08:12 -070083
Tianjie Xu284752e2017-12-05 11:04:17 -080084static void DeleteLastCommandFile() {
Tao Bao641fa972018-04-25 18:59:40 -070085 const std::string& last_command_file = Paths::Get().last_command_file();
Tianjie Xu284752e2017-12-05 11:04:17 -080086 if (unlink(last_command_file.c_str()) == -1 && errno != ENOENT) {
87 PLOG(ERROR) << "Failed to unlink: " << last_command_file;
88 }
89}
90
91// Parse the last command index of the last update and save the result to |last_command_index|.
92// Return true if we successfully read the index.
Tao Bao26efb0a2018-05-21 14:59:55 -070093static bool ParseLastCommandFile(size_t* last_command_index) {
Tao Bao641fa972018-04-25 18:59:40 -070094 const std::string& last_command_file = Paths::Get().last_command_file();
Tianjie Xu284752e2017-12-05 11:04:17 -080095 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(last_command_file.c_str(), O_RDONLY)));
96 if (fd == -1) {
97 if (errno != ENOENT) {
98 PLOG(ERROR) << "Failed to open " << last_command_file;
99 return false;
100 }
101
102 LOG(INFO) << last_command_file << " doesn't exist.";
103 return false;
104 }
105
106 // Now that the last_command file exists, parse the last command index of previous update.
107 std::string content;
108 if (!android::base::ReadFdToString(fd.get(), &content)) {
109 LOG(ERROR) << "Failed to read: " << last_command_file;
110 return false;
111 }
112
113 std::vector<std::string> lines = android::base::Split(android::base::Trim(content), "\n");
114 if (lines.size() != 2) {
115 LOG(ERROR) << "Unexpected line counts in last command file: " << content;
116 return false;
117 }
118
Tom Cherry04e4afb2018-10-05 14:37:13 -0700119 if (!android::base::ParseUint(lines[0], last_command_index)) {
Tianjie Xu284752e2017-12-05 11:04:17 -0800120 LOG(ERROR) << "Failed to parse integer in: " << lines[0];
121 return false;
122 }
123
124 return true;
125}
126
Tao Bao864c6682018-05-07 11:38:25 -0700127static bool FsyncDir(const std::string& dirname) {
Tianjie Xu22f11202018-08-27 10:50:31 -0700128 android::base::unique_fd dfd(TEMP_FAILURE_RETRY(open(dirname.c_str(), O_RDONLY | O_DIRECTORY)));
Tao Bao864c6682018-05-07 11:38:25 -0700129 if (dfd == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -0700130 failure_type = errno == EIO ? kEioFailure : kFileOpenFailure;
Tao Bao864c6682018-05-07 11:38:25 -0700131 PLOG(ERROR) << "Failed to open " << dirname;
132 return false;
133 }
134 if (fsync(dfd) == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -0700135 failure_type = errno == EIO ? kEioFailure : kFsyncFailure;
Tao Bao864c6682018-05-07 11:38:25 -0700136 PLOG(ERROR) << "Failed to fsync " << dirname;
137 return false;
138 }
139 return true;
140}
141
Tianjie Xuc2b2bb52018-05-15 15:09:59 -0700142// Update the last executed command index in the last_command_file.
Tao Bao26efb0a2018-05-21 14:59:55 -0700143static bool UpdateLastCommandIndex(size_t command_index, const std::string& command_string) {
Tao Bao641fa972018-04-25 18:59:40 -0700144 const std::string& last_command_file = Paths::Get().last_command_file();
Tianjie Xu284752e2017-12-05 11:04:17 -0800145 std::string last_command_tmp = last_command_file + ".tmp";
146 std::string content = std::to_string(command_index) + "\n" + command_string;
147 android::base::unique_fd wfd(
148 TEMP_FAILURE_RETRY(open(last_command_tmp.c_str(), O_WRONLY | O_CREAT | O_TRUNC, 0660)));
149 if (wfd == -1 || !android::base::WriteStringToFd(content, wfd)) {
150 PLOG(ERROR) << "Failed to update last command";
151 return false;
152 }
153
154 if (fsync(wfd) == -1) {
155 PLOG(ERROR) << "Failed to fsync " << last_command_tmp;
156 return false;
157 }
158
159 if (chown(last_command_tmp.c_str(), AID_SYSTEM, AID_SYSTEM) == -1) {
160 PLOG(ERROR) << "Failed to change owner for " << last_command_tmp;
161 return false;
162 }
163
164 if (rename(last_command_tmp.c_str(), last_command_file.c_str()) == -1) {
165 PLOG(ERROR) << "Failed to rename" << last_command_tmp;
166 return false;
167 }
168
Tao Bao864c6682018-05-07 11:38:25 -0700169 if (!FsyncDir(android::base::Dirname(last_command_file))) {
Tianjie Xu284752e2017-12-05 11:04:17 -0800170 return false;
171 }
172
173 return true;
174}
175
Yifan Hong8ff84d72018-12-19 16:21:55 -0800176bool SetUpdatedMarker(const std::string& marker) {
177 auto dirname = android::base::Dirname(marker);
178 auto res = mkdir(dirname.c_str(), MARKER_DIRECTORY_MODE);
179 if (res == -1 && errno != EEXIST) {
180 PLOG(ERROR) << "Failed to create directory for marker: " << dirname;
181 return false;
182 }
183
Tao Bao864c6682018-05-07 11:38:25 -0700184 if (!android::base::WriteStringToFile("", marker)) {
185 PLOG(ERROR) << "Failed to write to marker file " << marker;
Tao Bao0940fe12015-08-27 16:41:21 -0700186 return false;
187 }
Yifan Hong8ff84d72018-12-19 16:21:55 -0800188 if (!FsyncDir(dirname)) {
Tao Bao864c6682018-05-07 11:38:25 -0700189 return false;
190 }
Yifan Hong8ff84d72018-12-19 16:21:55 -0800191 LOG(INFO) << "Wrote updated marker to " << marker;
Tao Bao0940fe12015-08-27 16:41:21 -0700192 return true;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700193}
194
Yifan Hong363d6242019-01-04 11:14:19 -0800195static bool discard_blocks(int fd, off64_t offset, uint64_t size, bool force = false) {
196 // Don't discard blocks unless the update is a retry run or force == true
197 if (!is_retry && !force) {
Tianjie Xu7ce287d2016-05-31 09:29:49 -0700198 return true;
Tao Baobf5b77d2017-03-30 16:57:29 -0700199 }
200
201 uint64_t args[2] = { static_cast<uint64_t>(offset), size };
202 if (ioctl(fd, BLKDISCARD, &args) == -1) {
Yifan Hong363d6242019-01-04 11:14:19 -0800203 // On devices that does not support BLKDISCARD, ignore the error.
204 if (errno == EOPNOTSUPP) {
205 return true;
206 }
Tao Baobf5b77d2017-03-30 16:57:29 -0700207 PLOG(ERROR) << "BLKDISCARD ioctl failed";
208 return false;
209 }
210 return true;
Tianjie Xu7ce287d2016-05-31 09:29:49 -0700211}
212
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700213static bool check_lseek(int fd, off64_t offset, int whence) {
214 off64_t rc = TEMP_FAILURE_RETRY(lseek64(fd, offset, whence));
215 if (rc == -1) {
Tianjie Xu16255832016-04-30 11:49:59 -0700216 failure_type = kLseekFailure;
Tao Bao039f2da2016-11-22 16:29:50 -0800217 PLOG(ERROR) << "lseek64 failed";
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700218 return false;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700219 }
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700220 return true;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700221}
222
Tao Baode3bbb82018-05-30 16:14:14 -0700223static void allocate(size_t size, std::vector<uint8_t>* buffer) {
224 // If the buffer's big enough, reuse it.
225 if (size <= buffer->size()) return;
226 buffer->resize(size);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700227}
228
Tao Bao60a70af2017-03-26 14:03:52 -0700229/**
230 * RangeSinkWriter reads data from the given FD, and writes them to the destination specified by the
231 * given RangeSet.
232 */
233class RangeSinkWriter {
234 public:
235 RangeSinkWriter(int fd, const RangeSet& tgt)
Tianjie Xu107a34f2017-06-29 17:04:21 -0700236 : fd_(fd),
237 tgt_(tgt),
238 next_range_(0),
239 current_range_left_(0),
240 bytes_written_(0) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700241 CHECK_NE(tgt.size(), static_cast<size_t>(0));
Tao Bao60a70af2017-03-26 14:03:52 -0700242 };
Tao Bao0940fe12015-08-27 16:41:21 -0700243
Tao Bao60a70af2017-03-26 14:03:52 -0700244 bool Finished() const {
Tao Baobf5b77d2017-03-30 16:57:29 -0700245 return next_range_ == tgt_.size() && current_range_left_ == 0;
Tao Baof7eb7602017-03-27 15:12:48 -0700246 }
247
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700248 size_t AvailableSpace() const {
249 return tgt_.blocks() * BLOCKSIZE - bytes_written_;
250 }
251
252 // Return number of bytes written; and 0 indicates a writing failure.
253 size_t Write(const uint8_t* data, size_t size) {
Tao Bao60a70af2017-03-26 14:03:52 -0700254 if (Finished()) {
255 LOG(ERROR) << "range sink write overrun; can't write " << size << " bytes";
256 return 0;
Tao Baof7eb7602017-03-27 15:12:48 -0700257 }
258
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700259 size_t written = 0;
Tao Bao60a70af2017-03-26 14:03:52 -0700260 while (size > 0) {
261 // Move to the next range as needed.
Tianjie Xu107a34f2017-06-29 17:04:21 -0700262 if (!SeekToOutputRange()) {
263 break;
Tao Bao60a70af2017-03-26 14:03:52 -0700264 }
Tao Baof7eb7602017-03-27 15:12:48 -0700265
Tao Bao60a70af2017-03-26 14:03:52 -0700266 size_t write_now = size;
267 if (current_range_left_ < write_now) {
268 write_now = current_range_left_;
269 }
Tao Baof7eb7602017-03-27 15:12:48 -0700270
Tianjie Xu22f11202018-08-27 10:50:31 -0700271 if (!android::base::WriteFully(fd_, data, write_now)) {
272 failure_type = errno == EIO ? kEioFailure : kFwriteFailure;
273 PLOG(ERROR) << "Failed to write " << write_now << " bytes of data";
Tao Baof7eb7602017-03-27 15:12:48 -0700274 break;
275 }
Tao Bao60a70af2017-03-26 14:03:52 -0700276
277 data += write_now;
278 size -= write_now;
279
280 current_range_left_ -= write_now;
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700281 written += write_now;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700282 }
Tao Bao60a70af2017-03-26 14:03:52 -0700283
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700284 bytes_written_ += written;
285 return written;
Tao Baof7eb7602017-03-27 15:12:48 -0700286 }
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700287
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700288 size_t BytesWritten() const {
289 return bytes_written_;
290 }
291
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700292 private:
Tianjie Xu107a34f2017-06-29 17:04:21 -0700293 // Set up the output cursor, move to next range if needed.
294 bool SeekToOutputRange() {
295 // We haven't finished the current range yet.
296 if (current_range_left_ != 0) {
297 return true;
298 }
299 // We can't write any more; let the write function return how many bytes have been written
300 // so far.
301 if (next_range_ >= tgt_.size()) {
302 return false;
303 }
304
305 const Range& range = tgt_[next_range_];
306 off64_t offset = static_cast<off64_t>(range.first) * BLOCKSIZE;
307 current_range_left_ = (range.second - range.first) * BLOCKSIZE;
308 next_range_++;
309
310 if (!discard_blocks(fd_, offset, current_range_left_)) {
311 return false;
312 }
313 if (!check_lseek(fd_, offset, SEEK_SET)) {
314 return false;
315 }
316 return true;
317 }
318
319 // The output file descriptor.
Tao Bao60a70af2017-03-26 14:03:52 -0700320 int fd_;
Tianjie Xu107a34f2017-06-29 17:04:21 -0700321 // The destination ranges for the data.
Tao Bao60a70af2017-03-26 14:03:52 -0700322 const RangeSet& tgt_;
323 // The next range that we should write to.
324 size_t next_range_;
325 // The number of bytes to write before moving to the next range.
326 size_t current_range_left_;
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700327 // Total bytes written by the writer.
328 size_t bytes_written_;
Tao Bao60a70af2017-03-26 14:03:52 -0700329};
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700330
Tao Bao60a70af2017-03-26 14:03:52 -0700331/**
332 * All of the data for all the 'new' transfers is contained in one file in the update package,
333 * concatenated together in the order in which transfers.list will need it. We want to stream it out
334 * of the archive (it's compressed) without writing it to a temp file, but we can't write each
335 * section until it's that transfer's turn to go.
336 *
337 * To achieve this, we expand the new data from the archive in a background thread, and block that
338 * threads 'receive uncompressed data' function until the main thread has reached a point where we
339 * want some new data to be written. We signal the background thread with the destination for the
340 * data and block the main thread, waiting for the background thread to complete writing that
341 * section. Then it signals the main thread to wake up and goes back to blocking waiting for a
342 * transfer.
343 *
344 * NewThreadInfo is the struct used to pass information back and forth between the two threads. When
345 * the main thread wants some data written, it sets writer to the destination location and signals
346 * the condition. When the background thread is done writing, it clears writer and signals the
347 * condition again.
348 */
Tao Bao0940fe12015-08-27 16:41:21 -0700349struct NewThreadInfo {
Tao Bao60a70af2017-03-26 14:03:52 -0700350 ZipArchiveHandle za;
351 ZipEntry entry;
Tianjie Xu107a34f2017-06-29 17:04:21 -0700352 bool brotli_compressed;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700353
Tianjie Xu107a34f2017-06-29 17:04:21 -0700354 std::unique_ptr<RangeSinkWriter> writer;
355 BrotliDecoderState* brotli_decoder_state;
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700356 bool receiver_available;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700357
Tao Bao60a70af2017-03-26 14:03:52 -0700358 pthread_mutex_t mu;
359 pthread_cond_t cv;
Tao Bao0940fe12015-08-27 16:41:21 -0700360};
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700361
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -0700362static bool receive_new_data(const uint8_t* data, size_t size, void* cookie) {
Tao Bao60a70af2017-03-26 14:03:52 -0700363 NewThreadInfo* nti = static_cast<NewThreadInfo*>(cookie);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700364
Tao Bao60a70af2017-03-26 14:03:52 -0700365 while (size > 0) {
366 // Wait for nti->writer to be non-null, indicating some of this data is wanted.
367 pthread_mutex_lock(&nti->mu);
368 while (nti->writer == nullptr) {
Tianjie Xu5450c842017-10-18 13:15:21 -0700369 // End the new data receiver if we encounter an error when performing block image update.
370 if (!nti->receiver_available) {
371 pthread_mutex_unlock(&nti->mu);
372 return false;
373 }
Tao Bao60a70af2017-03-26 14:03:52 -0700374 pthread_cond_wait(&nti->cv, &nti->mu);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700375 }
Tao Bao60a70af2017-03-26 14:03:52 -0700376 pthread_mutex_unlock(&nti->mu);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700377
Tao Bao60a70af2017-03-26 14:03:52 -0700378 // At this point nti->writer is set, and we own it. The main thread is waiting for it to
379 // disappear from nti.
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700380 size_t write_now = std::min(size, nti->writer->AvailableSpace());
381 if (nti->writer->Write(data, write_now) != write_now) {
382 LOG(ERROR) << "Failed to write " << write_now << " bytes.";
Tianjie Xu107a34f2017-06-29 17:04:21 -0700383 return false;
384 }
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700385
386 data += write_now;
387 size -= write_now;
388
389 if (nti->writer->Finished()) {
390 // We have written all the bytes desired by this writer.
391
392 pthread_mutex_lock(&nti->mu);
393 nti->writer = nullptr;
394 pthread_cond_broadcast(&nti->cv);
395 pthread_mutex_unlock(&nti->mu);
396 }
397 }
398
399 return true;
400}
401
402static bool receive_brotli_new_data(const uint8_t* data, size_t size, void* cookie) {
403 NewThreadInfo* nti = static_cast<NewThreadInfo*>(cookie);
404
405 while (size > 0 || BrotliDecoderHasMoreOutput(nti->brotli_decoder_state)) {
406 // Wait for nti->writer to be non-null, indicating some of this data is wanted.
407 pthread_mutex_lock(&nti->mu);
408 while (nti->writer == nullptr) {
Tianjie Xu5450c842017-10-18 13:15:21 -0700409 // End the receiver if we encounter an error when performing block image update.
410 if (!nti->receiver_available) {
411 pthread_mutex_unlock(&nti->mu);
412 return false;
413 }
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700414 pthread_cond_wait(&nti->cv, &nti->mu);
415 }
416 pthread_mutex_unlock(&nti->mu);
417
418 // At this point nti->writer is set, and we own it. The main thread is waiting for it to
419 // disappear from nti.
420
421 size_t buffer_size = std::min<size_t>(32768, nti->writer->AvailableSpace());
422 if (buffer_size == 0) {
423 LOG(ERROR) << "No space left in output range";
424 return false;
425 }
426 uint8_t buffer[buffer_size];
427 size_t available_in = size;
428 size_t available_out = buffer_size;
429 uint8_t* next_out = buffer;
430
431 // The brotli decoder will update |data|, |available_in|, |next_out| and |available_out|.
432 BrotliDecoderResult result = BrotliDecoderDecompressStream(
433 nti->brotli_decoder_state, &available_in, &data, &available_out, &next_out, nullptr);
434
435 if (result == BROTLI_DECODER_RESULT_ERROR) {
436 LOG(ERROR) << "Decompression failed with "
437 << BrotliDecoderErrorString(BrotliDecoderGetErrorCode(nti->brotli_decoder_state));
438 return false;
439 }
440
441 LOG(DEBUG) << "bytes to write: " << buffer_size - available_out << ", bytes consumed "
442 << size - available_in << ", decoder status " << result;
443
444 size_t write_now = buffer_size - available_out;
445 if (nti->writer->Write(buffer, write_now) != write_now) {
446 LOG(ERROR) << "Failed to write " << write_now << " bytes.";
447 return false;
448 }
449
450 // Update the remaining size. The input data ptr is already updated by brotli decoder function.
451 size = available_in;
Tao Bao60a70af2017-03-26 14:03:52 -0700452
453 if (nti->writer->Finished()) {
454 // We have written all the bytes desired by this writer.
455
456 pthread_mutex_lock(&nti->mu);
457 nti->writer = nullptr;
458 pthread_cond_broadcast(&nti->cv);
459 pthread_mutex_unlock(&nti->mu);
460 }
461 }
462
463 return true;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700464}
465
466static void* unzip_new_data(void* cookie) {
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700467 NewThreadInfo* nti = static_cast<NewThreadInfo*>(cookie);
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700468 if (nti->brotli_compressed) {
469 ProcessZipEntryContents(nti->za, &nti->entry, receive_brotli_new_data, nti);
470 } else {
471 ProcessZipEntryContents(nti->za, &nti->entry, receive_new_data, nti);
472 }
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700473 pthread_mutex_lock(&nti->mu);
474 nti->receiver_available = false;
475 if (nti->writer != nullptr) {
476 pthread_cond_broadcast(&nti->cv);
477 }
478 pthread_mutex_unlock(&nti->mu);
479 return nullptr;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700480}
481
Tao Baode3bbb82018-05-30 16:14:14 -0700482static int ReadBlocks(const RangeSet& src, std::vector<uint8_t>* buffer, int fd) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700483 size_t p = 0;
Tao Bao43bfa6e2018-08-28 10:09:13 -0700484 for (const auto& [begin, end] : src) {
485 if (!check_lseek(fd, static_cast<off64_t>(begin) * BLOCKSIZE, SEEK_SET)) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700486 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000487 }
488
Tao Bao43bfa6e2018-08-28 10:09:13 -0700489 size_t size = (end - begin) * BLOCKSIZE;
Tianjie Xu22f11202018-08-27 10:50:31 -0700490 if (!android::base::ReadFully(fd, buffer->data() + p, size)) {
491 failure_type = errno == EIO ? kEioFailure : kFreadFailure;
492 PLOG(ERROR) << "Failed to read " << size << " bytes of data";
Tao Baobf5b77d2017-03-30 16:57:29 -0700493 return -1;
494 }
495
496 p += size;
497 }
498
499 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000500}
501
Tao Bao612336d2015-08-27 16:41:21 -0700502static int WriteBlocks(const RangeSet& tgt, const std::vector<uint8_t>& buffer, int fd) {
Tao Bao60a70af2017-03-26 14:03:52 -0700503 size_t written = 0;
Tao Bao43bfa6e2018-08-28 10:09:13 -0700504 for (const auto& [begin, end] : tgt) {
505 off64_t offset = static_cast<off64_t>(begin) * BLOCKSIZE;
506 size_t size = (end - begin) * BLOCKSIZE;
Tao Bao60a70af2017-03-26 14:03:52 -0700507 if (!discard_blocks(fd, offset, size)) {
508 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000509 }
510
Tao Bao60a70af2017-03-26 14:03:52 -0700511 if (!check_lseek(fd, offset, SEEK_SET)) {
512 return -1;
513 }
514
Tianjie Xu22f11202018-08-27 10:50:31 -0700515 if (!android::base::WriteFully(fd, buffer.data() + written, size)) {
516 failure_type = errno == EIO ? kEioFailure : kFwriteFailure;
517 PLOG(ERROR) << "Failed to write " << size << " bytes of data";
Tao Bao60a70af2017-03-26 14:03:52 -0700518 return -1;
519 }
520
521 written += size;
522 }
523
524 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000525}
526
Tao Baobaad2d42015-12-06 16:56:27 -0800527// Parameters for transfer list command functions
528struct CommandParameters {
529 std::vector<std::string> tokens;
530 size_t cpos;
Tao Baoc3901232018-05-21 16:05:56 -0700531 std::string cmdname;
532 std::string cmdline;
Tao Baobaad2d42015-12-06 16:56:27 -0800533 std::string freestash;
534 std::string stashbase;
535 bool canwrite;
536 int createdstash;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700537 android::base::unique_fd fd;
Tao Baobaad2d42015-12-06 16:56:27 -0800538 bool foundwrites;
539 bool isunresumable;
540 int version;
541 size_t written;
Tianjie Xudd874b12016-05-13 12:13:15 -0700542 size_t stashed;
Tao Baobaad2d42015-12-06 16:56:27 -0800543 NewThreadInfo nti;
544 pthread_t thread;
545 std::vector<uint8_t> buffer;
546 uint8_t* patch_start;
Tianjie Xu284752e2017-12-05 11:04:17 -0800547 bool target_verified; // The target blocks have expected contents already.
Tao Baobaad2d42015-12-06 16:56:27 -0800548};
549
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000550// Print the hash in hex for corrupted source blocks (excluding the stashed blocks which is
551// handled separately).
552static void PrintHashForCorruptedSourceBlocks(const CommandParameters& params,
553 const std::vector<uint8_t>& buffer) {
554 LOG(INFO) << "unexpected contents of source blocks in cmd:\n" << params.cmdline;
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000555 CHECK(params.tokens[0] == "move" || params.tokens[0] == "bsdiff" ||
556 params.tokens[0] == "imgdiff");
557
558 size_t pos = 0;
559 // Command example:
560 // move <onehash> <tgt_range> <src_blk_count> <src_range> [<loc_range> <stashed_blocks>]
561 // bsdiff <offset> <len> <src_hash> <tgt_hash> <tgt_range> <src_blk_count> <src_range>
562 // [<loc_range> <stashed_blocks>]
563 if (params.tokens[0] == "move") {
564 // src_range for move starts at the 4th position.
565 if (params.tokens.size() < 5) {
566 LOG(ERROR) << "failed to parse source range in cmd:\n" << params.cmdline;
567 return;
568 }
569 pos = 4;
570 } else {
571 // src_range for diff starts at the 7th position.
572 if (params.tokens.size() < 8) {
573 LOG(ERROR) << "failed to parse source range in cmd:\n" << params.cmdline;
574 return;
575 }
576 pos = 7;
577 }
578
579 // Source blocks in stash only, no work to do.
580 if (params.tokens[pos] == "-") {
581 return;
582 }
583
Tao Bao8f237572017-03-26 13:36:49 -0700584 RangeSet src = RangeSet::Parse(params.tokens[pos++]);
Tao Bao67983152017-11-04 00:08:08 -0700585 if (!src) {
586 LOG(ERROR) << "Failed to parse range in " << params.cmdline;
587 return;
588 }
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000589
590 RangeSet locs;
591 // If there's no stashed blocks, content in the buffer is consecutive and has the same
592 // order as the source blocks.
593 if (pos == params.tokens.size()) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700594 locs = RangeSet(std::vector<Range>{ Range{ 0, src.blocks() } });
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000595 } else {
596 // Otherwise, the next token is the offset of the source blocks in the target range.
597 // Example: for the tokens <4,63946,63947,63948,63979> <4,6,7,8,39> <stashed_blocks>;
598 // We want to print SHA-1 for the data in buffer[6], buffer[8], buffer[9] ... buffer[38];
599 // this corresponds to the 32 src blocks #63946, #63948, #63949 ... #63978.
Tao Bao8f237572017-03-26 13:36:49 -0700600 locs = RangeSet::Parse(params.tokens[pos++]);
Tao Baobf5b77d2017-03-30 16:57:29 -0700601 CHECK_EQ(src.blocks(), locs.blocks());
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000602 }
603
Tao Baobf5b77d2017-03-30 16:57:29 -0700604 LOG(INFO) << "printing hash in hex for " << src.blocks() << " source blocks";
605 for (size_t i = 0; i < src.blocks(); i++) {
Tao Bao8f237572017-03-26 13:36:49 -0700606 size_t block_num = src.GetBlockNumber(i);
607 size_t buffer_index = locs.GetBlockNumber(i);
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000608 CHECK_LE((buffer_index + 1) * BLOCKSIZE, buffer.size());
609
610 uint8_t digest[SHA_DIGEST_LENGTH];
611 SHA1(buffer.data() + buffer_index * BLOCKSIZE, BLOCKSIZE, digest);
612 std::string hexdigest = print_sha1(digest);
613 LOG(INFO) << " block number: " << block_num << ", SHA-1: " << hexdigest;
614 }
615}
616
617// If the calculated hash for the whole stash doesn't match the stash id, print the SHA-1
618// in hex for each block.
619static void PrintHashForCorruptedStashedBlocks(const std::string& id,
620 const std::vector<uint8_t>& buffer,
621 const RangeSet& src) {
622 LOG(INFO) << "printing hash in hex for stash_id: " << id;
Tao Baobf5b77d2017-03-30 16:57:29 -0700623 CHECK_EQ(src.blocks() * BLOCKSIZE, buffer.size());
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000624
Tao Baobf5b77d2017-03-30 16:57:29 -0700625 for (size_t i = 0; i < src.blocks(); i++) {
Tao Bao8f237572017-03-26 13:36:49 -0700626 size_t block_num = src.GetBlockNumber(i);
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000627
628 uint8_t digest[SHA_DIGEST_LENGTH];
629 SHA1(buffer.data() + i * BLOCKSIZE, BLOCKSIZE, digest);
630 std::string hexdigest = print_sha1(digest);
631 LOG(INFO) << " block number: " << block_num << ", SHA-1: " << hexdigest;
632 }
633}
634
635// If the stash file doesn't exist, read the source blocks this stash contains and print the
636// SHA-1 for these blocks.
637static void PrintHashForMissingStashedBlocks(const std::string& id, int fd) {
638 if (stash_map.find(id) == stash_map.end()) {
639 LOG(ERROR) << "No stash saved for id: " << id;
640 return;
641 }
642
643 LOG(INFO) << "print hash in hex for source blocks in missing stash: " << id;
644 const RangeSet& src = stash_map[id];
Tao Baobf5b77d2017-03-30 16:57:29 -0700645 std::vector<uint8_t> buffer(src.blocks() * BLOCKSIZE);
Tao Baode3bbb82018-05-30 16:14:14 -0700646 if (ReadBlocks(src, &buffer, fd) == -1) {
647 LOG(ERROR) << "failed to read source blocks for stash: " << id;
648 return;
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000649 }
650 PrintHashForCorruptedStashedBlocks(id, buffer, src);
651}
652
Tao Bao612336d2015-08-27 16:41:21 -0700653static int VerifyBlocks(const std::string& expected, const std::vector<uint8_t>& buffer,
Tao Baode3bbb82018-05-30 16:14:14 -0700654 const size_t blocks, bool printerror) {
655 uint8_t digest[SHA_DIGEST_LENGTH];
656 const uint8_t* data = buffer.data();
Sami Tolvanen90221202014-12-09 16:39:47 +0000657
Tao Baode3bbb82018-05-30 16:14:14 -0700658 SHA1(data, blocks * BLOCKSIZE, digest);
Sami Tolvanen90221202014-12-09 16:39:47 +0000659
Tao Baode3bbb82018-05-30 16:14:14 -0700660 std::string hexdigest = print_sha1(digest);
Sami Tolvanen90221202014-12-09 16:39:47 +0000661
Tao Baode3bbb82018-05-30 16:14:14 -0700662 if (hexdigest != expected) {
663 if (printerror) {
664 LOG(ERROR) << "failed to verify blocks (expected " << expected << ", read " << hexdigest
665 << ")";
Sami Tolvanen90221202014-12-09 16:39:47 +0000666 }
Tao Baode3bbb82018-05-30 16:14:14 -0700667 return -1;
668 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000669
Tao Baode3bbb82018-05-30 16:14:14 -0700670 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000671}
672
Tao Bao0940fe12015-08-27 16:41:21 -0700673static std::string GetStashFileName(const std::string& base, const std::string& id,
Tao Bao641fa972018-04-25 18:59:40 -0700674 const std::string& postfix) {
675 if (base.empty()) {
676 return "";
677 }
Tao Bao864c6682018-05-07 11:38:25 -0700678 std::string filename = Paths::Get().stash_directory_base() + "/" + base;
679 if (id.empty() && postfix.empty()) {
680 return filename;
681 }
682 return filename + "/" + id + postfix;
Sami Tolvanen90221202014-12-09 16:39:47 +0000683}
684
Tao Baoec8272f2017-03-15 17:39:01 -0700685// Does a best effort enumeration of stash files. Ignores possible non-file items in the stash
686// directory and continues despite of errors. Calls the 'callback' function for each file.
687static void EnumerateStash(const std::string& dirname,
688 const std::function<void(const std::string&)>& callback) {
689 if (dirname.empty()) return;
Sami Tolvanen90221202014-12-09 16:39:47 +0000690
Tao Baoec8272f2017-03-15 17:39:01 -0700691 std::unique_ptr<DIR, decltype(&closedir)> directory(opendir(dirname.c_str()), closedir);
Sami Tolvanen90221202014-12-09 16:39:47 +0000692
Tao Baoec8272f2017-03-15 17:39:01 -0700693 if (directory == nullptr) {
694 if (errno != ENOENT) {
695 PLOG(ERROR) << "opendir \"" << dirname << "\" failed";
Sami Tolvanen90221202014-12-09 16:39:47 +0000696 }
Tao Bao51412212016-12-28 14:44:05 -0800697 return;
698 }
Tao Baoe6aa3322015-08-05 15:20:27 -0700699
Tao Baoec8272f2017-03-15 17:39:01 -0700700 dirent* item;
701 while ((item = readdir(directory.get())) != nullptr) {
702 if (item->d_type != DT_REG) continue;
703 callback(dirname + "/" + item->d_name);
Tao Bao51412212016-12-28 14:44:05 -0800704 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000705}
706
707// Deletes the stash directory and all files in it. Assumes that it only
708// contains files. There is nothing we can do about unlikely, but possible
709// errors, so they are merely logged.
Tao Baoec8272f2017-03-15 17:39:01 -0700710static void DeleteFile(const std::string& fn) {
711 if (fn.empty()) return;
Sami Tolvanen90221202014-12-09 16:39:47 +0000712
Tao Baoec8272f2017-03-15 17:39:01 -0700713 LOG(INFO) << "deleting " << fn;
Sami Tolvanen90221202014-12-09 16:39:47 +0000714
Tao Baoec8272f2017-03-15 17:39:01 -0700715 if (unlink(fn.c_str()) == -1 && errno != ENOENT) {
716 PLOG(ERROR) << "unlink \"" << fn << "\" failed";
717 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000718}
719
Tao Baoe6aa3322015-08-05 15:20:27 -0700720static void DeleteStash(const std::string& base) {
Tao Baoec8272f2017-03-15 17:39:01 -0700721 if (base.empty()) return;
722
723 LOG(INFO) << "deleting stash " << base;
724
725 std::string dirname = GetStashFileName(base, "", "");
726 EnumerateStash(dirname, DeleteFile);
727
728 if (rmdir(dirname.c_str()) == -1) {
729 if (errno != ENOENT && errno != ENOTDIR) {
730 PLOG(ERROR) << "rmdir \"" << dirname << "\" failed";
Sami Tolvanen90221202014-12-09 16:39:47 +0000731 }
Tao Baoec8272f2017-03-15 17:39:01 -0700732 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000733}
734
Tao Baode3bbb82018-05-30 16:14:14 -0700735static int LoadStash(const CommandParameters& params, const std::string& id, bool verify,
736 std::vector<uint8_t>* buffer, bool printnoent) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700737 // In verify mode, if source range_set was saved for the given hash, check contents in the source
738 // blocks first. If the check fails, search for the stashed files on /cache as usual.
739 if (!params.canwrite) {
740 if (stash_map.find(id) != stash_map.end()) {
741 const RangeSet& src = stash_map[id];
742 allocate(src.blocks() * BLOCKSIZE, buffer);
Tianjie Xu7eca97e2016-03-22 18:08:12 -0700743
Tao Baobf5b77d2017-03-30 16:57:29 -0700744 if (ReadBlocks(src, buffer, params.fd) == -1) {
745 LOG(ERROR) << "failed to read source blocks in stash map.";
Tao Bao0940fe12015-08-27 16:41:21 -0700746 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -0700747 }
Tao Baode3bbb82018-05-30 16:14:14 -0700748 if (VerifyBlocks(id, *buffer, src.blocks(), true) != 0) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700749 LOG(ERROR) << "failed to verify loaded source blocks in stash map.";
Tianjie Xu3c5958f2018-03-09 14:10:25 -0800750 if (!is_retry) {
751 PrintHashForCorruptedStashedBlocks(id, *buffer, src);
752 }
Tao Bao0940fe12015-08-27 16:41:21 -0700753 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -0700754 }
755 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000756 }
Tao Baobf5b77d2017-03-30 16:57:29 -0700757 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000758
Tao Baobf5b77d2017-03-30 16:57:29 -0700759 std::string fn = GetStashFileName(params.stashbase, id, "");
760
761 struct stat sb;
762 if (stat(fn.c_str(), &sb) == -1) {
763 if (errno != ENOENT || printnoent) {
764 PLOG(ERROR) << "stat \"" << fn << "\" failed";
765 PrintHashForMissingStashedBlocks(id, params.fd);
Sami Tolvanen90221202014-12-09 16:39:47 +0000766 }
Tao Baobf5b77d2017-03-30 16:57:29 -0700767 return -1;
768 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000769
Tao Baobf5b77d2017-03-30 16:57:29 -0700770 LOG(INFO) << " loading " << fn;
Sami Tolvanen90221202014-12-09 16:39:47 +0000771
Tao Baobf5b77d2017-03-30 16:57:29 -0700772 if ((sb.st_size % BLOCKSIZE) != 0) {
773 LOG(ERROR) << fn << " size " << sb.st_size << " not multiple of block size " << BLOCKSIZE;
774 return -1;
775 }
776
Tianjie Xu22f11202018-08-27 10:50:31 -0700777 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(fn.c_str(), O_RDONLY)));
Tao Baobf5b77d2017-03-30 16:57:29 -0700778 if (fd == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -0700779 failure_type = errno == EIO ? kEioFailure : kFileOpenFailure;
Tao Baobf5b77d2017-03-30 16:57:29 -0700780 PLOG(ERROR) << "open \"" << fn << "\" failed";
781 return -1;
782 }
783
784 allocate(sb.st_size, buffer);
785
Tianjie Xu22f11202018-08-27 10:50:31 -0700786 if (!android::base::ReadFully(fd, buffer->data(), sb.st_size)) {
787 failure_type = errno == EIO ? kEioFailure : kFreadFailure;
788 PLOG(ERROR) << "Failed to read " << sb.st_size << " bytes of data";
Tao Baobf5b77d2017-03-30 16:57:29 -0700789 return -1;
790 }
791
Tao Bao64957ce2018-05-30 16:21:39 -0700792 size_t blocks = sb.st_size / BLOCKSIZE;
Tao Baode3bbb82018-05-30 16:14:14 -0700793 if (verify && VerifyBlocks(id, *buffer, blocks, true) != 0) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700794 LOG(ERROR) << "unexpected contents in " << fn;
795 if (stash_map.find(id) == stash_map.end()) {
796 LOG(ERROR) << "failed to find source blocks number for stash " << id
797 << " when executing command: " << params.cmdname;
798 } else {
799 const RangeSet& src = stash_map[id];
Tao Baode3bbb82018-05-30 16:14:14 -0700800 PrintHashForCorruptedStashedBlocks(id, *buffer, src);
Sami Tolvanen90221202014-12-09 16:39:47 +0000801 }
Tao Baobf5b77d2017-03-30 16:57:29 -0700802 DeleteFile(fn);
803 return -1;
804 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000805
Tao Baobf5b77d2017-03-30 16:57:29 -0700806 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000807}
808
Tao Bao612336d2015-08-27 16:41:21 -0700809static int WriteStash(const std::string& base, const std::string& id, int blocks,
Tao Baode3bbb82018-05-30 16:14:14 -0700810 const std::vector<uint8_t>& buffer, bool checkspace, bool* exists) {
811 if (base.empty()) {
812 return -1;
813 }
814
Tao Bao5ee25662018-07-11 15:55:32 -0700815 if (checkspace && !CheckAndFreeSpaceOnCache(blocks * BLOCKSIZE)) {
Tao Baode3bbb82018-05-30 16:14:14 -0700816 LOG(ERROR) << "not enough space to write stash";
817 return -1;
818 }
819
820 std::string fn = GetStashFileName(base, id, ".partial");
821 std::string cn = GetStashFileName(base, id, "");
822
823 if (exists) {
824 struct stat sb;
825 int res = stat(cn.c_str(), &sb);
826
827 if (res == 0) {
828 // The file already exists and since the name is the hash of the contents,
829 // it's safe to assume the contents are identical (accidental hash collisions
830 // are unlikely)
831 LOG(INFO) << " skipping " << blocks << " existing blocks in " << cn;
832 *exists = true;
833 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000834 }
835
Tao Baode3bbb82018-05-30 16:14:14 -0700836 *exists = false;
837 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000838
Tao Baode3bbb82018-05-30 16:14:14 -0700839 LOG(INFO) << " writing " << blocks << " blocks to " << cn;
Sami Tolvanen90221202014-12-09 16:39:47 +0000840
Tao Baode3bbb82018-05-30 16:14:14 -0700841 android::base::unique_fd fd(
Tianjie Xu22f11202018-08-27 10:50:31 -0700842 TEMP_FAILURE_RETRY(open(fn.c_str(), O_WRONLY | O_CREAT | O_TRUNC, STASH_FILE_MODE)));
Tao Baode3bbb82018-05-30 16:14:14 -0700843 if (fd == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -0700844 failure_type = errno == EIO ? kEioFailure : kFileOpenFailure;
Tao Baode3bbb82018-05-30 16:14:14 -0700845 PLOG(ERROR) << "failed to create \"" << fn << "\"";
846 return -1;
847 }
Sami Tolvanen43b748f2015-04-17 12:50:31 +0100848
Tao Baode3bbb82018-05-30 16:14:14 -0700849 if (fchown(fd, AID_SYSTEM, AID_SYSTEM) != 0) { // system user
850 PLOG(ERROR) << "failed to chown \"" << fn << "\"";
851 return -1;
852 }
Sami Tolvanen43b748f2015-04-17 12:50:31 +0100853
Tianjie Xu22f11202018-08-27 10:50:31 -0700854 if (!android::base::WriteFully(fd, buffer.data(), blocks * BLOCKSIZE)) {
855 failure_type = errno == EIO ? kEioFailure : kFwriteFailure;
856 PLOG(ERROR) << "Failed to write " << blocks * BLOCKSIZE << " bytes of data";
Tao Baode3bbb82018-05-30 16:14:14 -0700857 return -1;
858 }
Sami Tolvanen43b748f2015-04-17 12:50:31 +0100859
Tianjie Xu22f11202018-08-27 10:50:31 -0700860 if (fsync(fd) == -1) {
861 failure_type = errno == EIO ? kEioFailure : kFsyncFailure;
Tao Baode3bbb82018-05-30 16:14:14 -0700862 PLOG(ERROR) << "fsync \"" << fn << "\" failed";
863 return -1;
864 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000865
Tao Baode3bbb82018-05-30 16:14:14 -0700866 if (rename(fn.c_str(), cn.c_str()) == -1) {
867 PLOG(ERROR) << "rename(\"" << fn << "\", \"" << cn << "\") failed";
868 return -1;
869 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000870
Tao Baode3bbb82018-05-30 16:14:14 -0700871 std::string dname = GetStashFileName(base, "", "");
872 if (!FsyncDir(dname)) {
Tao Baode3bbb82018-05-30 16:14:14 -0700873 return -1;
874 }
Tianjie Xua946b9e2017-03-21 16:24:57 -0700875
Tao Baode3bbb82018-05-30 16:14:14 -0700876 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000877}
878
879// Creates a directory for storing stash files and checks if the /cache partition
880// hash enough space for the expected amount of blocks we need to store. Returns
881// >0 if we created the directory, zero if it existed already, and <0 of failure.
Tao Bao864c6682018-05-07 11:38:25 -0700882static int CreateStash(State* state, size_t maxblocks, const std::string& base) {
Tao Bao51412212016-12-28 14:44:05 -0800883 std::string dirname = GetStashFileName(base, "", "");
884 struct stat sb;
885 int res = stat(dirname.c_str(), &sb);
Tao Bao51412212016-12-28 14:44:05 -0800886 if (res == -1 && errno != ENOENT) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800887 ErrorAbort(state, kStashCreationFailure, "stat \"%s\" failed: %s", dirname.c_str(),
Tao Bao51412212016-12-28 14:44:05 -0800888 strerror(errno));
889 return -1;
Tao Bao864c6682018-05-07 11:38:25 -0700890 }
891
892 size_t max_stash_size = maxblocks * BLOCKSIZE;
893 if (res == -1) {
Tao Bao51412212016-12-28 14:44:05 -0800894 LOG(INFO) << "creating stash " << dirname;
Yifan Hong63f52602019-01-11 13:52:33 -0800895 res = mkdir_recursively(dirname, STASH_DIRECTORY_MODE, false, nullptr);
Tao Bao51412212016-12-28 14:44:05 -0800896
897 if (res != 0) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800898 ErrorAbort(state, kStashCreationFailure, "mkdir \"%s\" failed: %s", dirname.c_str(),
Tao Bao51412212016-12-28 14:44:05 -0800899 strerror(errno));
900 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000901 }
902
Tianjie Xua946b9e2017-03-21 16:24:57 -0700903 if (chown(dirname.c_str(), AID_SYSTEM, AID_SYSTEM) != 0) { // system user
Tianjie Xu5ad80282018-01-28 15:37:48 -0800904 ErrorAbort(state, kStashCreationFailure, "chown \"%s\" failed: %s", dirname.c_str(),
Tianjie Xua946b9e2017-03-21 16:24:57 -0700905 strerror(errno));
906 return -1;
907 }
908
Tao Bao5ee25662018-07-11 15:55:32 -0700909 if (!CheckAndFreeSpaceOnCache(max_stash_size)) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800910 ErrorAbort(state, kStashCreationFailure, "not enough space for stash (%zu needed)",
Tao Bao51412212016-12-28 14:44:05 -0800911 max_stash_size);
912 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000913 }
914
Tao Bao51412212016-12-28 14:44:05 -0800915 return 1; // Created directory
916 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000917
Tao Bao51412212016-12-28 14:44:05 -0800918 LOG(INFO) << "using existing stash " << dirname;
Sami Tolvanen90221202014-12-09 16:39:47 +0000919
Tao Baoec8272f2017-03-15 17:39:01 -0700920 // If the directory already exists, calculate the space already allocated to stash files and check
921 // if there's enough for all required blocks. Delete any partially completed stash files first.
922 EnumerateStash(dirname, [](const std::string& fn) {
923 if (android::base::EndsWith(fn, ".partial")) {
924 DeleteFile(fn);
925 }
926 });
Sami Tolvanen90221202014-12-09 16:39:47 +0000927
Tao Bao51412212016-12-28 14:44:05 -0800928 size_t existing = 0;
Tao Baoec8272f2017-03-15 17:39:01 -0700929 EnumerateStash(dirname, [&existing](const std::string& fn) {
930 if (fn.empty()) return;
931 struct stat sb;
932 if (stat(fn.c_str(), &sb) == -1) {
933 PLOG(ERROR) << "stat \"" << fn << "\" failed";
934 return;
935 }
936 existing += static_cast<size_t>(sb.st_size);
937 });
Sami Tolvanen90221202014-12-09 16:39:47 +0000938
Tao Bao51412212016-12-28 14:44:05 -0800939 if (max_stash_size > existing) {
940 size_t needed = max_stash_size - existing;
Tao Bao5ee25662018-07-11 15:55:32 -0700941 if (!CheckAndFreeSpaceOnCache(needed)) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800942 ErrorAbort(state, kStashCreationFailure, "not enough space for stash (%zu more needed)",
Tao Bao51412212016-12-28 14:44:05 -0800943 needed);
944 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000945 }
Tao Bao51412212016-12-28 14:44:05 -0800946 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000947
Tao Bao51412212016-12-28 14:44:05 -0800948 return 0; // Using existing directory
Sami Tolvanen90221202014-12-09 16:39:47 +0000949}
950
Tao Baobaad2d42015-12-06 16:56:27 -0800951static int FreeStash(const std::string& base, const std::string& id) {
Tao Baoec8272f2017-03-15 17:39:01 -0700952 if (base.empty() || id.empty()) {
953 return -1;
954 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000955
Tao Baoec8272f2017-03-15 17:39:01 -0700956 DeleteFile(GetStashFileName(base, id, ""));
Sami Tolvanen90221202014-12-09 16:39:47 +0000957
Tao Baoec8272f2017-03-15 17:39:01 -0700958 return 0;
Doug Zongker52ae67d2014-09-08 12:22:09 -0700959}
960
Tao Baobf5b77d2017-03-30 16:57:29 -0700961// Source contains packed data, which we want to move to the locations given in locs in the dest
962// buffer. source and dest may be the same buffer.
Tao Bao612336d2015-08-27 16:41:21 -0700963static void MoveRange(std::vector<uint8_t>& dest, const RangeSet& locs,
Tao Baobf5b77d2017-03-30 16:57:29 -0700964 const std::vector<uint8_t>& source) {
965 const uint8_t* from = source.data();
966 uint8_t* to = dest.data();
967 size_t start = locs.blocks();
968 // Must do the movement backward.
969 for (auto it = locs.crbegin(); it != locs.crend(); it++) {
970 size_t blocks = it->second - it->first;
971 start -= blocks;
972 memmove(to + (it->first * BLOCKSIZE), from + (start * BLOCKSIZE), blocks * BLOCKSIZE);
973 }
Doug Zongker52ae67d2014-09-08 12:22:09 -0700974}
975
Tao Baod2aecd42017-03-23 14:43:44 -0700976/**
977 * We expect to parse the remainder of the parameter tokens as one of:
978 *
979 * <src_block_count> <src_range>
980 * (loads data from source image only)
981 *
982 * <src_block_count> - <[stash_id:stash_range] ...>
983 * (loads data from stashes only)
984 *
985 * <src_block_count> <src_range> <src_loc> <[stash_id:stash_range] ...>
986 * (loads data from both source image and stashes)
987 *
988 * On return, params.buffer is filled with the loaded source data (rearranged and combined with
989 * stashed data as necessary). buffer may be reallocated if needed to accommodate the source data.
990 * tgt is the target RangeSet for detecting overlaps. Any stashes required are loaded using
991 * LoadStash.
992 */
993static int LoadSourceBlocks(CommandParameters& params, const RangeSet& tgt, size_t* src_blocks,
994 bool* overlap) {
995 CHECK(src_blocks != nullptr);
996 CHECK(overlap != nullptr);
Doug Zongker52ae67d2014-09-08 12:22:09 -0700997
Tao Baod2aecd42017-03-23 14:43:44 -0700998 // <src_block_count>
999 const std::string& token = params.tokens[params.cpos++];
1000 if (!android::base::ParseUint(token, src_blocks)) {
1001 LOG(ERROR) << "invalid src_block_count \"" << token << "\"";
1002 return -1;
1003 }
Tao Baobaad2d42015-12-06 16:56:27 -08001004
Tao Baode3bbb82018-05-30 16:14:14 -07001005 allocate(*src_blocks * BLOCKSIZE, &params.buffer);
Tao Baod2aecd42017-03-23 14:43:44 -07001006
1007 // "-" or <src_range> [<src_loc>]
1008 if (params.tokens[params.cpos] == "-") {
1009 // no source ranges, only stashes
1010 params.cpos++;
1011 } else {
Tao Bao8f237572017-03-26 13:36:49 -07001012 RangeSet src = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001013 CHECK(static_cast<bool>(src));
Tao Bao8f237572017-03-26 13:36:49 -07001014 *overlap = src.Overlaps(tgt);
Tao Baod2aecd42017-03-23 14:43:44 -07001015
Tao Baode3bbb82018-05-30 16:14:14 -07001016 if (ReadBlocks(src, &params.buffer, params.fd) == -1) {
Tao Baod2aecd42017-03-23 14:43:44 -07001017 return -1;
Tao Baobaad2d42015-12-06 16:56:27 -08001018 }
1019
Tao Baod2aecd42017-03-23 14:43:44 -07001020 if (params.cpos >= params.tokens.size()) {
1021 // no stashes, only source range
1022 return 0;
Tao Baobaad2d42015-12-06 16:56:27 -08001023 }
Doug Zongker52ae67d2014-09-08 12:22:09 -07001024
Tao Bao8f237572017-03-26 13:36:49 -07001025 RangeSet locs = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001026 CHECK(static_cast<bool>(locs));
Tao Baod2aecd42017-03-23 14:43:44 -07001027 MoveRange(params.buffer, locs, params.buffer);
1028 }
Doug Zongker52ae67d2014-09-08 12:22:09 -07001029
Tao Baod2aecd42017-03-23 14:43:44 -07001030 // <[stash_id:stash_range]>
1031 while (params.cpos < params.tokens.size()) {
1032 // Each word is a an index into the stash table, a colon, and then a RangeSet describing where
1033 // in the source block that stashed data should go.
1034 std::vector<std::string> tokens = android::base::Split(params.tokens[params.cpos++], ":");
1035 if (tokens.size() != 2) {
1036 LOG(ERROR) << "invalid parameter";
1037 return -1;
Doug Zongker52ae67d2014-09-08 12:22:09 -07001038 }
1039
Tao Baod2aecd42017-03-23 14:43:44 -07001040 std::vector<uint8_t> stash;
Tao Baode3bbb82018-05-30 16:14:14 -07001041 if (LoadStash(params, tokens[0], false, &stash, true) == -1) {
Tao Baod2aecd42017-03-23 14:43:44 -07001042 // These source blocks will fail verification if used later, but we
1043 // will let the caller decide if this is a fatal failure
1044 LOG(ERROR) << "failed to load stash " << tokens[0];
1045 continue;
Sami Tolvanen90221202014-12-09 16:39:47 +00001046 }
1047
Tao Bao8f237572017-03-26 13:36:49 -07001048 RangeSet locs = RangeSet::Parse(tokens[1]);
Tao Bao67983152017-11-04 00:08:08 -07001049 CHECK(static_cast<bool>(locs));
Tao Baod2aecd42017-03-23 14:43:44 -07001050 MoveRange(params.buffer, locs, stash);
1051 }
1052
1053 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001054}
1055
Tao Bao33567772017-03-13 14:57:34 -07001056/**
1057 * Do a source/target load for move/bsdiff/imgdiff in version 3.
1058 *
1059 * We expect to parse the remainder of the parameter tokens as one of:
1060 *
1061 * <tgt_range> <src_block_count> <src_range>
1062 * (loads data from source image only)
1063 *
1064 * <tgt_range> <src_block_count> - <[stash_id:stash_range] ...>
1065 * (loads data from stashes only)
1066 *
1067 * <tgt_range> <src_block_count> <src_range> <src_loc> <[stash_id:stash_range] ...>
1068 * (loads data from both source image and stashes)
1069 *
Tao Baod2aecd42017-03-23 14:43:44 -07001070 * 'onehash' tells whether to expect separate source and targe block hashes, or if they are both the
1071 * same and only one hash should be expected. params.isunresumable will be set to true if block
Tao Bao33567772017-03-13 14:57:34 -07001072 * verification fails in a way that the update cannot be resumed anymore.
1073 *
1074 * If the function is unable to load the necessary blocks or their contents don't match the hashes,
1075 * the return value is -1 and the command should be aborted.
1076 *
1077 * If the return value is 1, the command has already been completed according to the contents of the
1078 * target blocks, and should not be performed again.
1079 *
1080 * If the return value is 0, source blocks have expected content and the command can be performed.
1081 */
Tao Baode3bbb82018-05-30 16:14:14 -07001082static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet* tgt, size_t* src_blocks,
Tao Bao4a135082018-06-07 22:27:44 -07001083 bool onehash) {
Tao Baod2aecd42017-03-23 14:43:44 -07001084 CHECK(src_blocks != nullptr);
Sami Tolvanen90221202014-12-09 16:39:47 +00001085
Tao Baod2aecd42017-03-23 14:43:44 -07001086 if (params.cpos >= params.tokens.size()) {
1087 LOG(ERROR) << "missing source hash";
Tao Bao0940fe12015-08-27 16:41:21 -07001088 return -1;
Tao Baod2aecd42017-03-23 14:43:44 -07001089 }
1090
1091 std::string srchash = params.tokens[params.cpos++];
1092 std::string tgthash;
1093
1094 if (onehash) {
1095 tgthash = srchash;
1096 } else {
1097 if (params.cpos >= params.tokens.size()) {
1098 LOG(ERROR) << "missing target hash";
1099 return -1;
1100 }
1101 tgthash = params.tokens[params.cpos++];
1102 }
1103
1104 // At least it needs to provide three parameters: <tgt_range>, <src_block_count> and
1105 // "-"/<src_range>.
1106 if (params.cpos + 2 >= params.tokens.size()) {
1107 LOG(ERROR) << "invalid parameters";
1108 return -1;
1109 }
1110
1111 // <tgt_range>
Tao Baode3bbb82018-05-30 16:14:14 -07001112 *tgt = RangeSet::Parse(params.tokens[params.cpos++]);
1113 CHECK(static_cast<bool>(*tgt));
Tao Baod2aecd42017-03-23 14:43:44 -07001114
Tao Baode3bbb82018-05-30 16:14:14 -07001115 std::vector<uint8_t> tgtbuffer(tgt->blocks() * BLOCKSIZE);
1116 if (ReadBlocks(*tgt, &tgtbuffer, params.fd) == -1) {
Tao Baod2aecd42017-03-23 14:43:44 -07001117 return -1;
1118 }
1119
1120 // Return now if target blocks already have expected content.
Tao Baode3bbb82018-05-30 16:14:14 -07001121 if (VerifyBlocks(tgthash, tgtbuffer, tgt->blocks(), false) == 0) {
Tao Baod2aecd42017-03-23 14:43:44 -07001122 return 1;
1123 }
1124
1125 // Load source blocks.
Tao Bao4a135082018-06-07 22:27:44 -07001126 bool overlap = false;
1127 if (LoadSourceBlocks(params, *tgt, src_blocks, &overlap) == -1) {
Tao Baod2aecd42017-03-23 14:43:44 -07001128 return -1;
1129 }
1130
1131 if (VerifyBlocks(srchash, params.buffer, *src_blocks, true) == 0) {
Tao Bao4a135082018-06-07 22:27:44 -07001132 // If source and target blocks overlap, stash the source blocks so we can resume from possible
1133 // write errors. In verify mode, we can skip stashing because the source blocks won't be
1134 // overwritten.
1135 if (overlap && params.canwrite) {
Tao Baod2aecd42017-03-23 14:43:44 -07001136 LOG(INFO) << "stashing " << *src_blocks << " overlapping blocks to " << srchash;
1137
1138 bool stash_exists = false;
1139 if (WriteStash(params.stashbase, srchash, *src_blocks, params.buffer, true,
1140 &stash_exists) != 0) {
1141 LOG(ERROR) << "failed to stash overlapping source blocks";
1142 return -1;
1143 }
1144
1145 params.stashed += *src_blocks;
1146 // Can be deleted when the write has completed.
1147 if (!stash_exists) {
1148 params.freestash = srchash;
1149 }
1150 }
1151
1152 // Source blocks have expected content, command can proceed.
1153 return 0;
1154 }
1155
Tao Bao4a135082018-06-07 22:27:44 -07001156 if (overlap && LoadStash(params, srchash, true, &params.buffer, true) == 0) {
Tao Baod2aecd42017-03-23 14:43:44 -07001157 // Overlapping source blocks were previously stashed, command can proceed. We are recovering
1158 // from an interrupted command, so we don't know if the stash can safely be deleted after this
1159 // command.
1160 return 0;
1161 }
1162
1163 // Valid source data not available, update cannot be resumed.
1164 LOG(ERROR) << "partition has unexpected contents";
1165 PrintHashForCorruptedSourceBlocks(params, params.buffer);
1166
1167 params.isunresumable = true;
1168
1169 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +00001170}
1171
Tao Bao0940fe12015-08-27 16:41:21 -07001172static int PerformCommandMove(CommandParameters& params) {
Tao Bao33567772017-03-13 14:57:34 -07001173 size_t blocks = 0;
Tao Bao33567772017-03-13 14:57:34 -07001174 RangeSet tgt;
Tao Bao4a135082018-06-07 22:27:44 -07001175 int status = LoadSrcTgtVersion3(params, &tgt, &blocks, true);
Sami Tolvanen90221202014-12-09 16:39:47 +00001176
Tao Bao33567772017-03-13 14:57:34 -07001177 if (status == -1) {
1178 LOG(ERROR) << "failed to read blocks for move";
1179 return -1;
1180 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001181
Tao Bao33567772017-03-13 14:57:34 -07001182 if (status == 0) {
1183 params.foundwrites = true;
Tianjie Xu284752e2017-12-05 11:04:17 -08001184 } else {
1185 params.target_verified = true;
1186 if (params.foundwrites) {
1187 LOG(WARNING) << "warning: commands executed out of order [" << params.cmdname << "]";
1188 }
Tao Bao33567772017-03-13 14:57:34 -07001189 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001190
Tao Bao33567772017-03-13 14:57:34 -07001191 if (params.canwrite) {
Sami Tolvanen90221202014-12-09 16:39:47 +00001192 if (status == 0) {
Tao Bao33567772017-03-13 14:57:34 -07001193 LOG(INFO) << " moving " << blocks << " blocks";
1194
1195 if (WriteBlocks(tgt, params.buffer, params.fd) == -1) {
1196 return -1;
1197 }
1198 } else {
1199 LOG(INFO) << "skipping " << blocks << " already moved blocks";
Sami Tolvanen90221202014-12-09 16:39:47 +00001200 }
Tao Bao33567772017-03-13 14:57:34 -07001201 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001202
Tao Bao33567772017-03-13 14:57:34 -07001203 if (!params.freestash.empty()) {
1204 FreeStash(params.stashbase, params.freestash);
1205 params.freestash.clear();
1206 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001207
Tao Baobf5b77d2017-03-30 16:57:29 -07001208 params.written += tgt.blocks();
Sami Tolvanen90221202014-12-09 16:39:47 +00001209
Tao Bao33567772017-03-13 14:57:34 -07001210 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001211}
1212
Tao Bao0940fe12015-08-27 16:41:21 -07001213static int PerformCommandStash(CommandParameters& params) {
Tao Baobcf46492017-03-23 15:28:20 -07001214 // <stash_id> <src_range>
1215 if (params.cpos + 1 >= params.tokens.size()) {
1216 LOG(ERROR) << "missing id and/or src range fields in stash command";
1217 return -1;
1218 }
1219
1220 const std::string& id = params.tokens[params.cpos++];
Tao Baode3bbb82018-05-30 16:14:14 -07001221 if (LoadStash(params, id, true, &params.buffer, false) == 0) {
Tao Baobcf46492017-03-23 15:28:20 -07001222 // Stash file already exists and has expected contents. Do not read from source again, as the
1223 // source may have been already overwritten during a previous attempt.
1224 return 0;
1225 }
1226
Tao Bao8f237572017-03-26 13:36:49 -07001227 RangeSet src = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001228 CHECK(static_cast<bool>(src));
Tao Baobcf46492017-03-23 15:28:20 -07001229
Tao Bao64957ce2018-05-30 16:21:39 -07001230 size_t blocks = src.blocks();
Tao Baode3bbb82018-05-30 16:14:14 -07001231 allocate(blocks * BLOCKSIZE, &params.buffer);
1232 if (ReadBlocks(src, &params.buffer, params.fd) == -1) {
Tao Baobcf46492017-03-23 15:28:20 -07001233 return -1;
1234 }
Tao Baobcf46492017-03-23 15:28:20 -07001235 stash_map[id] = src;
1236
1237 if (VerifyBlocks(id, params.buffer, blocks, true) != 0) {
1238 // Source blocks have unexpected contents. If we actually need this data later, this is an
1239 // unrecoverable error. However, the command that uses the data may have already completed
1240 // previously, so the possible failure will occur during source block verification.
1241 LOG(ERROR) << "failed to load source blocks for stash " << id;
1242 return 0;
1243 }
1244
1245 // In verify mode, we don't need to stash any blocks.
1246 if (!params.canwrite) {
1247 return 0;
1248 }
1249
1250 LOG(INFO) << "stashing " << blocks << " blocks to " << id;
Tianjie Xu284752e2017-12-05 11:04:17 -08001251 int result = WriteStash(params.stashbase, id, blocks, params.buffer, false, nullptr);
1252 if (result == 0) {
Tianjie Xu284752e2017-12-05 11:04:17 -08001253 params.stashed += blocks;
1254 }
1255 return result;
Sami Tolvanen90221202014-12-09 16:39:47 +00001256}
1257
Tao Bao0940fe12015-08-27 16:41:21 -07001258static int PerformCommandFree(CommandParameters& params) {
Tao Baobcf46492017-03-23 15:28:20 -07001259 // <stash_id>
1260 if (params.cpos >= params.tokens.size()) {
1261 LOG(ERROR) << "missing stash id in free command";
1262 return -1;
1263 }
Tao Baobaad2d42015-12-06 16:56:27 -08001264
Tao Baobcf46492017-03-23 15:28:20 -07001265 const std::string& id = params.tokens[params.cpos++];
1266 stash_map.erase(id);
Tianjie Xu7eca97e2016-03-22 18:08:12 -07001267
Tao Baobcf46492017-03-23 15:28:20 -07001268 if (params.createdstash || params.canwrite) {
1269 return FreeStash(params.stashbase, id);
1270 }
Tianjie Xu7eca97e2016-03-22 18:08:12 -07001271
Tao Baobcf46492017-03-23 15:28:20 -07001272 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001273}
1274
Tao Bao0940fe12015-08-27 16:41:21 -07001275static int PerformCommandZero(CommandParameters& params) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001276 if (params.cpos >= params.tokens.size()) {
1277 LOG(ERROR) << "missing target blocks for zero";
1278 return -1;
1279 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001280
Tao Baobf5b77d2017-03-30 16:57:29 -07001281 RangeSet tgt = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001282 CHECK(static_cast<bool>(tgt));
Tao Baobf5b77d2017-03-30 16:57:29 -07001283
1284 LOG(INFO) << " zeroing " << tgt.blocks() << " blocks";
1285
Tao Baode3bbb82018-05-30 16:14:14 -07001286 allocate(BLOCKSIZE, &params.buffer);
Tao Baobf5b77d2017-03-30 16:57:29 -07001287 memset(params.buffer.data(), 0, BLOCKSIZE);
1288
1289 if (params.canwrite) {
Tao Bao43bfa6e2018-08-28 10:09:13 -07001290 for (const auto& [begin, end] : tgt) {
1291 off64_t offset = static_cast<off64_t>(begin) * BLOCKSIZE;
1292 size_t size = (end - begin) * BLOCKSIZE;
Tao Baobf5b77d2017-03-30 16:57:29 -07001293 if (!discard_blocks(params.fd, offset, size)) {
Tao Bao0940fe12015-08-27 16:41:21 -07001294 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -07001295 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001296
Tao Baobf5b77d2017-03-30 16:57:29 -07001297 if (!check_lseek(params.fd, offset, SEEK_SET)) {
1298 return -1;
1299 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001300
Tao Bao43bfa6e2018-08-28 10:09:13 -07001301 for (size_t j = begin; j < end; ++j) {
Tianjie Xu22f11202018-08-27 10:50:31 -07001302 if (!android::base::WriteFully(params.fd, params.buffer.data(), BLOCKSIZE)) {
1303 failure_type = errno == EIO ? kEioFailure : kFwriteFailure;
1304 PLOG(ERROR) << "Failed to write " << BLOCKSIZE << " bytes of data";
Tao Baobf5b77d2017-03-30 16:57:29 -07001305 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +00001306 }
Tao Baobf5b77d2017-03-30 16:57:29 -07001307 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001308 }
Tao Baobf5b77d2017-03-30 16:57:29 -07001309 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001310
Tao Baobf5b77d2017-03-30 16:57:29 -07001311 if (params.cmdname[0] == 'z') {
1312 // Update only for the zero command, as the erase command will call
1313 // this if DEBUG_ERASE is defined.
1314 params.written += tgt.blocks();
1315 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001316
Tao Baobf5b77d2017-03-30 16:57:29 -07001317 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001318}
1319
Tao Bao0940fe12015-08-27 16:41:21 -07001320static int PerformCommandNew(CommandParameters& params) {
Tao Bao60a70af2017-03-26 14:03:52 -07001321 if (params.cpos >= params.tokens.size()) {
1322 LOG(ERROR) << "missing target blocks for new";
1323 return -1;
1324 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001325
Tao Bao8f237572017-03-26 13:36:49 -07001326 RangeSet tgt = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001327 CHECK(static_cast<bool>(tgt));
Tao Bao60a70af2017-03-26 14:03:52 -07001328
1329 if (params.canwrite) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001330 LOG(INFO) << " writing " << tgt.blocks() << " blocks of new data";
Tao Bao60a70af2017-03-26 14:03:52 -07001331
Tao Bao60a70af2017-03-26 14:03:52 -07001332 pthread_mutex_lock(&params.nti.mu);
Tianjie Xu6ed175d2017-07-18 11:29:40 -07001333 params.nti.writer = std::make_unique<RangeSinkWriter>(params.fd, tgt);
Tao Bao60a70af2017-03-26 14:03:52 -07001334 pthread_cond_broadcast(&params.nti.cv);
1335
1336 while (params.nti.writer != nullptr) {
Tianjie Xu3a8d98d2017-04-03 20:01:17 -07001337 if (!params.nti.receiver_available) {
1338 LOG(ERROR) << "missing " << (tgt.blocks() * BLOCKSIZE - params.nti.writer->BytesWritten())
1339 << " bytes of new data";
1340 pthread_mutex_unlock(&params.nti.mu);
1341 return -1;
1342 }
Tao Bao60a70af2017-03-26 14:03:52 -07001343 pthread_cond_wait(&params.nti.cv, &params.nti.mu);
Sami Tolvanen90221202014-12-09 16:39:47 +00001344 }
1345
Tao Bao60a70af2017-03-26 14:03:52 -07001346 pthread_mutex_unlock(&params.nti.mu);
1347 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001348
Tao Baobf5b77d2017-03-30 16:57:29 -07001349 params.written += tgt.blocks();
Sami Tolvanen90221202014-12-09 16:39:47 +00001350
Tao Bao60a70af2017-03-26 14:03:52 -07001351 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001352}
1353
Tao Bao0940fe12015-08-27 16:41:21 -07001354static int PerformCommandDiff(CommandParameters& params) {
Tao Baoc0e1c462017-02-01 10:20:10 -08001355 // <offset> <length>
1356 if (params.cpos + 1 >= params.tokens.size()) {
1357 LOG(ERROR) << "missing patch offset or length for " << params.cmdname;
1358 return -1;
1359 }
Tao Bao0940fe12015-08-27 16:41:21 -07001360
Tao Baoc0e1c462017-02-01 10:20:10 -08001361 size_t offset;
1362 if (!android::base::ParseUint(params.tokens[params.cpos++], &offset)) {
1363 LOG(ERROR) << "invalid patch offset";
1364 return -1;
1365 }
Tao Bao0940fe12015-08-27 16:41:21 -07001366
Tao Baoc0e1c462017-02-01 10:20:10 -08001367 size_t len;
1368 if (!android::base::ParseUint(params.tokens[params.cpos++], &len)) {
1369 LOG(ERROR) << "invalid patch len";
1370 return -1;
1371 }
Tao Bao0940fe12015-08-27 16:41:21 -07001372
Tao Baoc0e1c462017-02-01 10:20:10 -08001373 RangeSet tgt;
1374 size_t blocks = 0;
Tao Bao4a135082018-06-07 22:27:44 -07001375 int status = LoadSrcTgtVersion3(params, &tgt, &blocks, false);
Tao Bao0940fe12015-08-27 16:41:21 -07001376
Tao Baoc0e1c462017-02-01 10:20:10 -08001377 if (status == -1) {
1378 LOG(ERROR) << "failed to read blocks for diff";
1379 return -1;
1380 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001381
Tao Baoc0e1c462017-02-01 10:20:10 -08001382 if (status == 0) {
1383 params.foundwrites = true;
Tianjie Xu284752e2017-12-05 11:04:17 -08001384 } else {
1385 params.target_verified = true;
1386 if (params.foundwrites) {
1387 LOG(WARNING) << "warning: commands executed out of order [" << params.cmdname << "]";
1388 }
Tao Baoc0e1c462017-02-01 10:20:10 -08001389 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001390
Tao Baoc0e1c462017-02-01 10:20:10 -08001391 if (params.canwrite) {
Sami Tolvanen90221202014-12-09 16:39:47 +00001392 if (status == 0) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001393 LOG(INFO) << "patching " << blocks << " blocks to " << tgt.blocks();
Tao Baoc0e1c462017-02-01 10:20:10 -08001394 Value patch_value(
Tao Bao511d7592018-06-19 15:56:49 -07001395 Value::Type::BLOB,
1396 std::string(reinterpret_cast<const char*>(params.patch_start + offset), len));
Sami Tolvanen90221202014-12-09 16:39:47 +00001397
Tao Bao60a70af2017-03-26 14:03:52 -07001398 RangeSinkWriter writer(params.fd, tgt);
Tao Baoc0e1c462017-02-01 10:20:10 -08001399 if (params.cmdname[0] == 'i') { // imgdiff
Tao Bao1e0941f2017-11-10 11:49:53 -08001400 if (ApplyImagePatch(params.buffer.data(), blocks * BLOCKSIZE, patch_value,
Tao Bao60a70af2017-03-26 14:03:52 -07001401 std::bind(&RangeSinkWriter::Write, &writer, std::placeholders::_1,
1402 std::placeholders::_2),
Tao Bao8b0b0f12018-04-19 21:02:13 -07001403 nullptr) != 0) {
Tao Baoc0e1c462017-02-01 10:20:10 -08001404 LOG(ERROR) << "Failed to apply image patch.";
Tianjie Xu69575552017-05-16 15:51:46 -07001405 failure_type = kPatchApplicationFailure;
Tao Baoc0e1c462017-02-01 10:20:10 -08001406 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +00001407 }
Tao Baoc0e1c462017-02-01 10:20:10 -08001408 } else {
Tao Bao1e0941f2017-11-10 11:49:53 -08001409 if (ApplyBSDiffPatch(params.buffer.data(), blocks * BLOCKSIZE, patch_value, 0,
Tao Bao60a70af2017-03-26 14:03:52 -07001410 std::bind(&RangeSinkWriter::Write, &writer, std::placeholders::_1,
Tao Bao8b0b0f12018-04-19 21:02:13 -07001411 std::placeholders::_2)) != 0) {
Tao Baoc0e1c462017-02-01 10:20:10 -08001412 LOG(ERROR) << "Failed to apply bsdiff patch.";
Tianjie Xu69575552017-05-16 15:51:46 -07001413 failure_type = kPatchApplicationFailure;
Tao Baoc0e1c462017-02-01 10:20:10 -08001414 return -1;
1415 }
1416 }
1417
1418 // We expect the output of the patcher to fill the tgt ranges exactly.
Tao Bao60a70af2017-03-26 14:03:52 -07001419 if (!writer.Finished()) {
Tao Baoa2cff952018-11-02 15:44:07 -07001420 LOG(ERROR) << "Failed to fully write target blocks (range sink underrun): Missing "
1421 << writer.AvailableSpace() << " bytes";
1422 failure_type = kPatchApplicationFailure;
1423 return -1;
Tao Baoc0e1c462017-02-01 10:20:10 -08001424 }
1425 } else {
Tao Baobf5b77d2017-03-30 16:57:29 -07001426 LOG(INFO) << "skipping " << blocks << " blocks already patched to " << tgt.blocks() << " ["
Tao Baoc0e1c462017-02-01 10:20:10 -08001427 << params.cmdline << "]";
Sami Tolvanen90221202014-12-09 16:39:47 +00001428 }
Tao Baoc0e1c462017-02-01 10:20:10 -08001429 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001430
Tao Baoc0e1c462017-02-01 10:20:10 -08001431 if (!params.freestash.empty()) {
1432 FreeStash(params.stashbase, params.freestash);
1433 params.freestash.clear();
1434 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001435
Tao Baobf5b77d2017-03-30 16:57:29 -07001436 params.written += tgt.blocks();
Sami Tolvanen90221202014-12-09 16:39:47 +00001437
Tao Baoc0e1c462017-02-01 10:20:10 -08001438 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001439}
1440
Tao Bao0940fe12015-08-27 16:41:21 -07001441static int PerformCommandErase(CommandParameters& params) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001442 if (DEBUG_ERASE) {
1443 return PerformCommandZero(params);
1444 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001445
Tao Baobf5b77d2017-03-30 16:57:29 -07001446 struct stat sb;
1447 if (fstat(params.fd, &sb) == -1) {
1448 PLOG(ERROR) << "failed to fstat device to erase";
1449 return -1;
1450 }
1451
1452 if (!S_ISBLK(sb.st_mode)) {
1453 LOG(ERROR) << "not a block device; skipping erase";
1454 return -1;
1455 }
1456
1457 if (params.cpos >= params.tokens.size()) {
1458 LOG(ERROR) << "missing target blocks for erase";
1459 return -1;
1460 }
1461
1462 RangeSet tgt = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001463 CHECK(static_cast<bool>(tgt));
Tao Baobf5b77d2017-03-30 16:57:29 -07001464
1465 if (params.canwrite) {
1466 LOG(INFO) << " erasing " << tgt.blocks() << " blocks";
1467
Tao Bao43bfa6e2018-08-28 10:09:13 -07001468 for (const auto& [begin, end] : tgt) {
Yifan Hong363d6242019-01-04 11:14:19 -08001469 off64_t offset = static_cast<off64_t>(begin) * BLOCKSIZE;
1470 size_t size = (end - begin) * BLOCKSIZE;
1471 if (!discard_blocks(params.fd, offset, size, true /* force */)) {
Tao Bao0940fe12015-08-27 16:41:21 -07001472 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -07001473 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001474 }
Tao Baobf5b77d2017-03-30 16:57:29 -07001475 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001476
Tao Baobf5b77d2017-03-30 16:57:29 -07001477 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001478}
1479
Tao Bao91a649a2018-05-21 16:05:56 -07001480static int PerformCommandAbort(CommandParameters&) {
1481 LOG(INFO) << "Aborting as instructed";
1482 return -1;
1483}
Sami Tolvanen90221202014-12-09 16:39:47 +00001484
Tianjie Xu69ffa152018-08-01 16:40:00 -07001485// Computes the hash_tree bytes based on the parameters, checks if the root hash of the tree
1486// matches the expected hash and writes the result to the specified range on the block_device.
1487// Hash_tree computation arguments:
1488// hash_tree_ranges
1489// source_ranges
1490// hash_algorithm
1491// salt_hex
1492// root_hash
1493static int PerformCommandComputeHashTree(CommandParameters& params) {
1494 if (params.cpos + 5 != params.tokens.size()) {
1495 LOG(ERROR) << "Invaild arguments count in hash computation " << params.cmdline;
1496 return -1;
1497 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001498
Tianjie Xu69ffa152018-08-01 16:40:00 -07001499 // Expects the hash_tree data to be contiguous.
1500 RangeSet hash_tree_ranges = RangeSet::Parse(params.tokens[params.cpos++]);
1501 if (!hash_tree_ranges || hash_tree_ranges.size() != 1) {
1502 LOG(ERROR) << "Invalid hash tree ranges in " << params.cmdline;
1503 return -1;
1504 }
1505
1506 RangeSet source_ranges = RangeSet::Parse(params.tokens[params.cpos++]);
1507 if (!source_ranges) {
1508 LOG(ERROR) << "Invalid source ranges in " << params.cmdline;
1509 return -1;
1510 }
1511
1512 auto hash_function = HashTreeBuilder::HashFunction(params.tokens[params.cpos++]);
1513 if (hash_function == nullptr) {
1514 LOG(ERROR) << "Invalid hash algorithm in " << params.cmdline;
1515 return -1;
1516 }
1517
1518 std::vector<unsigned char> salt;
1519 std::string salt_hex = params.tokens[params.cpos++];
1520 if (salt_hex.empty() || !HashTreeBuilder::ParseBytesArrayFromString(salt_hex, &salt)) {
1521 LOG(ERROR) << "Failed to parse salt in " << params.cmdline;
1522 return -1;
1523 }
1524
1525 std::string expected_root_hash = params.tokens[params.cpos++];
1526 if (expected_root_hash.empty()) {
1527 LOG(ERROR) << "Invalid root hash in " << params.cmdline;
1528 return -1;
1529 }
1530
1531 // Starts the hash_tree computation.
1532 HashTreeBuilder builder(BLOCKSIZE, hash_function);
xunchang53158e52019-01-17 09:26:12 -08001533 if (!builder.Initialize(static_cast<int64_t>(source_ranges.blocks()) * BLOCKSIZE, salt)) {
Tianjie Xu69ffa152018-08-01 16:40:00 -07001534 LOG(ERROR) << "Failed to initialize hash tree computation, source " << source_ranges.ToString()
1535 << ", salt " << salt_hex;
1536 return -1;
1537 }
1538
1539 // Iterates through every block in the source_ranges and updates the hash tree structure
1540 // accordingly.
Tao Bao43bfa6e2018-08-28 10:09:13 -07001541 for (const auto& [begin, end] : source_ranges) {
Tianjie Xu69ffa152018-08-01 16:40:00 -07001542 uint8_t buffer[BLOCKSIZE];
Tao Bao43bfa6e2018-08-28 10:09:13 -07001543 if (!check_lseek(params.fd, static_cast<off64_t>(begin) * BLOCKSIZE, SEEK_SET)) {
1544 PLOG(ERROR) << "Failed to seek to block: " << begin;
Tianjie Xu69ffa152018-08-01 16:40:00 -07001545 return -1;
1546 }
1547
Tao Bao43bfa6e2018-08-28 10:09:13 -07001548 for (size_t i = begin; i < end; i++) {
Tianjie Xu22f11202018-08-27 10:50:31 -07001549 if (!android::base::ReadFully(params.fd, buffer, BLOCKSIZE)) {
1550 failure_type = errno == EIO ? kEioFailure : kFreadFailure;
Tao Bao43bfa6e2018-08-28 10:09:13 -07001551 LOG(ERROR) << "Failed to read data in " << begin << ":" << end;
Tianjie Xu69ffa152018-08-01 16:40:00 -07001552 return -1;
1553 }
1554
1555 if (!builder.Update(reinterpret_cast<unsigned char*>(buffer), BLOCKSIZE)) {
1556 LOG(ERROR) << "Failed to update hash tree builder";
1557 return -1;
1558 }
bigbiff26d5d5f2020-03-23 09:56:16 -04001559#endif
Tianjie Xu69ffa152018-08-01 16:40:00 -07001560 }
1561 }
1562
1563 if (!builder.BuildHashTree()) {
1564 LOG(ERROR) << "Failed to build hash tree";
1565 return -1;
1566 }
1567
1568 std::string root_hash_hex = HashTreeBuilder::BytesArrayToString(builder.root_hash());
1569 if (root_hash_hex != expected_root_hash) {
1570 LOG(ERROR) << "Root hash of the verity hash tree doesn't match the expected value. Expected: "
1571 << expected_root_hash << ", actual: " << root_hash_hex;
1572 return -1;
1573 }
1574
1575 uint64_t write_offset = static_cast<uint64_t>(hash_tree_ranges.GetBlockNumber(0)) * BLOCKSIZE;
1576 if (params.canwrite && !builder.WriteHashTreeToFd(params.fd, write_offset)) {
1577 LOG(ERROR) << "Failed to write hash tree to output";
1578 return -1;
1579 }
1580
1581 // TODO(xunchang) validates the written bytes
1582
1583 return 0;
1584}
1585
Tao Baoc3901232018-05-21 16:05:56 -07001586using CommandFunction = std::function<int(CommandParameters&)>;
Sami Tolvanen90221202014-12-09 16:39:47 +00001587
Tao Baoc3901232018-05-21 16:05:56 -07001588using CommandMap = std::unordered_map<Command::Type, CommandFunction>;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001589
Yifan Hong8ff84d72018-12-19 16:21:55 -08001590static bool Sha1DevicePath(const std::string& path, uint8_t digest[SHA_DIGEST_LENGTH]) {
1591 auto device_name = android::base::Basename(path);
1592 auto dm_target_name_path = "/sys/block/" + device_name + "/dm/name";
1593
1594 struct stat sb;
1595 if (stat(dm_target_name_path.c_str(), &sb) == 0) {
1596 // This is a device mapper target. Use partition name as part of the hash instead. Do not
1597 // include extents as part of the hash, because the size of a partition may be shrunk after
1598 // the patches are applied.
1599 std::string dm_target_name;
1600 if (!android::base::ReadFileToString(dm_target_name_path, &dm_target_name)) {
1601 PLOG(ERROR) << "Cannot read " << dm_target_name_path;
1602 return false;
1603 }
1604 SHA1(reinterpret_cast<const uint8_t*>(dm_target_name.data()), dm_target_name.size(), digest);
1605 return true;
1606 }
1607
1608 if (errno != ENOENT) {
1609 // This is a device mapper target, but its name cannot be retrieved.
1610 PLOG(ERROR) << "Cannot get dm target name for " << path;
1611 return false;
1612 }
1613
1614 // This doesn't appear to be a device mapper target, but if its name starts with dm-, something
1615 // else might have gone wrong.
1616 if (android::base::StartsWith(device_name, "dm-")) {
1617 LOG(WARNING) << "Device " << path << " starts with dm- but is not mapped by device-mapper.";
1618 }
1619
1620 // Stash directory should be different for each partition to avoid conflicts when updating
1621 // multiple partitions at the same time, so we use the hash of the block device name as the base
1622 // directory.
1623 SHA1(reinterpret_cast<const uint8_t*>(path.data()), path.size(), digest);
1624 return true;
1625}
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001626
Tianjie Xuc4447322017-03-06 14:44:59 -08001627static Value* PerformBlockImageUpdate(const char* name, State* state,
1628 const std::vector<std::unique_ptr<Expr>>& argv,
Tao Baoc3901232018-05-21 16:05:56 -07001629 const CommandMap& command_map, bool dryrun) {
Tao Bao33567772017-03-13 14:57:34 -07001630 CommandParameters params = {};
Tao Baoc0299ed2018-05-24 00:16:35 -07001631 stash_map.clear();
Tao Bao33567772017-03-13 14:57:34 -07001632 params.canwrite = !dryrun;
Sami Tolvanen90221202014-12-09 16:39:47 +00001633
Tao Bao33567772017-03-13 14:57:34 -07001634 LOG(INFO) << "performing " << (dryrun ? "verification" : "update");
1635 if (state->is_retry) {
1636 is_retry = true;
1637 LOG(INFO) << "This update is a retry.";
1638 }
1639 if (argv.size() != 4) {
1640 ErrorAbort(state, kArgsParsingFailure, "block_image_update expects 4 arguments, got %zu",
1641 argv.size());
1642 return StringValue("");
1643 }
1644
1645 std::vector<std::unique_ptr<Value>> args;
1646 if (!ReadValueArgs(state, argv, &args)) {
1647 return nullptr;
1648 }
1649
Tao Baoc3901232018-05-21 16:05:56 -07001650 // args:
1651 // - block device (or file) to modify in-place
1652 // - transfer list (blob)
1653 // - new data stream (filename within package.zip)
1654 // - patch stream (filename within package.zip, must be uncompressed)
Tao Baoc97edcb2017-03-31 01:18:13 -07001655 const std::unique_ptr<Value>& blockdev_filename = args[0];
1656 const std::unique_ptr<Value>& transfer_list_value = args[1];
1657 const std::unique_ptr<Value>& new_data_fn = args[2];
1658 const std::unique_ptr<Value>& patch_data_fn = args[3];
Tao Bao33567772017-03-13 14:57:34 -07001659
Tao Bao511d7592018-06-19 15:56:49 -07001660 if (blockdev_filename->type != Value::Type::STRING) {
Tao Bao33567772017-03-13 14:57:34 -07001661 ErrorAbort(state, kArgsParsingFailure, "blockdev_filename argument to %s must be string", name);
1662 return StringValue("");
1663 }
Tao Bao511d7592018-06-19 15:56:49 -07001664 if (transfer_list_value->type != Value::Type::BLOB) {
Tao Bao33567772017-03-13 14:57:34 -07001665 ErrorAbort(state, kArgsParsingFailure, "transfer_list argument to %s must be blob", name);
1666 return StringValue("");
1667 }
Tao Bao511d7592018-06-19 15:56:49 -07001668 if (new_data_fn->type != Value::Type::STRING) {
Tao Bao33567772017-03-13 14:57:34 -07001669 ErrorAbort(state, kArgsParsingFailure, "new_data_fn argument to %s must be string", name);
1670 return StringValue("");
1671 }
Tao Bao511d7592018-06-19 15:56:49 -07001672 if (patch_data_fn->type != Value::Type::STRING) {
Tao Bao33567772017-03-13 14:57:34 -07001673 ErrorAbort(state, kArgsParsingFailure, "patch_data_fn argument to %s must be string", name);
1674 return StringValue("");
1675 }
1676
Tianjie Xu1536db82019-05-14 10:54:43 -07001677 auto updater = state->updater;
1678 auto block_device_path = updater->FindBlockDeviceName(blockdev_filename->data);
1679 if (block_device_path.empty()) {
1680 LOG(ERROR) << "Block device path for " << blockdev_filename->data << " not found. " << name
1681 << " failed.";
Tao Bao33567772017-03-13 14:57:34 -07001682 return StringValue("");
1683 }
1684
Tianjie Xu1536db82019-05-14 10:54:43 -07001685 ZipArchiveHandle za = updater->GetPackageHandle();
Tianjie Xu58d59122019-05-03 01:05:04 -07001686 if (za == nullptr) {
Tao Bao33567772017-03-13 14:57:34 -07001687 return StringValue("");
1688 }
1689
Elliott Hughesa86dddb2019-05-03 22:52:37 -07001690 std::string_view path_data(patch_data_fn->data);
Tao Bao33567772017-03-13 14:57:34 -07001691 ZipEntry patch_entry;
1692 if (FindEntry(za, path_data, &patch_entry) != 0) {
1693 LOG(ERROR) << name << "(): no file \"" << patch_data_fn->data << "\" in package";
1694 return StringValue("");
1695 }
Tianjie Xu58d59122019-05-03 01:05:04 -07001696 params.patch_start = updater->GetMappedPackageAddress() + patch_entry.offset;
Tao Bao33567772017-03-13 14:57:34 -07001697
Elliott Hughesa86dddb2019-05-03 22:52:37 -07001698 std::string_view new_data(new_data_fn->data);
Tao Bao33567772017-03-13 14:57:34 -07001699 ZipEntry new_entry;
1700 if (FindEntry(za, new_data, &new_entry) != 0) {
1701 LOG(ERROR) << name << "(): no file \"" << new_data_fn->data << "\" in package";
1702 return StringValue("");
1703 }
1704
Tianjie Xu1536db82019-05-14 10:54:43 -07001705 params.fd.reset(TEMP_FAILURE_RETRY(open(block_device_path.c_str(), O_RDWR)));
Tao Bao33567772017-03-13 14:57:34 -07001706 if (params.fd == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -07001707 failure_type = errno == EIO ? kEioFailure : kFileOpenFailure;
Tianjie Xu1536db82019-05-14 10:54:43 -07001708 PLOG(ERROR) << "open \"" << block_device_path << "\" failed";
Tao Bao33567772017-03-13 14:57:34 -07001709 return StringValue("");
1710 }
1711
Tao Bao864c6682018-05-07 11:38:25 -07001712 uint8_t digest[SHA_DIGEST_LENGTH];
Tianjie Xu1536db82019-05-14 10:54:43 -07001713 if (!Sha1DevicePath(block_device_path, digest)) {
Yifan Hong8ff84d72018-12-19 16:21:55 -08001714 return StringValue("");
1715 }
Tao Bao864c6682018-05-07 11:38:25 -07001716 params.stashbase = print_sha1(digest);
1717
1718 // Possibly do return early on retry, by checking the marker. If the update on this partition has
1719 // been finished (but interrupted at a later point), there could be leftover on /cache that would
1720 // fail the no-op retry.
1721 std::string updated_marker = GetStashFileName(params.stashbase + ".UPDATED", "", "");
1722 if (is_retry) {
1723 struct stat sb;
1724 int result = stat(updated_marker.c_str(), &sb);
1725 if (result == 0) {
Tianjie Xu1536db82019-05-14 10:54:43 -07001726 LOG(INFO) << "Skipping already updated partition " << block_device_path << " based on marker";
Tao Bao864c6682018-05-07 11:38:25 -07001727 return StringValue("t");
Tianjie Xu107a34f2017-06-29 17:04:21 -07001728 }
Tao Bao864c6682018-05-07 11:38:25 -07001729 } else {
1730 // Delete the obsolete marker if any.
1731 std::string err;
1732 if (!android::base::RemoveFileIfExists(updated_marker, &err)) {
1733 LOG(ERROR) << "Failed to remove partition updated marker " << updated_marker << ": " << err;
Tao Bao33567772017-03-13 14:57:34 -07001734 return StringValue("");
Tianjie Xu7ce287d2016-05-31 09:29:49 -07001735 }
Tao Bao33567772017-03-13 14:57:34 -07001736 }
1737
Tao Baoffede3e2018-06-07 09:56:19 -07001738 static constexpr size_t kTransferListHeaderLines = 4;
Tao Bao33567772017-03-13 14:57:34 -07001739 std::vector<std::string> lines = android::base::Split(transfer_list_value->data, "\n");
Tao Baoffede3e2018-06-07 09:56:19 -07001740 if (lines.size() < kTransferListHeaderLines) {
1741 ErrorAbort(state, kArgsParsingFailure, "too few lines in the transfer list [%zu]",
Tao Bao33567772017-03-13 14:57:34 -07001742 lines.size());
1743 return StringValue("");
1744 }
1745
1746 // First line in transfer list is the version number.
1747 if (!android::base::ParseInt(lines[0], &params.version, 3, 4)) {
1748 LOG(ERROR) << "unexpected transfer list version [" << lines[0] << "]";
1749 return StringValue("");
1750 }
1751
1752 LOG(INFO) << "blockimg version is " << params.version;
1753
1754 // Second line in transfer list is the total number of blocks we expect to write.
1755 size_t total_blocks;
1756 if (!android::base::ParseUint(lines[1], &total_blocks)) {
Tianjie Xu5ad80282018-01-28 15:37:48 -08001757 ErrorAbort(state, kArgsParsingFailure, "unexpected block count [%s]", lines[1].c_str());
Tao Bao33567772017-03-13 14:57:34 -07001758 return StringValue("");
1759 }
1760
1761 if (total_blocks == 0) {
1762 return StringValue("t");
1763 }
1764
Tao Bao33567772017-03-13 14:57:34 -07001765 // Third line is how many stash entries are needed simultaneously.
1766 LOG(INFO) << "maximum stash entries " << lines[2];
1767
1768 // Fourth line is the maximum number of blocks that will be stashed simultaneously
1769 size_t stash_max_blocks;
1770 if (!android::base::ParseUint(lines[3], &stash_max_blocks)) {
Tianjie Xu5ad80282018-01-28 15:37:48 -08001771 ErrorAbort(state, kArgsParsingFailure, "unexpected maximum stash blocks [%s]",
Tao Bao33567772017-03-13 14:57:34 -07001772 lines[3].c_str());
1773 return StringValue("");
1774 }
1775
Tao Bao864c6682018-05-07 11:38:25 -07001776 int res = CreateStash(state, stash_max_blocks, params.stashbase);
Tao Bao33567772017-03-13 14:57:34 -07001777 if (res == -1) {
1778 return StringValue("");
1779 }
Tao Bao33567772017-03-13 14:57:34 -07001780 params.createdstash = res;
1781
Tao Bao0a883c12018-06-18 12:49:06 -07001782 // Set up the new data writer.
1783 if (params.canwrite) {
1784 params.nti.za = za;
1785 params.nti.entry = new_entry;
1786 params.nti.brotli_compressed = android::base::EndsWith(new_data_fn->data, ".br");
1787 if (params.nti.brotli_compressed) {
1788 // Initialize brotli decoder state.
1789 params.nti.brotli_decoder_state = BrotliDecoderCreateInstance(nullptr, nullptr, nullptr);
1790 }
1791 params.nti.receiver_available = true;
1792
1793 pthread_mutex_init(&params.nti.mu, nullptr);
1794 pthread_cond_init(&params.nti.cv, nullptr);
1795 pthread_attr_t attr;
1796 pthread_attr_init(&attr);
1797 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_JOINABLE);
1798
1799 int error = pthread_create(&params.thread, &attr, unzip_new_data, &params.nti);
1800 if (error != 0) {
1801 LOG(ERROR) << "pthread_create failed: " << strerror(error);
1802 return StringValue("");
1803 }
1804 }
1805
Tao Bao26efb0a2018-05-21 14:59:55 -07001806 // When performing an update, save the index and cmdline of the current command into the
1807 // last_command_file.
Tianjie Xu284752e2017-12-05 11:04:17 -08001808 // Upon resuming an update, read the saved index first; then
1809 // 1. In verification mode, check if the 'move' or 'diff' commands before the saved index has
1810 // the expected target blocks already. If not, these commands cannot be skipped and we need
1811 // to attempt to execute them again. Therefore, we will delete the last_command_file so that
1812 // the update will resume from the start of the transfer list.
1813 // 2. In update mode, skip all commands before the saved index. Therefore, we can avoid deleting
1814 // stashes with duplicate id unintentionally (b/69858743); and also speed up the update.
1815 // If an update succeeds or is unresumable, delete the last_command_file.
Tao Bao26efb0a2018-05-21 14:59:55 -07001816 bool skip_executed_command = true;
1817 size_t saved_last_command_index;
Tianjie Xu284752e2017-12-05 11:04:17 -08001818 if (!ParseLastCommandFile(&saved_last_command_index)) {
1819 DeleteLastCommandFile();
Tao Bao26efb0a2018-05-21 14:59:55 -07001820 // We failed to parse the last command. Disallow skipping executed commands.
1821 skip_executed_command = false;
Tao Bao33567772017-03-13 14:57:34 -07001822 }
1823
1824 int rc = -1;
1825
1826 // Subsequent lines are all individual transfer commands
Tao Baoab207062018-05-21 14:48:49 -07001827 for (size_t i = kTransferListHeaderLines; i < lines.size(); i++) {
Tianjie Xu284752e2017-12-05 11:04:17 -08001828 const std::string& line = lines[i];
Tao Bao33567772017-03-13 14:57:34 -07001829 if (line.empty()) continue;
1830
Tao Bao26efb0a2018-05-21 14:59:55 -07001831 size_t cmdindex = i - kTransferListHeaderLines;
Tao Bao33567772017-03-13 14:57:34 -07001832 params.tokens = android::base::Split(line, " ");
1833 params.cpos = 0;
Tao Baoc3901232018-05-21 16:05:56 -07001834 params.cmdname = params.tokens[params.cpos++];
1835 params.cmdline = line;
Tianjie Xu284752e2017-12-05 11:04:17 -08001836 params.target_verified = false;
Tao Bao33567772017-03-13 14:57:34 -07001837
Tao Baoc3901232018-05-21 16:05:56 -07001838 Command::Type cmd_type = Command::ParseType(params.cmdname);
1839 if (cmd_type == Command::Type::LAST) {
Tao Bao33567772017-03-13 14:57:34 -07001840 LOG(ERROR) << "unexpected command [" << params.cmdname << "]";
1841 goto pbiudone;
Tianjie Xuc4447322017-03-06 14:44:59 -08001842 }
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001843
Tao Baoc3901232018-05-21 16:05:56 -07001844 const CommandFunction& performer = command_map.at(cmd_type);
Tianjie Xu5fe280a2016-10-17 18:15:20 -07001845
Tianjie Xuc2420842018-02-27 17:05:39 -08001846 // Skip the command if we explicitly set the corresponding function pointer to nullptr, e.g.
1847 // "erase" during block_image_verify.
Tao Baoc3901232018-05-21 16:05:56 -07001848 if (performer == nullptr) {
Tianjie Xuc2420842018-02-27 17:05:39 -08001849 LOG(DEBUG) << "skip executing command [" << line << "]";
1850 continue;
Tianjie Xu284752e2017-12-05 11:04:17 -08001851 }
1852
Tao Bao98f875e2018-05-07 15:03:30 -07001853 // Skip all commands before the saved last command index when resuming an update, except for
1854 // "new" command. Because new commands read in the data sequentially.
Tao Bao26efb0a2018-05-21 14:59:55 -07001855 if (params.canwrite && skip_executed_command && cmdindex <= saved_last_command_index &&
Tao Baoc3901232018-05-21 16:05:56 -07001856 cmd_type != Command::Type::NEW) {
Tao Bao26efb0a2018-05-21 14:59:55 -07001857 LOG(INFO) << "Skipping already executed command: " << cmdindex
Tianjie Xu284752e2017-12-05 11:04:17 -08001858 << ", last executed command for previous update: " << saved_last_command_index;
1859 continue;
1860 }
1861
Tao Baoc3901232018-05-21 16:05:56 -07001862 if (performer(params) == -1) {
Tao Bao33567772017-03-13 14:57:34 -07001863 LOG(ERROR) << "failed to execute command [" << line << "]";
Tianjie Xu69ffa152018-08-01 16:40:00 -07001864 if (cmd_type == Command::Type::COMPUTE_HASH_TREE && failure_type == kNoCause) {
1865 failure_type = kHashTreeComputationFailure;
1866 }
Tao Bao33567772017-03-13 14:57:34 -07001867 goto pbiudone;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001868 }
1869
Tao Bao26efb0a2018-05-21 14:59:55 -07001870 // In verify mode, check if the commands before the saved last_command_index have been executed
1871 // correctly. If some target blocks have unexpected contents, delete the last command file so
1872 // that we will resume the update from the first command in the transfer list.
1873 if (!params.canwrite && skip_executed_command && cmdindex <= saved_last_command_index) {
Tianjie Xu284752e2017-12-05 11:04:17 -08001874 // TODO(xunchang) check that the cmdline of the saved index is correct.
Tao Baoc3901232018-05-21 16:05:56 -07001875 if ((cmd_type == Command::Type::MOVE || cmd_type == Command::Type::BSDIFF ||
1876 cmd_type == Command::Type::IMGDIFF) &&
Tianjie Xu284752e2017-12-05 11:04:17 -08001877 !params.target_verified) {
1878 LOG(WARNING) << "Previously executed command " << saved_last_command_index << ": "
1879 << params.cmdline << " doesn't produce expected target blocks.";
Tao Bao26efb0a2018-05-21 14:59:55 -07001880 skip_executed_command = false;
Tianjie Xu284752e2017-12-05 11:04:17 -08001881 DeleteLastCommandFile();
1882 }
1883 }
Tao Baoc3901232018-05-21 16:05:56 -07001884
Sami Tolvanen90221202014-12-09 16:39:47 +00001885 if (params.canwrite) {
Tianjie Xu22f11202018-08-27 10:50:31 -07001886 if (fsync(params.fd) == -1) {
1887 failure_type = errno == EIO ? kEioFailure : kFsyncFailure;
Tao Bao039f2da2016-11-22 16:29:50 -08001888 PLOG(ERROR) << "fsync failed";
Tao Bao33567772017-03-13 14:57:34 -07001889 goto pbiudone;
1890 }
Tianjie Xuc2b2bb52018-05-15 15:09:59 -07001891
Tao Bao26efb0a2018-05-21 14:59:55 -07001892 if (!UpdateLastCommandIndex(cmdindex, params.cmdline)) {
Tianjie Xuc2b2bb52018-05-15 15:09:59 -07001893 LOG(WARNING) << "Failed to update the last command file.";
1894 }
1895
Tianjie Xu58d59122019-05-03 01:05:04 -07001896 updater->WriteToCommandPipe(
1897 android::base::StringPrintf("set_progress %.4f",
1898 static_cast<double>(params.written) / total_blocks),
1899 true);
Sami Tolvanen90221202014-12-09 16:39:47 +00001900 }
Tao Bao33567772017-03-13 14:57:34 -07001901 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001902
Tao Bao33567772017-03-13 14:57:34 -07001903 rc = 0;
Tianjie Xu16255832016-04-30 11:49:59 -07001904
Tao Bao33567772017-03-13 14:57:34 -07001905pbiudone:
Tianjie Xu5450c842017-10-18 13:15:21 -07001906 if (params.canwrite) {
1907 pthread_mutex_lock(&params.nti.mu);
1908 if (params.nti.receiver_available) {
1909 LOG(WARNING) << "new data receiver is still available after executing all commands.";
1910 }
1911 params.nti.receiver_available = false;
1912 pthread_cond_broadcast(&params.nti.cv);
1913 pthread_mutex_unlock(&params.nti.mu);
1914 int ret = pthread_join(params.thread, nullptr);
1915 if (ret != 0) {
1916 LOG(WARNING) << "pthread join returned with " << strerror(ret);
1917 }
1918
1919 if (rc == 0) {
1920 LOG(INFO) << "wrote " << params.written << " blocks; expected " << total_blocks;
1921 LOG(INFO) << "stashed " << params.stashed << " blocks";
1922 LOG(INFO) << "max alloc needed was " << params.buffer.size();
1923
Tianjie Xu1536db82019-05-14 10:54:43 -07001924 const char* partition = strrchr(block_device_path.c_str(), '/');
Tianjie Xu5450c842017-10-18 13:15:21 -07001925 if (partition != nullptr && *(partition + 1) != 0) {
Tianjie Xu58d59122019-05-03 01:05:04 -07001926 updater->WriteToCommandPipe(
1927 android::base::StringPrintf("log bytes_written_%s: %" PRIu64, partition + 1,
1928 static_cast<uint64_t>(params.written) * BLOCKSIZE));
1929 updater->WriteToCommandPipe(
1930 android::base::StringPrintf("log bytes_stashed_%s: %" PRIu64, partition + 1,
1931 static_cast<uint64_t>(params.stashed) * BLOCKSIZE),
1932 true);
Tianjie Xu5450c842017-10-18 13:15:21 -07001933 }
1934 // Delete stash only after successfully completing the update, as it may contain blocks needed
1935 // to complete the update later.
1936 DeleteStash(params.stashbase);
Tianjie Xu284752e2017-12-05 11:04:17 -08001937 DeleteLastCommandFile();
Tao Bao864c6682018-05-07 11:38:25 -07001938
1939 // Create a marker on /cache partition, which allows skipping the update on this partition on
1940 // retry. The marker will be removed once booting into normal boot, or before starting next
1941 // fresh install.
Yifan Hong8ff84d72018-12-19 16:21:55 -08001942 if (!SetUpdatedMarker(updated_marker)) {
Tao Bao864c6682018-05-07 11:38:25 -07001943 LOG(WARNING) << "Failed to set updated marker; continuing";
1944 }
Tianjie Xu5450c842017-10-18 13:15:21 -07001945 }
1946
1947 pthread_mutex_destroy(&params.nti.mu);
1948 pthread_cond_destroy(&params.nti.cv);
1949 } else if (rc == 0) {
1950 LOG(INFO) << "verified partition contents; update may be resumed";
1951 }
1952
Tianjie Xu22f11202018-08-27 10:50:31 -07001953 if (fsync(params.fd) == -1) {
1954 failure_type = errno == EIO ? kEioFailure : kFsyncFailure;
Tao Bao33567772017-03-13 14:57:34 -07001955 PLOG(ERROR) << "fsync failed";
1956 }
1957 // params.fd will be automatically closed because it's a unique_fd.
1958
Tianjie Xu107a34f2017-06-29 17:04:21 -07001959 if (params.nti.brotli_decoder_state != nullptr) {
1960 BrotliDecoderDestroyInstance(params.nti.brotli_decoder_state);
1961 }
1962
Tianjie Xu284752e2017-12-05 11:04:17 -08001963 // Delete the last command file if the update cannot be resumed.
1964 if (params.isunresumable) {
1965 DeleteLastCommandFile();
1966 }
1967
Tao Bao33567772017-03-13 14:57:34 -07001968 // Only delete the stash if the update cannot be resumed, or it's a verification run and we
1969 // created the stash.
1970 if (params.isunresumable || (!params.canwrite && params.createdstash)) {
1971 DeleteStash(params.stashbase);
1972 }
1973
1974 if (failure_type != kNoCause && state->cause_code == kNoCause) {
1975 state->cause_code = failure_type;
1976 }
1977
1978 return StringValue(rc == 0 ? "t" : "");
Sami Tolvanen90221202014-12-09 16:39:47 +00001979}
1980
Tao Bao33567772017-03-13 14:57:34 -07001981/**
1982 * The transfer list is a text file containing commands to transfer data from one place to another
1983 * on the target partition. We parse it and execute the commands in order:
1984 *
1985 * zero [rangeset]
1986 * - Fill the indicated blocks with zeros.
1987 *
1988 * new [rangeset]
1989 * - Fill the blocks with data read from the new_data file.
1990 *
1991 * erase [rangeset]
1992 * - Mark the given blocks as empty.
1993 *
1994 * move <...>
1995 * bsdiff <patchstart> <patchlen> <...>
1996 * imgdiff <patchstart> <patchlen> <...>
1997 * - Read the source blocks, apply a patch (or not in the case of move), write result to target
1998 * blocks. bsdiff or imgdiff specifies the type of patch; move means no patch at all.
1999 *
2000 * See the comments in LoadSrcTgtVersion3() for a description of the <...> format.
2001 *
2002 * stash <stash_id> <src_range>
2003 * - Load the given source range and stash the data in the given slot of the stash table.
2004 *
2005 * free <stash_id>
2006 * - Free the given stash data.
2007 *
2008 * The creator of the transfer list will guarantee that no block is read (ie, used as the source for
2009 * a patch or move) after it has been written.
2010 *
2011 * The creator will guarantee that a given stash is loaded (with a stash command) before it's used
2012 * in a move/bsdiff/imgdiff command.
2013 *
2014 * Within one command the source and target ranges may overlap so in general we need to read the
2015 * entire source into memory before writing anything to the target blocks.
2016 *
2017 * All the patch data is concatenated into one patch_data file in the update package. It must be
2018 * stored uncompressed because we memory-map it in directly from the archive. (Since patches are
2019 * already compressed, we lose very little by not compressing their concatenation.)
2020 *
2021 * Commands that read data from the partition (i.e. move/bsdiff/imgdiff/stash) have one or more
2022 * additional hashes before the range parameters, which are used to check if the command has already
2023 * been completed and verify the integrity of the source data.
2024 */
Tianjie Xuc4447322017-03-06 14:44:59 -08002025Value* BlockImageVerifyFn(const char* name, State* state,
2026 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc3901232018-05-21 16:05:56 -07002027 // Commands which are not allowed are set to nullptr to skip them completely.
2028 const CommandMap command_map{
2029 // clang-format off
Tianjie Xu69ffa152018-08-01 16:40:00 -07002030 { Command::Type::ABORT, PerformCommandAbort },
2031 { Command::Type::BSDIFF, PerformCommandDiff },
Tianjie Xu3fda5d62019-05-09 10:58:10 -07002032 { Command::Type::COMPUTE_HASH_TREE, nullptr },
Tianjie Xu69ffa152018-08-01 16:40:00 -07002033 { Command::Type::ERASE, nullptr },
2034 { Command::Type::FREE, PerformCommandFree },
2035 { Command::Type::IMGDIFF, PerformCommandDiff },
2036 { Command::Type::MOVE, PerformCommandMove },
2037 { Command::Type::NEW, nullptr },
2038 { Command::Type::STASH, PerformCommandStash },
2039 { Command::Type::ZERO, nullptr },
Tao Baoc3901232018-05-21 16:05:56 -07002040 // clang-format on
2041 };
2042 CHECK_EQ(static_cast<size_t>(Command::Type::LAST), command_map.size());
Sami Tolvanen90221202014-12-09 16:39:47 +00002043
Tao Baoc3901232018-05-21 16:05:56 -07002044 // Perform a dry run without writing to test if an update can proceed.
2045 return PerformBlockImageUpdate(name, state, argv, command_map, true);
Sami Tolvanen90221202014-12-09 16:39:47 +00002046}
2047
Tianjie Xuc4447322017-03-06 14:44:59 -08002048Value* BlockImageUpdateFn(const char* name, State* state,
2049 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc3901232018-05-21 16:05:56 -07002050 const CommandMap command_map{
2051 // clang-format off
Tianjie Xu69ffa152018-08-01 16:40:00 -07002052 { Command::Type::ABORT, PerformCommandAbort },
2053 { Command::Type::BSDIFF, PerformCommandDiff },
2054 { Command::Type::COMPUTE_HASH_TREE, PerformCommandComputeHashTree },
2055 { Command::Type::ERASE, PerformCommandErase },
2056 { Command::Type::FREE, PerformCommandFree },
2057 { Command::Type::IMGDIFF, PerformCommandDiff },
2058 { Command::Type::MOVE, PerformCommandMove },
2059 { Command::Type::NEW, PerformCommandNew },
2060 { Command::Type::STASH, PerformCommandStash },
2061 { Command::Type::ZERO, PerformCommandZero },
Tao Baoc3901232018-05-21 16:05:56 -07002062 // clang-format on
2063 };
2064 CHECK_EQ(static_cast<size_t>(Command::Type::LAST), command_map.size());
Sami Tolvanen90221202014-12-09 16:39:47 +00002065
Tao Baoc3901232018-05-21 16:05:56 -07002066 return PerformBlockImageUpdate(name, state, argv, command_map, false);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07002067}
2068
Tianjie Xuc4447322017-03-06 14:44:59 -08002069Value* RangeSha1Fn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002070 if (argv.size() != 2) {
2071 ErrorAbort(state, kArgsParsingFailure, "range_sha1 expects 2 arguments, got %zu", argv.size());
2072 return StringValue("");
2073 }
2074
2075 std::vector<std::unique_ptr<Value>> args;
2076 if (!ReadValueArgs(state, argv, &args)) {
2077 return nullptr;
2078 }
2079
2080 const std::unique_ptr<Value>& blockdev_filename = args[0];
2081 const std::unique_ptr<Value>& ranges = args[1];
2082
Tao Bao511d7592018-06-19 15:56:49 -07002083 if (blockdev_filename->type != Value::Type::STRING) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002084 ErrorAbort(state, kArgsParsingFailure, "blockdev_filename argument to %s must be string", name);
2085 return StringValue("");
2086 }
Tao Bao511d7592018-06-19 15:56:49 -07002087 if (ranges->type != Value::Type::STRING) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002088 ErrorAbort(state, kArgsParsingFailure, "ranges argument to %s must be string", name);
2089 return StringValue("");
2090 }
2091
Tianjie Xu1536db82019-05-14 10:54:43 -07002092 auto block_device_path = state->updater->FindBlockDeviceName(blockdev_filename->data);
2093 if (block_device_path.empty()) {
2094 LOG(ERROR) << "Block device path for " << blockdev_filename->data << " not found. " << name
2095 << " failed.";
2096 return StringValue("");
2097 }
2098
2099 android::base::unique_fd fd(open(block_device_path.c_str(), O_RDWR));
Tao Baoc97edcb2017-03-31 01:18:13 -07002100 if (fd == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -07002101 CauseCode cause_code = errno == EIO ? kEioFailure : kFileOpenFailure;
Tianjie Xu1536db82019-05-14 10:54:43 -07002102 ErrorAbort(state, cause_code, "open \"%s\" failed: %s", block_device_path.c_str(),
Tao Baoc97edcb2017-03-31 01:18:13 -07002103 strerror(errno));
2104 return StringValue("");
2105 }
2106
2107 RangeSet rs = RangeSet::Parse(ranges->data);
Tao Bao67983152017-11-04 00:08:08 -07002108 CHECK(static_cast<bool>(rs));
Tao Baoc97edcb2017-03-31 01:18:13 -07002109
2110 SHA_CTX ctx;
2111 SHA1_Init(&ctx);
2112
2113 std::vector<uint8_t> buffer(BLOCKSIZE);
Tao Bao43bfa6e2018-08-28 10:09:13 -07002114 for (const auto& [begin, end] : rs) {
2115 if (!check_lseek(fd, static_cast<off64_t>(begin) * BLOCKSIZE, SEEK_SET)) {
Tianjie Xu1536db82019-05-14 10:54:43 -07002116 ErrorAbort(state, kLseekFailure, "failed to seek %s: %s", block_device_path.c_str(),
Tao Baoc97edcb2017-03-31 01:18:13 -07002117 strerror(errno));
2118 return StringValue("");
2119 }
2120
Tao Bao43bfa6e2018-08-28 10:09:13 -07002121 for (size_t j = begin; j < end; ++j) {
Tianjie Xu22f11202018-08-27 10:50:31 -07002122 if (!android::base::ReadFully(fd, buffer.data(), BLOCKSIZE)) {
2123 CauseCode cause_code = errno == EIO ? kEioFailure : kFreadFailure;
Tianjie Xu1536db82019-05-14 10:54:43 -07002124 ErrorAbort(state, cause_code, "failed to read %s: %s", block_device_path.c_str(),
Tao Baoc97edcb2017-03-31 01:18:13 -07002125 strerror(errno));
Tianjie Xuc4447322017-03-06 14:44:59 -08002126 return StringValue("");
Tao Baoc97edcb2017-03-31 01:18:13 -07002127 }
2128
2129 SHA1_Update(&ctx, buffer.data(), BLOCKSIZE);
Tianjie Xuc4447322017-03-06 14:44:59 -08002130 }
Tao Baoc97edcb2017-03-31 01:18:13 -07002131 }
2132 uint8_t digest[SHA_DIGEST_LENGTH];
2133 SHA1_Final(digest, &ctx);
Tianjie Xuc4447322017-03-06 14:44:59 -08002134
Tao Baoc97edcb2017-03-31 01:18:13 -07002135 return StringValue(print_sha1(digest));
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07002136}
2137
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002138// This function checks if a device has been remounted R/W prior to an incremental
2139// OTA update. This is an common cause of update abortion. The function reads the
2140// 1st block of each partition and check for mounting time/count. It return string "t"
2141// if executes successfully and an empty string otherwise.
2142
Tianjie Xuc4447322017-03-06 14:44:59 -08002143Value* CheckFirstBlockFn(const char* name, State* state,
2144 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002145 if (argv.size() != 1) {
2146 ErrorAbort(state, kArgsParsingFailure, "check_first_block expects 1 argument, got %zu",
2147 argv.size());
2148 return StringValue("");
2149 }
Tianjie Xuc4447322017-03-06 14:44:59 -08002150
Tao Baoc97edcb2017-03-31 01:18:13 -07002151 std::vector<std::unique_ptr<Value>> args;
2152 if (!ReadValueArgs(state, argv, &args)) {
2153 return nullptr;
2154 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002155
Tao Baoc97edcb2017-03-31 01:18:13 -07002156 const std::unique_ptr<Value>& arg_filename = args[0];
Tianjie Xu5fe280a2016-10-17 18:15:20 -07002157
Tao Bao511d7592018-06-19 15:56:49 -07002158 if (arg_filename->type != Value::Type::STRING) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002159 ErrorAbort(state, kArgsParsingFailure, "filename argument to %s must be string", name);
2160 return StringValue("");
2161 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002162
Tianjie Xu1536db82019-05-14 10:54:43 -07002163 auto block_device_path = state->updater->FindBlockDeviceName(arg_filename->data);
2164 if (block_device_path.empty()) {
2165 LOG(ERROR) << "Block device path for " << arg_filename->data << " not found. " << name
2166 << " failed.";
2167 return StringValue("");
2168 }
2169
2170 android::base::unique_fd fd(open(block_device_path.c_str(), O_RDONLY));
Tao Baoc97edcb2017-03-31 01:18:13 -07002171 if (fd == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -07002172 CauseCode cause_code = errno == EIO ? kEioFailure : kFileOpenFailure;
Tianjie Xu1536db82019-05-14 10:54:43 -07002173 ErrorAbort(state, cause_code, "open \"%s\" failed: %s", block_device_path.c_str(),
Tao Baoc97edcb2017-03-31 01:18:13 -07002174 strerror(errno));
2175 return StringValue("");
2176 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002177
Tao Baobf5b77d2017-03-30 16:57:29 -07002178 RangeSet blk0(std::vector<Range>{ Range{ 0, 1 } });
Tao Baoc97edcb2017-03-31 01:18:13 -07002179 std::vector<uint8_t> block0_buffer(BLOCKSIZE);
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002180
Tao Baode3bbb82018-05-30 16:14:14 -07002181 if (ReadBlocks(blk0, &block0_buffer, fd) == -1) {
Tianjie Xu22f11202018-08-27 10:50:31 -07002182 CauseCode cause_code = errno == EIO ? kEioFailure : kFreadFailure;
Tianjie Xu1536db82019-05-14 10:54:43 -07002183 ErrorAbort(state, cause_code, "failed to read %s: %s", block_device_path.c_str(),
Tao Baoc97edcb2017-03-31 01:18:13 -07002184 strerror(errno));
2185 return StringValue("");
2186 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002187
Tao Baoc97edcb2017-03-31 01:18:13 -07002188 // https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout
2189 // Super block starts from block 0, offset 0x400
2190 // 0x2C: len32 Mount time
2191 // 0x30: len32 Write time
2192 // 0x34: len16 Number of mounts since the last fsck
2193 // 0x38: len16 Magic signature 0xEF53
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002194
Tao Baoc97edcb2017-03-31 01:18:13 -07002195 time_t mount_time = *reinterpret_cast<uint32_t*>(&block0_buffer[0x400 + 0x2C]);
2196 uint16_t mount_count = *reinterpret_cast<uint16_t*>(&block0_buffer[0x400 + 0x34]);
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002197
Tao Baoc97edcb2017-03-31 01:18:13 -07002198 if (mount_count > 0) {
Tianjie Xu1536db82019-05-14 10:54:43 -07002199 state->updater->UiPrint(
Tianjie Xu58d59122019-05-03 01:05:04 -07002200 android::base::StringPrintf("Device was remounted R/W %" PRIu16 " times", mount_count));
Tianjie Xu1536db82019-05-14 10:54:43 -07002201 state->updater->UiPrint(
Tianjie Xu58d59122019-05-03 01:05:04 -07002202 android::base::StringPrintf("Last remount happened on %s", ctime(&mount_time)));
Tao Baoc97edcb2017-03-31 01:18:13 -07002203 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002204
Tao Baoc97edcb2017-03-31 01:18:13 -07002205 return StringValue("t");
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002206}
2207
Tianjie Xuc4447322017-03-06 14:44:59 -08002208Value* BlockImageRecoverFn(const char* name, State* state,
2209 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002210 if (argv.size() != 2) {
2211 ErrorAbort(state, kArgsParsingFailure, "block_image_recover expects 2 arguments, got %zu",
2212 argv.size());
2213 return StringValue("");
2214 }
2215
2216 std::vector<std::unique_ptr<Value>> args;
2217 if (!ReadValueArgs(state, argv, &args)) {
2218 return nullptr;
2219 }
2220
2221 const std::unique_ptr<Value>& filename = args[0];
2222 const std::unique_ptr<Value>& ranges = args[1];
2223
Tao Bao511d7592018-06-19 15:56:49 -07002224 if (filename->type != Value::Type::STRING) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002225 ErrorAbort(state, kArgsParsingFailure, "filename argument to %s must be string", name);
2226 return StringValue("");
2227 }
Tao Bao511d7592018-06-19 15:56:49 -07002228 if (ranges->type != Value::Type::STRING) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002229 ErrorAbort(state, kArgsParsingFailure, "ranges argument to %s must be string", name);
2230 return StringValue("");
2231 }
Tao Bao67983152017-11-04 00:08:08 -07002232 RangeSet rs = RangeSet::Parse(ranges->data);
2233 if (!rs) {
2234 ErrorAbort(state, kArgsParsingFailure, "failed to parse ranges: %s", ranges->data.c_str());
2235 return StringValue("");
2236 }
Tao Baoc97edcb2017-03-31 01:18:13 -07002237
Tianjie Xu1536db82019-05-14 10:54:43 -07002238 auto block_device_path = state->updater->FindBlockDeviceName(filename->data);
2239 if (block_device_path.empty()) {
2240 LOG(ERROR) << "Block device path for " << filename->data << " not found. " << name
2241 << " failed.";
2242 return StringValue("");
2243 }
2244
Tao Baoc97edcb2017-03-31 01:18:13 -07002245 // Output notice to log when recover is attempted
Tianjie Xu1536db82019-05-14 10:54:43 -07002246 LOG(INFO) << block_device_path << " image corrupted, attempting to recover...";
Tao Baoc97edcb2017-03-31 01:18:13 -07002247
2248 // When opened with O_RDWR, libfec rewrites corrupted blocks when they are read
Tianjie Xu1536db82019-05-14 10:54:43 -07002249 fec::io fh(block_device_path, O_RDWR);
Tao Baoc97edcb2017-03-31 01:18:13 -07002250
2251 if (!fh) {
Tianjie Xu1536db82019-05-14 10:54:43 -07002252 ErrorAbort(state, kLibfecFailure, "fec_open \"%s\" failed: %s", block_device_path.c_str(),
Tao Baoc97edcb2017-03-31 01:18:13 -07002253 strerror(errno));
2254 return StringValue("");
2255 }
2256
2257 if (!fh.has_ecc() || !fh.has_verity()) {
2258 ErrorAbort(state, kLibfecFailure, "unable to use metadata to correct errors");
2259 return StringValue("");
2260 }
2261
2262 fec_status status;
Tao Baoc97edcb2017-03-31 01:18:13 -07002263 if (!fh.get_status(status)) {
2264 ErrorAbort(state, kLibfecFailure, "failed to read FEC status");
2265 return StringValue("");
2266 }
2267
Tao Baoc97edcb2017-03-31 01:18:13 -07002268 uint8_t buffer[BLOCKSIZE];
Tao Bao43bfa6e2018-08-28 10:09:13 -07002269 for (const auto& [begin, end] : rs) {
2270 for (size_t j = begin; j < end; ++j) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002271 // Stay within the data area, libfec validates and corrects metadata
Tao Baobf5b77d2017-03-30 16:57:29 -07002272 if (status.data_size <= static_cast<uint64_t>(j) * BLOCKSIZE) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002273 continue;
2274 }
2275
Tao Baobf5b77d2017-03-30 16:57:29 -07002276 if (fh.pread(buffer, BLOCKSIZE, static_cast<off64_t>(j) * BLOCKSIZE) != BLOCKSIZE) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002277 ErrorAbort(state, kLibfecFailure, "failed to recover %s (block %zu): %s",
Tianjie Xu1536db82019-05-14 10:54:43 -07002278 block_device_path.c_str(), j, strerror(errno));
Tianjie Xuc4447322017-03-06 14:44:59 -08002279 return StringValue("");
Tao Baoc97edcb2017-03-31 01:18:13 -07002280 }
2281
2282 // If we want to be able to recover from a situation where rewriting a corrected
2283 // block doesn't guarantee the same data will be returned when re-read later, we
2284 // can save a copy of corrected blocks to /cache. Note:
2285 //
2286 // 1. Maximum space required from /cache is the same as the maximum number of
2287 // corrupted blocks we can correct. For RS(255, 253) and a 2 GiB partition,
2288 // this would be ~16 MiB, for example.
2289 //
2290 // 2. To find out if this block was corrupted, call fec_get_status after each
2291 // read and check if the errors field value has increased.
Tianjie Xuc4447322017-03-06 14:44:59 -08002292 }
Tao Baoc97edcb2017-03-31 01:18:13 -07002293 }
Tianjie Xu1536db82019-05-14 10:54:43 -07002294 LOG(INFO) << "..." << block_device_path << " image recovered successfully.";
Tao Baoc97edcb2017-03-31 01:18:13 -07002295 return StringValue("t");
Sami Tolvanen0a7b4732015-06-25 10:25:36 +01002296}
2297
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07002298void RegisterBlockImageFunctions() {
Tao Baoc97edcb2017-03-31 01:18:13 -07002299 RegisterFunction("block_image_verify", BlockImageVerifyFn);
2300 RegisterFunction("block_image_update", BlockImageUpdateFn);
2301 RegisterFunction("block_image_recover", BlockImageRecoverFn);
2302 RegisterFunction("check_first_block", CheckFirstBlockFn);
2303 RegisterFunction("range_sha1", RangeSha1Fn);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07002304}