blob: 4adb974cb67c5829d463ebf7d749b33d41166ede [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>
45#include <android-base/strings.h>
Elliott Hughesbcabd092016-03-22 20:19:22 -070046#include <android-base/unique_fd.h>
Tao Bao51412212016-12-28 14:44:05 -080047#include <applypatch/applypatch.h>
Tianjie Xu107a34f2017-06-29 17:04:21 -070048#include <brotli/decode.h>
Tao Bao641fa972018-04-25 18:59:40 -070049#include <fec/io.h>
Tao Bao51412212016-12-28 14:44:05 -080050#include <openssl/sha.h>
Tianjie Xua946b9e2017-03-21 16:24:57 -070051#include <private/android_filesystem_config.h>
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070052#include <ziparchive/zip_archive.h>
Tao Baoe6aa3322015-08-05 15:20:27 -070053
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070054#include "edify/expr.h"
Tao Baod33b2f82017-09-28 21:29:11 -070055#include "otafault/ota_io.h"
Tao Bao1fc5bf32017-10-06 07:43:41 -070056#include "otautil/error_code.h"
Tao Bao641fa972018-04-25 18:59:40 -070057#include "otautil/paths.h"
Tao Bao09e468f2017-09-29 14:39:33 -070058#include "otautil/print_sha1.h"
59#include "otautil/rangeset.h"
Tao Baoc3901232018-05-21 16:05:56 -070060#include "private/commands.h"
Tao Bao8f237572017-03-26 13:36:49 -070061#include "updater/install.h"
Tao Bao0c7839a2016-10-10 15:48:37 -070062#include "updater/updater.h"
Doug Zongkerbc7ffed2014-08-15 14:31:52 -070063
Sami Tolvanene82fa182015-06-10 15:58:12 +000064// Set this to 0 to interpret 'erase' transfers to mean do a
65// BLKDISCARD ioctl (the normal behavior). Set to 1 to interpret
66// erase to mean fill the region with zeroes.
67#define DEBUG_ERASE 0
68
Tao Bao51412212016-12-28 14:44:05 -080069static constexpr size_t BLOCKSIZE = 4096;
Tao Bao51412212016-12-28 14:44:05 -080070static constexpr mode_t STASH_DIRECTORY_MODE = 0700;
71static constexpr mode_t STASH_FILE_MODE = 0600;
Sami Tolvanen90221202014-12-09 16:39:47 +000072
Tianjie Xu16255832016-04-30 11:49:59 -070073static CauseCode failure_type = kNoCause;
Tianjie Xu7ce287d2016-05-31 09:29:49 -070074static bool is_retry = false;
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -070075static std::unordered_map<std::string, RangeSet> stash_map;
Tianjie Xu7eca97e2016-03-22 18:08:12 -070076
Tianjie Xu284752e2017-12-05 11:04:17 -080077static void DeleteLastCommandFile() {
Tao Bao641fa972018-04-25 18:59:40 -070078 const std::string& last_command_file = Paths::Get().last_command_file();
Tianjie Xu284752e2017-12-05 11:04:17 -080079 if (unlink(last_command_file.c_str()) == -1 && errno != ENOENT) {
80 PLOG(ERROR) << "Failed to unlink: " << last_command_file;
81 }
82}
83
84// Parse the last command index of the last update and save the result to |last_command_index|.
85// Return true if we successfully read the index.
Tao Bao26efb0a2018-05-21 14:59:55 -070086static bool ParseLastCommandFile(size_t* last_command_index) {
Tao Bao641fa972018-04-25 18:59:40 -070087 const std::string& last_command_file = Paths::Get().last_command_file();
Tianjie Xu284752e2017-12-05 11:04:17 -080088 android::base::unique_fd fd(TEMP_FAILURE_RETRY(open(last_command_file.c_str(), O_RDONLY)));
89 if (fd == -1) {
90 if (errno != ENOENT) {
91 PLOG(ERROR) << "Failed to open " << last_command_file;
92 return false;
93 }
94
95 LOG(INFO) << last_command_file << " doesn't exist.";
96 return false;
97 }
98
99 // Now that the last_command file exists, parse the last command index of previous update.
100 std::string content;
101 if (!android::base::ReadFdToString(fd.get(), &content)) {
102 LOG(ERROR) << "Failed to read: " << last_command_file;
103 return false;
104 }
105
106 std::vector<std::string> lines = android::base::Split(android::base::Trim(content), "\n");
107 if (lines.size() != 2) {
108 LOG(ERROR) << "Unexpected line counts in last command file: " << content;
109 return false;
110 }
111
112 if (!android::base::ParseInt(lines[0], last_command_index)) {
113 LOG(ERROR) << "Failed to parse integer in: " << lines[0];
114 return false;
115 }
116
117 return true;
118}
119
Tao Bao864c6682018-05-07 11:38:25 -0700120static bool FsyncDir(const std::string& dirname) {
121 android::base::unique_fd dfd(
122 TEMP_FAILURE_RETRY(ota_open(dirname.c_str(), O_RDONLY | O_DIRECTORY)));
123 if (dfd == -1) {
124 failure_type = kFileOpenFailure;
125 PLOG(ERROR) << "Failed to open " << dirname;
126 return false;
127 }
128 if (fsync(dfd) == -1) {
129 failure_type = kFsyncFailure;
130 PLOG(ERROR) << "Failed to fsync " << dirname;
131 return false;
132 }
133 return true;
134}
135
Tianjie Xuc2b2bb52018-05-15 15:09:59 -0700136// Update the last executed command index in the last_command_file.
Tao Bao26efb0a2018-05-21 14:59:55 -0700137static bool UpdateLastCommandIndex(size_t command_index, const std::string& command_string) {
Tao Bao641fa972018-04-25 18:59:40 -0700138 const std::string& last_command_file = Paths::Get().last_command_file();
Tianjie Xu284752e2017-12-05 11:04:17 -0800139 std::string last_command_tmp = last_command_file + ".tmp";
140 std::string content = std::to_string(command_index) + "\n" + command_string;
141 android::base::unique_fd wfd(
142 TEMP_FAILURE_RETRY(open(last_command_tmp.c_str(), O_WRONLY | O_CREAT | O_TRUNC, 0660)));
143 if (wfd == -1 || !android::base::WriteStringToFd(content, wfd)) {
144 PLOG(ERROR) << "Failed to update last command";
145 return false;
146 }
147
148 if (fsync(wfd) == -1) {
149 PLOG(ERROR) << "Failed to fsync " << last_command_tmp;
150 return false;
151 }
152
153 if (chown(last_command_tmp.c_str(), AID_SYSTEM, AID_SYSTEM) == -1) {
154 PLOG(ERROR) << "Failed to change owner for " << last_command_tmp;
155 return false;
156 }
157
158 if (rename(last_command_tmp.c_str(), last_command_file.c_str()) == -1) {
159 PLOG(ERROR) << "Failed to rename" << last_command_tmp;
160 return false;
161 }
162
Tao Bao864c6682018-05-07 11:38:25 -0700163 if (!FsyncDir(android::base::Dirname(last_command_file))) {
Tianjie Xu284752e2017-12-05 11:04:17 -0800164 return false;
165 }
166
Tao Bao864c6682018-05-07 11:38:25 -0700167 return true;
168}
169
170static bool SetPartitionUpdatedMarker(const std::string& marker) {
171 if (!android::base::WriteStringToFile("", marker)) {
172 PLOG(ERROR) << "Failed to write to marker file " << marker;
Tianjie Xu284752e2017-12-05 11:04:17 -0800173 return false;
174 }
Tao Bao864c6682018-05-07 11:38:25 -0700175 if (!FsyncDir(android::base::Dirname(marker))) {
176 return false;
177 }
178 LOG(INFO) << "Wrote partition updated marker to " << marker;
Tianjie Xu284752e2017-12-05 11:04:17 -0800179 return true;
180}
181
Sami Tolvanen90221202014-12-09 16:39:47 +0000182static int read_all(int fd, uint8_t* data, size_t size) {
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700183 size_t so_far = 0;
184 while (so_far < size) {
Jed Estepa7b9a462015-12-15 16:04:53 -0800185 ssize_t r = TEMP_FAILURE_RETRY(ota_read(fd, data+so_far, size-so_far));
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700186 if (r == -1) {
Tianjie Xu16255832016-04-30 11:49:59 -0700187 failure_type = kFreadFailure;
Tao Bao039f2da2016-11-22 16:29:50 -0800188 PLOG(ERROR) << "read failed";
Sami Tolvanen90221202014-12-09 16:39:47 +0000189 return -1;
Tianjie Xu71e182b2016-08-31 18:06:33 -0700190 } else if (r == 0) {
191 failure_type = kFreadFailure;
Tao Bao039f2da2016-11-22 16:29:50 -0800192 LOG(ERROR) << "read reached unexpected EOF.";
Tianjie Xu71e182b2016-08-31 18:06:33 -0700193 return -1;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700194 }
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700195 so_far += r;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700196 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000197 return 0;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700198}
199
Tao Bao612336d2015-08-27 16:41:21 -0700200static int read_all(int fd, std::vector<uint8_t>& buffer, size_t size) {
201 return read_all(fd, buffer.data(), size);
202}
203
Sami Tolvanen90221202014-12-09 16:39:47 +0000204static int write_all(int fd, const uint8_t* data, size_t size) {
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700205 size_t written = 0;
206 while (written < size) {
Jed Estepa7b9a462015-12-15 16:04:53 -0800207 ssize_t w = TEMP_FAILURE_RETRY(ota_write(fd, data+written, size-written));
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700208 if (w == -1) {
Tianjie Xu16255832016-04-30 11:49:59 -0700209 failure_type = kFwriteFailure;
Tao Bao039f2da2016-11-22 16:29:50 -0800210 PLOG(ERROR) << "write failed";
Sami Tolvanen90221202014-12-09 16:39:47 +0000211 return -1;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700212 }
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700213 written += w;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700214 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000215
Sami Tolvanen90221202014-12-09 16:39:47 +0000216 return 0;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700217}
218
Tao Bao612336d2015-08-27 16:41:21 -0700219static int write_all(int fd, const std::vector<uint8_t>& buffer, size_t size) {
220 return write_all(fd, buffer.data(), size);
221}
222
Tianjie Xu7ce287d2016-05-31 09:29:49 -0700223static bool discard_blocks(int fd, off64_t offset, uint64_t size) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700224 // Don't discard blocks unless the update is a retry run.
225 if (!is_retry) {
Tianjie Xu7ce287d2016-05-31 09:29:49 -0700226 return true;
Tao Baobf5b77d2017-03-30 16:57:29 -0700227 }
228
229 uint64_t args[2] = { static_cast<uint64_t>(offset), size };
230 if (ioctl(fd, BLKDISCARD, &args) == -1) {
231 PLOG(ERROR) << "BLKDISCARD ioctl failed";
232 return false;
233 }
234 return true;
Tianjie Xu7ce287d2016-05-31 09:29:49 -0700235}
236
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700237static bool check_lseek(int fd, off64_t offset, int whence) {
238 off64_t rc = TEMP_FAILURE_RETRY(lseek64(fd, offset, whence));
239 if (rc == -1) {
Tianjie Xu16255832016-04-30 11:49:59 -0700240 failure_type = kLseekFailure;
Tao Bao039f2da2016-11-22 16:29:50 -0800241 PLOG(ERROR) << "lseek64 failed";
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700242 return false;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700243 }
Elliott Hughes7bad7c42015-04-28 17:24:24 -0700244 return true;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700245}
246
Tao Bao612336d2015-08-27 16:41:21 -0700247static void allocate(size_t size, std::vector<uint8_t>& buffer) {
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700248 // if the buffer's big enough, reuse it.
Tao Bao612336d2015-08-27 16:41:21 -0700249 if (size <= buffer.size()) return;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700250
Tao Bao612336d2015-08-27 16:41:21 -0700251 buffer.resize(size);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700252}
253
Tao Bao60a70af2017-03-26 14:03:52 -0700254/**
255 * RangeSinkWriter reads data from the given FD, and writes them to the destination specified by the
256 * given RangeSet.
257 */
258class RangeSinkWriter {
259 public:
260 RangeSinkWriter(int fd, const RangeSet& tgt)
Tianjie Xu107a34f2017-06-29 17:04:21 -0700261 : fd_(fd),
262 tgt_(tgt),
263 next_range_(0),
264 current_range_left_(0),
265 bytes_written_(0) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700266 CHECK_NE(tgt.size(), static_cast<size_t>(0));
Tao Bao60a70af2017-03-26 14:03:52 -0700267 };
Tao Bao0940fe12015-08-27 16:41:21 -0700268
Tao Bao60a70af2017-03-26 14:03:52 -0700269 bool Finished() const {
Tao Baobf5b77d2017-03-30 16:57:29 -0700270 return next_range_ == tgt_.size() && current_range_left_ == 0;
Tao Baof7eb7602017-03-27 15:12:48 -0700271 }
272
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700273 size_t AvailableSpace() const {
274 return tgt_.blocks() * BLOCKSIZE - bytes_written_;
275 }
276
277 // Return number of bytes written; and 0 indicates a writing failure.
278 size_t Write(const uint8_t* data, size_t size) {
Tao Bao60a70af2017-03-26 14:03:52 -0700279 if (Finished()) {
280 LOG(ERROR) << "range sink write overrun; can't write " << size << " bytes";
281 return 0;
Tao Baof7eb7602017-03-27 15:12:48 -0700282 }
283
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700284 size_t written = 0;
Tao Bao60a70af2017-03-26 14:03:52 -0700285 while (size > 0) {
286 // Move to the next range as needed.
Tianjie Xu107a34f2017-06-29 17:04:21 -0700287 if (!SeekToOutputRange()) {
288 break;
Tao Bao60a70af2017-03-26 14:03:52 -0700289 }
Tao Baof7eb7602017-03-27 15:12:48 -0700290
Tao Bao60a70af2017-03-26 14:03:52 -0700291 size_t write_now = size;
292 if (current_range_left_ < write_now) {
293 write_now = current_range_left_;
294 }
Tao Baof7eb7602017-03-27 15:12:48 -0700295
Tao Bao60a70af2017-03-26 14:03:52 -0700296 if (write_all(fd_, data, write_now) == -1) {
Tao Baof7eb7602017-03-27 15:12:48 -0700297 break;
298 }
Tao Bao60a70af2017-03-26 14:03:52 -0700299
300 data += write_now;
301 size -= write_now;
302
303 current_range_left_ -= write_now;
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700304 written += write_now;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700305 }
Tao Bao60a70af2017-03-26 14:03:52 -0700306
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700307 bytes_written_ += written;
308 return written;
Tao Baof7eb7602017-03-27 15:12:48 -0700309 }
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700310
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700311 size_t BytesWritten() const {
312 return bytes_written_;
313 }
314
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700315 private:
Tianjie Xu107a34f2017-06-29 17:04:21 -0700316 // Set up the output cursor, move to next range if needed.
317 bool SeekToOutputRange() {
318 // We haven't finished the current range yet.
319 if (current_range_left_ != 0) {
320 return true;
321 }
322 // We can't write any more; let the write function return how many bytes have been written
323 // so far.
324 if (next_range_ >= tgt_.size()) {
325 return false;
326 }
327
328 const Range& range = tgt_[next_range_];
329 off64_t offset = static_cast<off64_t>(range.first) * BLOCKSIZE;
330 current_range_left_ = (range.second - range.first) * BLOCKSIZE;
331 next_range_++;
332
333 if (!discard_blocks(fd_, offset, current_range_left_)) {
334 return false;
335 }
336 if (!check_lseek(fd_, offset, SEEK_SET)) {
337 return false;
338 }
339 return true;
340 }
341
342 // The output file descriptor.
Tao Bao60a70af2017-03-26 14:03:52 -0700343 int fd_;
Tianjie Xu107a34f2017-06-29 17:04:21 -0700344 // The destination ranges for the data.
Tao Bao60a70af2017-03-26 14:03:52 -0700345 const RangeSet& tgt_;
346 // The next range that we should write to.
347 size_t next_range_;
348 // The number of bytes to write before moving to the next range.
349 size_t current_range_left_;
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700350 // Total bytes written by the writer.
351 size_t bytes_written_;
Tao Bao60a70af2017-03-26 14:03:52 -0700352};
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700353
Tao Bao60a70af2017-03-26 14:03:52 -0700354/**
355 * All of the data for all the 'new' transfers is contained in one file in the update package,
356 * concatenated together in the order in which transfers.list will need it. We want to stream it out
357 * of the archive (it's compressed) without writing it to a temp file, but we can't write each
358 * section until it's that transfer's turn to go.
359 *
360 * To achieve this, we expand the new data from the archive in a background thread, and block that
361 * threads 'receive uncompressed data' function until the main thread has reached a point where we
362 * want some new data to be written. We signal the background thread with the destination for the
363 * data and block the main thread, waiting for the background thread to complete writing that
364 * section. Then it signals the main thread to wake up and goes back to blocking waiting for a
365 * transfer.
366 *
367 * NewThreadInfo is the struct used to pass information back and forth between the two threads. When
368 * the main thread wants some data written, it sets writer to the destination location and signals
369 * the condition. When the background thread is done writing, it clears writer and signals the
370 * condition again.
371 */
Tao Bao0940fe12015-08-27 16:41:21 -0700372struct NewThreadInfo {
Tao Bao60a70af2017-03-26 14:03:52 -0700373 ZipArchiveHandle za;
374 ZipEntry entry;
Tianjie Xu107a34f2017-06-29 17:04:21 -0700375 bool brotli_compressed;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700376
Tianjie Xu107a34f2017-06-29 17:04:21 -0700377 std::unique_ptr<RangeSinkWriter> writer;
378 BrotliDecoderState* brotli_decoder_state;
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700379 bool receiver_available;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700380
Tao Bao60a70af2017-03-26 14:03:52 -0700381 pthread_mutex_t mu;
382 pthread_cond_t cv;
Tao Bao0940fe12015-08-27 16:41:21 -0700383};
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700384
Tianjie Xu8cf5c8f2016-09-08 20:10:11 -0700385static bool receive_new_data(const uint8_t* data, size_t size, void* cookie) {
Tao Bao60a70af2017-03-26 14:03:52 -0700386 NewThreadInfo* nti = static_cast<NewThreadInfo*>(cookie);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700387
Tao Bao60a70af2017-03-26 14:03:52 -0700388 while (size > 0) {
389 // Wait for nti->writer to be non-null, indicating some of this data is wanted.
390 pthread_mutex_lock(&nti->mu);
391 while (nti->writer == nullptr) {
Tianjie Xu5450c842017-10-18 13:15:21 -0700392 // End the new data receiver if we encounter an error when performing block image update.
393 if (!nti->receiver_available) {
394 pthread_mutex_unlock(&nti->mu);
395 return false;
396 }
Tao Bao60a70af2017-03-26 14:03:52 -0700397 pthread_cond_wait(&nti->cv, &nti->mu);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700398 }
Tao Bao60a70af2017-03-26 14:03:52 -0700399 pthread_mutex_unlock(&nti->mu);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700400
Tao Bao60a70af2017-03-26 14:03:52 -0700401 // At this point nti->writer is set, and we own it. The main thread is waiting for it to
402 // disappear from nti.
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700403 size_t write_now = std::min(size, nti->writer->AvailableSpace());
404 if (nti->writer->Write(data, write_now) != write_now) {
405 LOG(ERROR) << "Failed to write " << write_now << " bytes.";
Tianjie Xu107a34f2017-06-29 17:04:21 -0700406 return false;
407 }
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700408
409 data += write_now;
410 size -= write_now;
411
412 if (nti->writer->Finished()) {
413 // We have written all the bytes desired by this writer.
414
415 pthread_mutex_lock(&nti->mu);
416 nti->writer = nullptr;
417 pthread_cond_broadcast(&nti->cv);
418 pthread_mutex_unlock(&nti->mu);
419 }
420 }
421
422 return true;
423}
424
425static bool receive_brotli_new_data(const uint8_t* data, size_t size, void* cookie) {
426 NewThreadInfo* nti = static_cast<NewThreadInfo*>(cookie);
427
428 while (size > 0 || BrotliDecoderHasMoreOutput(nti->brotli_decoder_state)) {
429 // Wait for nti->writer to be non-null, indicating some of this data is wanted.
430 pthread_mutex_lock(&nti->mu);
431 while (nti->writer == nullptr) {
Tianjie Xu5450c842017-10-18 13:15:21 -0700432 // End the receiver if we encounter an error when performing block image update.
433 if (!nti->receiver_available) {
434 pthread_mutex_unlock(&nti->mu);
435 return false;
436 }
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700437 pthread_cond_wait(&nti->cv, &nti->mu);
438 }
439 pthread_mutex_unlock(&nti->mu);
440
441 // At this point nti->writer is set, and we own it. The main thread is waiting for it to
442 // disappear from nti.
443
444 size_t buffer_size = std::min<size_t>(32768, nti->writer->AvailableSpace());
445 if (buffer_size == 0) {
446 LOG(ERROR) << "No space left in output range";
447 return false;
448 }
449 uint8_t buffer[buffer_size];
450 size_t available_in = size;
451 size_t available_out = buffer_size;
452 uint8_t* next_out = buffer;
453
454 // The brotli decoder will update |data|, |available_in|, |next_out| and |available_out|.
455 BrotliDecoderResult result = BrotliDecoderDecompressStream(
456 nti->brotli_decoder_state, &available_in, &data, &available_out, &next_out, nullptr);
457
458 if (result == BROTLI_DECODER_RESULT_ERROR) {
459 LOG(ERROR) << "Decompression failed with "
460 << BrotliDecoderErrorString(BrotliDecoderGetErrorCode(nti->brotli_decoder_state));
461 return false;
462 }
463
464 LOG(DEBUG) << "bytes to write: " << buffer_size - available_out << ", bytes consumed "
465 << size - available_in << ", decoder status " << result;
466
467 size_t write_now = buffer_size - available_out;
468 if (nti->writer->Write(buffer, write_now) != write_now) {
469 LOG(ERROR) << "Failed to write " << write_now << " bytes.";
470 return false;
471 }
472
473 // Update the remaining size. The input data ptr is already updated by brotli decoder function.
474 size = available_in;
Tao Bao60a70af2017-03-26 14:03:52 -0700475
476 if (nti->writer->Finished()) {
477 // We have written all the bytes desired by this writer.
478
479 pthread_mutex_lock(&nti->mu);
480 nti->writer = nullptr;
481 pthread_cond_broadcast(&nti->cv);
482 pthread_mutex_unlock(&nti->mu);
483 }
484 }
485
486 return true;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700487}
488
489static void* unzip_new_data(void* cookie) {
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700490 NewThreadInfo* nti = static_cast<NewThreadInfo*>(cookie);
Tianjie Xu6ed175d2017-07-18 11:29:40 -0700491 if (nti->brotli_compressed) {
492 ProcessZipEntryContents(nti->za, &nti->entry, receive_brotli_new_data, nti);
493 } else {
494 ProcessZipEntryContents(nti->za, &nti->entry, receive_new_data, nti);
495 }
Tianjie Xu3a8d98d2017-04-03 20:01:17 -0700496 pthread_mutex_lock(&nti->mu);
497 nti->receiver_available = false;
498 if (nti->writer != nullptr) {
499 pthread_cond_broadcast(&nti->cv);
500 }
501 pthread_mutex_unlock(&nti->mu);
502 return nullptr;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -0700503}
504
Tao Bao612336d2015-08-27 16:41:21 -0700505static int ReadBlocks(const RangeSet& src, std::vector<uint8_t>& buffer, int fd) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700506 size_t p = 0;
507 for (const auto& range : src) {
508 if (!check_lseek(fd, static_cast<off64_t>(range.first) * BLOCKSIZE, SEEK_SET)) {
509 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000510 }
511
Tao Baobf5b77d2017-03-30 16:57:29 -0700512 size_t size = (range.second - range.first) * BLOCKSIZE;
513 if (read_all(fd, buffer.data() + p, size) == -1) {
514 return -1;
515 }
516
517 p += size;
518 }
519
520 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000521}
522
Tao Bao612336d2015-08-27 16:41:21 -0700523static int WriteBlocks(const RangeSet& tgt, const std::vector<uint8_t>& buffer, int fd) {
Tao Bao60a70af2017-03-26 14:03:52 -0700524 size_t written = 0;
Tao Baobf5b77d2017-03-30 16:57:29 -0700525 for (const auto& range : tgt) {
526 off64_t offset = static_cast<off64_t>(range.first) * BLOCKSIZE;
527 size_t size = (range.second - range.first) * BLOCKSIZE;
Tao Bao60a70af2017-03-26 14:03:52 -0700528 if (!discard_blocks(fd, offset, size)) {
529 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000530 }
531
Tao Bao60a70af2017-03-26 14:03:52 -0700532 if (!check_lseek(fd, offset, SEEK_SET)) {
533 return -1;
534 }
535
536 if (write_all(fd, buffer.data() + written, size) == -1) {
537 return -1;
538 }
539
540 written += size;
541 }
542
543 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000544}
545
Tao Baobaad2d42015-12-06 16:56:27 -0800546// Parameters for transfer list command functions
547struct CommandParameters {
548 std::vector<std::string> tokens;
549 size_t cpos;
Tao Baoc3901232018-05-21 16:05:56 -0700550 std::string cmdname;
551 std::string cmdline;
Tao Baobaad2d42015-12-06 16:56:27 -0800552 std::string freestash;
553 std::string stashbase;
554 bool canwrite;
555 int createdstash;
Elliott Hughesbcabd092016-03-22 20:19:22 -0700556 android::base::unique_fd fd;
Tao Baobaad2d42015-12-06 16:56:27 -0800557 bool foundwrites;
558 bool isunresumable;
559 int version;
560 size_t written;
Tianjie Xudd874b12016-05-13 12:13:15 -0700561 size_t stashed;
Tao Baobaad2d42015-12-06 16:56:27 -0800562 NewThreadInfo nti;
563 pthread_t thread;
564 std::vector<uint8_t> buffer;
565 uint8_t* patch_start;
Tianjie Xu284752e2017-12-05 11:04:17 -0800566 bool target_verified; // The target blocks have expected contents already.
Tao Baobaad2d42015-12-06 16:56:27 -0800567};
568
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000569// Print the hash in hex for corrupted source blocks (excluding the stashed blocks which is
570// handled separately).
571static void PrintHashForCorruptedSourceBlocks(const CommandParameters& params,
572 const std::vector<uint8_t>& buffer) {
573 LOG(INFO) << "unexpected contents of source blocks in cmd:\n" << params.cmdline;
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000574 CHECK(params.tokens[0] == "move" || params.tokens[0] == "bsdiff" ||
575 params.tokens[0] == "imgdiff");
576
577 size_t pos = 0;
578 // Command example:
579 // move <onehash> <tgt_range> <src_blk_count> <src_range> [<loc_range> <stashed_blocks>]
580 // bsdiff <offset> <len> <src_hash> <tgt_hash> <tgt_range> <src_blk_count> <src_range>
581 // [<loc_range> <stashed_blocks>]
582 if (params.tokens[0] == "move") {
583 // src_range for move starts at the 4th position.
584 if (params.tokens.size() < 5) {
585 LOG(ERROR) << "failed to parse source range in cmd:\n" << params.cmdline;
586 return;
587 }
588 pos = 4;
589 } else {
590 // src_range for diff starts at the 7th position.
591 if (params.tokens.size() < 8) {
592 LOG(ERROR) << "failed to parse source range in cmd:\n" << params.cmdline;
593 return;
594 }
595 pos = 7;
596 }
597
598 // Source blocks in stash only, no work to do.
599 if (params.tokens[pos] == "-") {
600 return;
601 }
602
Tao Bao8f237572017-03-26 13:36:49 -0700603 RangeSet src = RangeSet::Parse(params.tokens[pos++]);
Tao Bao67983152017-11-04 00:08:08 -0700604 if (!src) {
605 LOG(ERROR) << "Failed to parse range in " << params.cmdline;
606 return;
607 }
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000608
609 RangeSet locs;
610 // If there's no stashed blocks, content in the buffer is consecutive and has the same
611 // order as the source blocks.
612 if (pos == params.tokens.size()) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700613 locs = RangeSet(std::vector<Range>{ Range{ 0, src.blocks() } });
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000614 } else {
615 // Otherwise, the next token is the offset of the source blocks in the target range.
616 // Example: for the tokens <4,63946,63947,63948,63979> <4,6,7,8,39> <stashed_blocks>;
617 // We want to print SHA-1 for the data in buffer[6], buffer[8], buffer[9] ... buffer[38];
618 // this corresponds to the 32 src blocks #63946, #63948, #63949 ... #63978.
Tao Bao8f237572017-03-26 13:36:49 -0700619 locs = RangeSet::Parse(params.tokens[pos++]);
Tao Baobf5b77d2017-03-30 16:57:29 -0700620 CHECK_EQ(src.blocks(), locs.blocks());
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000621 }
622
Tao Baobf5b77d2017-03-30 16:57:29 -0700623 LOG(INFO) << "printing hash in hex for " << src.blocks() << " source blocks";
624 for (size_t i = 0; i < src.blocks(); i++) {
Tao Bao8f237572017-03-26 13:36:49 -0700625 size_t block_num = src.GetBlockNumber(i);
626 size_t buffer_index = locs.GetBlockNumber(i);
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000627 CHECK_LE((buffer_index + 1) * BLOCKSIZE, buffer.size());
628
629 uint8_t digest[SHA_DIGEST_LENGTH];
630 SHA1(buffer.data() + buffer_index * BLOCKSIZE, BLOCKSIZE, digest);
631 std::string hexdigest = print_sha1(digest);
632 LOG(INFO) << " block number: " << block_num << ", SHA-1: " << hexdigest;
633 }
634}
635
636// If the calculated hash for the whole stash doesn't match the stash id, print the SHA-1
637// in hex for each block.
638static void PrintHashForCorruptedStashedBlocks(const std::string& id,
639 const std::vector<uint8_t>& buffer,
640 const RangeSet& src) {
641 LOG(INFO) << "printing hash in hex for stash_id: " << id;
Tao Baobf5b77d2017-03-30 16:57:29 -0700642 CHECK_EQ(src.blocks() * BLOCKSIZE, buffer.size());
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000643
Tao Baobf5b77d2017-03-30 16:57:29 -0700644 for (size_t i = 0; i < src.blocks(); i++) {
Tao Bao8f237572017-03-26 13:36:49 -0700645 size_t block_num = src.GetBlockNumber(i);
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000646
647 uint8_t digest[SHA_DIGEST_LENGTH];
648 SHA1(buffer.data() + i * BLOCKSIZE, BLOCKSIZE, digest);
649 std::string hexdigest = print_sha1(digest);
650 LOG(INFO) << " block number: " << block_num << ", SHA-1: " << hexdigest;
651 }
652}
653
654// If the stash file doesn't exist, read the source blocks this stash contains and print the
655// SHA-1 for these blocks.
656static void PrintHashForMissingStashedBlocks(const std::string& id, int fd) {
657 if (stash_map.find(id) == stash_map.end()) {
658 LOG(ERROR) << "No stash saved for id: " << id;
659 return;
660 }
661
662 LOG(INFO) << "print hash in hex for source blocks in missing stash: " << id;
663 const RangeSet& src = stash_map[id];
Tao Baobf5b77d2017-03-30 16:57:29 -0700664 std::vector<uint8_t> buffer(src.blocks() * BLOCKSIZE);
Tianjie Xu2cd36ba2017-03-15 23:52:46 +0000665 if (ReadBlocks(src, buffer, fd) == -1) {
666 LOG(ERROR) << "failed to read source blocks for stash: " << id;
667 return;
668 }
669 PrintHashForCorruptedStashedBlocks(id, buffer, src);
670}
671
Tao Bao612336d2015-08-27 16:41:21 -0700672static int VerifyBlocks(const std::string& expected, const std::vector<uint8_t>& buffer,
Tao Bao0940fe12015-08-27 16:41:21 -0700673 const size_t blocks, bool printerror) {
Sen Jiangc48cb5e2016-02-04 16:23:21 +0800674 uint8_t digest[SHA_DIGEST_LENGTH];
Tao Bao612336d2015-08-27 16:41:21 -0700675 const uint8_t* data = buffer.data();
Sami Tolvanen90221202014-12-09 16:39:47 +0000676
Sen Jiangc48cb5e2016-02-04 16:23:21 +0800677 SHA1(data, blocks * BLOCKSIZE, digest);
Sami Tolvanen90221202014-12-09 16:39:47 +0000678
Tao Baoe6aa3322015-08-05 15:20:27 -0700679 std::string hexdigest = print_sha1(digest);
Sami Tolvanen90221202014-12-09 16:39:47 +0000680
Tao Bao0940fe12015-08-27 16:41:21 -0700681 if (hexdigest != expected) {
682 if (printerror) {
Tao Bao039f2da2016-11-22 16:29:50 -0800683 LOG(ERROR) << "failed to verify blocks (expected " << expected << ", read "
684 << hexdigest << ")";
Tao Bao0940fe12015-08-27 16:41:21 -0700685 }
686 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000687 }
688
Tao Bao0940fe12015-08-27 16:41:21 -0700689 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000690}
691
Tao Bao0940fe12015-08-27 16:41:21 -0700692static std::string GetStashFileName(const std::string& base, const std::string& id,
Tao Bao641fa972018-04-25 18:59:40 -0700693 const std::string& postfix) {
694 if (base.empty()) {
695 return "";
696 }
Tao Bao864c6682018-05-07 11:38:25 -0700697 std::string filename = Paths::Get().stash_directory_base() + "/" + base;
698 if (id.empty() && postfix.empty()) {
699 return filename;
700 }
701 return filename + "/" + id + postfix;
Sami Tolvanen90221202014-12-09 16:39:47 +0000702}
703
Tao Baoec8272f2017-03-15 17:39:01 -0700704// Does a best effort enumeration of stash files. Ignores possible non-file items in the stash
705// directory and continues despite of errors. Calls the 'callback' function for each file.
706static void EnumerateStash(const std::string& dirname,
707 const std::function<void(const std::string&)>& callback) {
708 if (dirname.empty()) return;
Sami Tolvanen90221202014-12-09 16:39:47 +0000709
Tao Baoec8272f2017-03-15 17:39:01 -0700710 std::unique_ptr<DIR, decltype(&closedir)> directory(opendir(dirname.c_str()), closedir);
Sami Tolvanen90221202014-12-09 16:39:47 +0000711
Tao Baoec8272f2017-03-15 17:39:01 -0700712 if (directory == nullptr) {
713 if (errno != ENOENT) {
714 PLOG(ERROR) << "opendir \"" << dirname << "\" failed";
Sami Tolvanen90221202014-12-09 16:39:47 +0000715 }
Tao Bao51412212016-12-28 14:44:05 -0800716 return;
717 }
Tao Baoe6aa3322015-08-05 15:20:27 -0700718
Tao Baoec8272f2017-03-15 17:39:01 -0700719 dirent* item;
720 while ((item = readdir(directory.get())) != nullptr) {
721 if (item->d_type != DT_REG) continue;
722 callback(dirname + "/" + item->d_name);
Tao Bao51412212016-12-28 14:44:05 -0800723 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000724}
725
726// Deletes the stash directory and all files in it. Assumes that it only
727// contains files. There is nothing we can do about unlikely, but possible
728// errors, so they are merely logged.
Tao Baoec8272f2017-03-15 17:39:01 -0700729static void DeleteFile(const std::string& fn) {
730 if (fn.empty()) return;
Sami Tolvanen90221202014-12-09 16:39:47 +0000731
Tao Baoec8272f2017-03-15 17:39:01 -0700732 LOG(INFO) << "deleting " << fn;
Sami Tolvanen90221202014-12-09 16:39:47 +0000733
Tao Baoec8272f2017-03-15 17:39:01 -0700734 if (unlink(fn.c_str()) == -1 && errno != ENOENT) {
735 PLOG(ERROR) << "unlink \"" << fn << "\" failed";
736 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000737}
738
Tao Baoe6aa3322015-08-05 15:20:27 -0700739static void DeleteStash(const std::string& base) {
Tao Baoec8272f2017-03-15 17:39:01 -0700740 if (base.empty()) return;
741
742 LOG(INFO) << "deleting stash " << base;
743
744 std::string dirname = GetStashFileName(base, "", "");
745 EnumerateStash(dirname, DeleteFile);
746
747 if (rmdir(dirname.c_str()) == -1) {
748 if (errno != ENOENT && errno != ENOTDIR) {
749 PLOG(ERROR) << "rmdir \"" << dirname << "\" failed";
Sami Tolvanen90221202014-12-09 16:39:47 +0000750 }
Tao Baoec8272f2017-03-15 17:39:01 -0700751 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000752}
753
Tao Bao64957ce2018-05-30 16:21:39 -0700754static int LoadStash(CommandParameters& params, const std::string& id, bool verify,
Tao Baobcf46492017-03-23 15:28:20 -0700755 std::vector<uint8_t>& buffer, bool printnoent) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700756 // In verify mode, if source range_set was saved for the given hash, check contents in the source
757 // blocks first. If the check fails, search for the stashed files on /cache as usual.
758 if (!params.canwrite) {
759 if (stash_map.find(id) != stash_map.end()) {
760 const RangeSet& src = stash_map[id];
761 allocate(src.blocks() * BLOCKSIZE, buffer);
Tianjie Xu7eca97e2016-03-22 18:08:12 -0700762
Tao Baobf5b77d2017-03-30 16:57:29 -0700763 if (ReadBlocks(src, buffer, params.fd) == -1) {
764 LOG(ERROR) << "failed to read source blocks in stash map.";
Tao Bao0940fe12015-08-27 16:41:21 -0700765 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -0700766 }
767 if (VerifyBlocks(id, buffer, src.blocks(), true) != 0) {
768 LOG(ERROR) << "failed to verify loaded source blocks in stash map.";
769 PrintHashForCorruptedStashedBlocks(id, buffer, src);
Tao Bao0940fe12015-08-27 16:41:21 -0700770 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -0700771 }
772 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000773 }
Tao Baobf5b77d2017-03-30 16:57:29 -0700774 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000775
Tao Baobf5b77d2017-03-30 16:57:29 -0700776 std::string fn = GetStashFileName(params.stashbase, id, "");
777
778 struct stat sb;
779 if (stat(fn.c_str(), &sb) == -1) {
780 if (errno != ENOENT || printnoent) {
781 PLOG(ERROR) << "stat \"" << fn << "\" failed";
782 PrintHashForMissingStashedBlocks(id, params.fd);
Sami Tolvanen90221202014-12-09 16:39:47 +0000783 }
Tao Baobf5b77d2017-03-30 16:57:29 -0700784 return -1;
785 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000786
Tao Baobf5b77d2017-03-30 16:57:29 -0700787 LOG(INFO) << " loading " << fn;
Sami Tolvanen90221202014-12-09 16:39:47 +0000788
Tao Baobf5b77d2017-03-30 16:57:29 -0700789 if ((sb.st_size % BLOCKSIZE) != 0) {
790 LOG(ERROR) << fn << " size " << sb.st_size << " not multiple of block size " << BLOCKSIZE;
791 return -1;
792 }
793
794 android::base::unique_fd fd(TEMP_FAILURE_RETRY(ota_open(fn.c_str(), O_RDONLY)));
795 if (fd == -1) {
796 PLOG(ERROR) << "open \"" << fn << "\" failed";
797 return -1;
798 }
799
800 allocate(sb.st_size, buffer);
801
802 if (read_all(fd, buffer, sb.st_size) == -1) {
803 return -1;
804 }
805
Tao Bao64957ce2018-05-30 16:21:39 -0700806 size_t blocks = sb.st_size / BLOCKSIZE;
807 if (verify && VerifyBlocks(id, buffer, blocks, true) != 0) {
Tao Baobf5b77d2017-03-30 16:57:29 -0700808 LOG(ERROR) << "unexpected contents in " << fn;
809 if (stash_map.find(id) == stash_map.end()) {
810 LOG(ERROR) << "failed to find source blocks number for stash " << id
811 << " when executing command: " << params.cmdname;
812 } else {
813 const RangeSet& src = stash_map[id];
814 PrintHashForCorruptedStashedBlocks(id, buffer, src);
Sami Tolvanen90221202014-12-09 16:39:47 +0000815 }
Tao Baobf5b77d2017-03-30 16:57:29 -0700816 DeleteFile(fn);
817 return -1;
818 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000819
Tao Baobf5b77d2017-03-30 16:57:29 -0700820 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000821}
822
Tao Bao612336d2015-08-27 16:41:21 -0700823static int WriteStash(const std::string& base, const std::string& id, int blocks,
Tao Baod2aecd42017-03-23 14:43:44 -0700824 std::vector<uint8_t>& buffer, bool checkspace, bool* exists) {
Tao Bao612336d2015-08-27 16:41:21 -0700825 if (base.empty()) {
Tao Bao0940fe12015-08-27 16:41:21 -0700826 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000827 }
828
829 if (checkspace && CacheSizeCheck(blocks * BLOCKSIZE) != 0) {
Tao Bao039f2da2016-11-22 16:29:50 -0800830 LOG(ERROR) << "not enough space to write stash";
Tao Bao0940fe12015-08-27 16:41:21 -0700831 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000832 }
833
Tao Bao0940fe12015-08-27 16:41:21 -0700834 std::string fn = GetStashFileName(base, id, ".partial");
835 std::string cn = GetStashFileName(base, id, "");
Sami Tolvanen90221202014-12-09 16:39:47 +0000836
Sami Tolvanen43b748f2015-04-17 12:50:31 +0100837 if (exists) {
Tao Bao0940fe12015-08-27 16:41:21 -0700838 struct stat sb;
839 int res = stat(cn.c_str(), &sb);
Sami Tolvanen43b748f2015-04-17 12:50:31 +0100840
841 if (res == 0) {
842 // The file already exists and since the name is the hash of the contents,
843 // it's safe to assume the contents are identical (accidental hash collisions
844 // are unlikely)
Tao Bao039f2da2016-11-22 16:29:50 -0800845 LOG(INFO) << " skipping " << blocks << " existing blocks in " << cn;
Tao Bao0940fe12015-08-27 16:41:21 -0700846 *exists = true;
847 return 0;
Sami Tolvanen43b748f2015-04-17 12:50:31 +0100848 }
849
Tao Bao0940fe12015-08-27 16:41:21 -0700850 *exists = false;
Sami Tolvanen43b748f2015-04-17 12:50:31 +0100851 }
852
Tao Bao039f2da2016-11-22 16:29:50 -0800853 LOG(INFO) << " writing " << blocks << " blocks to " << cn;
Sami Tolvanen90221202014-12-09 16:39:47 +0000854
Tao Bao039f2da2016-11-22 16:29:50 -0800855 android::base::unique_fd fd(
856 TEMP_FAILURE_RETRY(ota_open(fn.c_str(), O_WRONLY | O_CREAT | O_TRUNC, STASH_FILE_MODE)));
Sami Tolvanen90221202014-12-09 16:39:47 +0000857 if (fd == -1) {
Tao Bao039f2da2016-11-22 16:29:50 -0800858 PLOG(ERROR) << "failed to create \"" << fn << "\"";
Tao Bao0940fe12015-08-27 16:41:21 -0700859 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000860 }
861
Tianjie Xua946b9e2017-03-21 16:24:57 -0700862 if (fchown(fd, AID_SYSTEM, AID_SYSTEM) != 0) { // system user
863 PLOG(ERROR) << "failed to chown \"" << fn << "\"";
864 return -1;
865 }
866
Sami Tolvanen90221202014-12-09 16:39:47 +0000867 if (write_all(fd, buffer, blocks * BLOCKSIZE) == -1) {
Tao Bao0940fe12015-08-27 16:41:21 -0700868 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000869 }
870
Jed Estepa7b9a462015-12-15 16:04:53 -0800871 if (ota_fsync(fd) == -1) {
Tianjie Xu16255832016-04-30 11:49:59 -0700872 failure_type = kFsyncFailure;
Tao Bao039f2da2016-11-22 16:29:50 -0800873 PLOG(ERROR) << "fsync \"" << fn << "\" failed";
Tao Bao0940fe12015-08-27 16:41:21 -0700874 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000875 }
876
Tao Baoe6aa3322015-08-05 15:20:27 -0700877 if (rename(fn.c_str(), cn.c_str()) == -1) {
Tao Bao039f2da2016-11-22 16:29:50 -0800878 PLOG(ERROR) << "rename(\"" << fn << "\", \"" << cn << "\") failed";
Tao Bao0940fe12015-08-27 16:41:21 -0700879 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000880 }
881
Tao Bao0940fe12015-08-27 16:41:21 -0700882 std::string dname = GetStashFileName(base, "", "");
Tao Bao864c6682018-05-07 11:38:25 -0700883 if (!FsyncDir(dname)) {
884 failure_type = kFsyncFailure;
885 return -1;
Tao Baodc392262015-07-31 15:56:44 -0700886 }
887
Tao Bao0940fe12015-08-27 16:41:21 -0700888 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +0000889}
890
891// Creates a directory for storing stash files and checks if the /cache partition
892// hash enough space for the expected amount of blocks we need to store. Returns
893// >0 if we created the directory, zero if it existed already, and <0 of failure.
Tao Bao864c6682018-05-07 11:38:25 -0700894static int CreateStash(State* state, size_t maxblocks, const std::string& base) {
Tao Bao51412212016-12-28 14:44:05 -0800895 std::string dirname = GetStashFileName(base, "", "");
896 struct stat sb;
897 int res = stat(dirname.c_str(), &sb);
Tao Bao51412212016-12-28 14:44:05 -0800898 if (res == -1 && errno != ENOENT) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800899 ErrorAbort(state, kStashCreationFailure, "stat \"%s\" failed: %s", dirname.c_str(),
Tao Bao51412212016-12-28 14:44:05 -0800900 strerror(errno));
901 return -1;
Tao Bao864c6682018-05-07 11:38:25 -0700902 }
903
904 size_t max_stash_size = maxblocks * BLOCKSIZE;
905 if (res == -1) {
Tao Bao51412212016-12-28 14:44:05 -0800906 LOG(INFO) << "creating stash " << dirname;
907 res = mkdir(dirname.c_str(), STASH_DIRECTORY_MODE);
908
909 if (res != 0) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800910 ErrorAbort(state, kStashCreationFailure, "mkdir \"%s\" failed: %s", dirname.c_str(),
Tao Bao51412212016-12-28 14:44:05 -0800911 strerror(errno));
912 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000913 }
914
Tianjie Xua946b9e2017-03-21 16:24:57 -0700915 if (chown(dirname.c_str(), AID_SYSTEM, AID_SYSTEM) != 0) { // system user
Tianjie Xu5ad80282018-01-28 15:37:48 -0800916 ErrorAbort(state, kStashCreationFailure, "chown \"%s\" failed: %s", dirname.c_str(),
Tianjie Xua946b9e2017-03-21 16:24:57 -0700917 strerror(errno));
918 return -1;
919 }
920
Tao Bao51412212016-12-28 14:44:05 -0800921 if (CacheSizeCheck(max_stash_size) != 0) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800922 ErrorAbort(state, kStashCreationFailure, "not enough space for stash (%zu needed)",
Tao Bao51412212016-12-28 14:44:05 -0800923 max_stash_size);
924 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000925 }
926
Tao Bao51412212016-12-28 14:44:05 -0800927 return 1; // Created directory
928 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000929
Tao Bao51412212016-12-28 14:44:05 -0800930 LOG(INFO) << "using existing stash " << dirname;
Sami Tolvanen90221202014-12-09 16:39:47 +0000931
Tao Baoec8272f2017-03-15 17:39:01 -0700932 // If the directory already exists, calculate the space already allocated to stash files and check
933 // if there's enough for all required blocks. Delete any partially completed stash files first.
934 EnumerateStash(dirname, [](const std::string& fn) {
935 if (android::base::EndsWith(fn, ".partial")) {
936 DeleteFile(fn);
937 }
938 });
Sami Tolvanen90221202014-12-09 16:39:47 +0000939
Tao Bao51412212016-12-28 14:44:05 -0800940 size_t existing = 0;
Tao Baoec8272f2017-03-15 17:39:01 -0700941 EnumerateStash(dirname, [&existing](const std::string& fn) {
942 if (fn.empty()) return;
943 struct stat sb;
944 if (stat(fn.c_str(), &sb) == -1) {
945 PLOG(ERROR) << "stat \"" << fn << "\" failed";
946 return;
947 }
948 existing += static_cast<size_t>(sb.st_size);
949 });
Sami Tolvanen90221202014-12-09 16:39:47 +0000950
Tao Bao51412212016-12-28 14:44:05 -0800951 if (max_stash_size > existing) {
952 size_t needed = max_stash_size - existing;
953 if (CacheSizeCheck(needed) != 0) {
Tianjie Xu5ad80282018-01-28 15:37:48 -0800954 ErrorAbort(state, kStashCreationFailure, "not enough space for stash (%zu more needed)",
Tao Bao51412212016-12-28 14:44:05 -0800955 needed);
956 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +0000957 }
Tao Bao51412212016-12-28 14:44:05 -0800958 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000959
Tao Bao51412212016-12-28 14:44:05 -0800960 return 0; // Using existing directory
Sami Tolvanen90221202014-12-09 16:39:47 +0000961}
962
Tao Baobaad2d42015-12-06 16:56:27 -0800963static int FreeStash(const std::string& base, const std::string& id) {
Tao Baoec8272f2017-03-15 17:39:01 -0700964 if (base.empty() || id.empty()) {
965 return -1;
966 }
Sami Tolvanen90221202014-12-09 16:39:47 +0000967
Tao Baoec8272f2017-03-15 17:39:01 -0700968 DeleteFile(GetStashFileName(base, id, ""));
Sami Tolvanen90221202014-12-09 16:39:47 +0000969
Tao Baoec8272f2017-03-15 17:39:01 -0700970 return 0;
Doug Zongker52ae67d2014-09-08 12:22:09 -0700971}
972
Tao Baobf5b77d2017-03-30 16:57:29 -0700973// Source contains packed data, which we want to move to the locations given in locs in the dest
974// buffer. source and dest may be the same buffer.
Tao Bao612336d2015-08-27 16:41:21 -0700975static void MoveRange(std::vector<uint8_t>& dest, const RangeSet& locs,
Tao Baobf5b77d2017-03-30 16:57:29 -0700976 const std::vector<uint8_t>& source) {
977 const uint8_t* from = source.data();
978 uint8_t* to = dest.data();
979 size_t start = locs.blocks();
980 // Must do the movement backward.
981 for (auto it = locs.crbegin(); it != locs.crend(); it++) {
982 size_t blocks = it->second - it->first;
983 start -= blocks;
984 memmove(to + (it->first * BLOCKSIZE), from + (start * BLOCKSIZE), blocks * BLOCKSIZE);
985 }
Doug Zongker52ae67d2014-09-08 12:22:09 -0700986}
987
Tao Baod2aecd42017-03-23 14:43:44 -0700988/**
989 * We expect to parse the remainder of the parameter tokens as one of:
990 *
991 * <src_block_count> <src_range>
992 * (loads data from source image only)
993 *
994 * <src_block_count> - <[stash_id:stash_range] ...>
995 * (loads data from stashes only)
996 *
997 * <src_block_count> <src_range> <src_loc> <[stash_id:stash_range] ...>
998 * (loads data from both source image and stashes)
999 *
1000 * On return, params.buffer is filled with the loaded source data (rearranged and combined with
1001 * stashed data as necessary). buffer may be reallocated if needed to accommodate the source data.
1002 * tgt is the target RangeSet for detecting overlaps. Any stashes required are loaded using
1003 * LoadStash.
1004 */
1005static int LoadSourceBlocks(CommandParameters& params, const RangeSet& tgt, size_t* src_blocks,
1006 bool* overlap) {
1007 CHECK(src_blocks != nullptr);
1008 CHECK(overlap != nullptr);
Doug Zongker52ae67d2014-09-08 12:22:09 -07001009
Tao Baod2aecd42017-03-23 14:43:44 -07001010 // <src_block_count>
1011 const std::string& token = params.tokens[params.cpos++];
1012 if (!android::base::ParseUint(token, src_blocks)) {
1013 LOG(ERROR) << "invalid src_block_count \"" << token << "\"";
1014 return -1;
1015 }
Tao Baobaad2d42015-12-06 16:56:27 -08001016
Tao Baod2aecd42017-03-23 14:43:44 -07001017 allocate(*src_blocks * BLOCKSIZE, params.buffer);
1018
1019 // "-" or <src_range> [<src_loc>]
1020 if (params.tokens[params.cpos] == "-") {
1021 // no source ranges, only stashes
1022 params.cpos++;
1023 } else {
Tao Bao8f237572017-03-26 13:36:49 -07001024 RangeSet src = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001025 CHECK(static_cast<bool>(src));
Tao Bao8f237572017-03-26 13:36:49 -07001026 *overlap = src.Overlaps(tgt);
Tao Baod2aecd42017-03-23 14:43:44 -07001027
1028 if (ReadBlocks(src, params.buffer, params.fd) == -1) {
1029 return -1;
Tao Baobaad2d42015-12-06 16:56:27 -08001030 }
1031
Tao Baod2aecd42017-03-23 14:43:44 -07001032 if (params.cpos >= params.tokens.size()) {
1033 // no stashes, only source range
1034 return 0;
Tao Baobaad2d42015-12-06 16:56:27 -08001035 }
Doug Zongker52ae67d2014-09-08 12:22:09 -07001036
Tao Bao8f237572017-03-26 13:36:49 -07001037 RangeSet locs = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001038 CHECK(static_cast<bool>(locs));
Tao Baod2aecd42017-03-23 14:43:44 -07001039 MoveRange(params.buffer, locs, params.buffer);
1040 }
Doug Zongker52ae67d2014-09-08 12:22:09 -07001041
Tao Baod2aecd42017-03-23 14:43:44 -07001042 // <[stash_id:stash_range]>
1043 while (params.cpos < params.tokens.size()) {
1044 // Each word is a an index into the stash table, a colon, and then a RangeSet describing where
1045 // in the source block that stashed data should go.
1046 std::vector<std::string> tokens = android::base::Split(params.tokens[params.cpos++], ":");
1047 if (tokens.size() != 2) {
1048 LOG(ERROR) << "invalid parameter";
1049 return -1;
Doug Zongker52ae67d2014-09-08 12:22:09 -07001050 }
1051
Tao Baod2aecd42017-03-23 14:43:44 -07001052 std::vector<uint8_t> stash;
Tao Bao64957ce2018-05-30 16:21:39 -07001053 if (LoadStash(params, tokens[0], false, stash, true) == -1) {
Tao Baod2aecd42017-03-23 14:43:44 -07001054 // These source blocks will fail verification if used later, but we
1055 // will let the caller decide if this is a fatal failure
1056 LOG(ERROR) << "failed to load stash " << tokens[0];
1057 continue;
Sami Tolvanen90221202014-12-09 16:39:47 +00001058 }
1059
Tao Bao8f237572017-03-26 13:36:49 -07001060 RangeSet locs = RangeSet::Parse(tokens[1]);
Tao Bao67983152017-11-04 00:08:08 -07001061 CHECK(static_cast<bool>(locs));
Tao Baod2aecd42017-03-23 14:43:44 -07001062 MoveRange(params.buffer, locs, stash);
1063 }
1064
1065 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001066}
1067
Tao Bao33567772017-03-13 14:57:34 -07001068/**
1069 * Do a source/target load for move/bsdiff/imgdiff in version 3.
1070 *
1071 * We expect to parse the remainder of the parameter tokens as one of:
1072 *
1073 * <tgt_range> <src_block_count> <src_range>
1074 * (loads data from source image only)
1075 *
1076 * <tgt_range> <src_block_count> - <[stash_id:stash_range] ...>
1077 * (loads data from stashes only)
1078 *
1079 * <tgt_range> <src_block_count> <src_range> <src_loc> <[stash_id:stash_range] ...>
1080 * (loads data from both source image and stashes)
1081 *
Tao Baod2aecd42017-03-23 14:43:44 -07001082 * 'onehash' tells whether to expect separate source and targe block hashes, or if they are both the
1083 * same and only one hash should be expected. params.isunresumable will be set to true if block
Tao Bao33567772017-03-13 14:57:34 -07001084 * verification fails in a way that the update cannot be resumed anymore.
1085 *
1086 * If the function is unable to load the necessary blocks or their contents don't match the hashes,
1087 * the return value is -1 and the command should be aborted.
1088 *
1089 * If the return value is 1, the command has already been completed according to the contents of the
1090 * target blocks, and should not be performed again.
1091 *
1092 * If the return value is 0, source blocks have expected content and the command can be performed.
1093 */
Tao Baod2aecd42017-03-23 14:43:44 -07001094static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t* src_blocks,
1095 bool onehash, bool* overlap) {
1096 CHECK(src_blocks != nullptr);
1097 CHECK(overlap != nullptr);
Sami Tolvanen90221202014-12-09 16:39:47 +00001098
Tao Baod2aecd42017-03-23 14:43:44 -07001099 if (params.cpos >= params.tokens.size()) {
1100 LOG(ERROR) << "missing source hash";
Tao Bao0940fe12015-08-27 16:41:21 -07001101 return -1;
Tao Baod2aecd42017-03-23 14:43:44 -07001102 }
1103
1104 std::string srchash = params.tokens[params.cpos++];
1105 std::string tgthash;
1106
1107 if (onehash) {
1108 tgthash = srchash;
1109 } else {
1110 if (params.cpos >= params.tokens.size()) {
1111 LOG(ERROR) << "missing target hash";
1112 return -1;
1113 }
1114 tgthash = params.tokens[params.cpos++];
1115 }
1116
1117 // At least it needs to provide three parameters: <tgt_range>, <src_block_count> and
1118 // "-"/<src_range>.
1119 if (params.cpos + 2 >= params.tokens.size()) {
1120 LOG(ERROR) << "invalid parameters";
1121 return -1;
1122 }
1123
1124 // <tgt_range>
Tao Bao8f237572017-03-26 13:36:49 -07001125 tgt = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001126 CHECK(static_cast<bool>(tgt));
Tao Baod2aecd42017-03-23 14:43:44 -07001127
Tao Baobf5b77d2017-03-30 16:57:29 -07001128 std::vector<uint8_t> tgtbuffer(tgt.blocks() * BLOCKSIZE);
Tao Baod2aecd42017-03-23 14:43:44 -07001129 if (ReadBlocks(tgt, tgtbuffer, params.fd) == -1) {
1130 return -1;
1131 }
1132
1133 // Return now if target blocks already have expected content.
Tao Baobf5b77d2017-03-30 16:57:29 -07001134 if (VerifyBlocks(tgthash, tgtbuffer, tgt.blocks(), false) == 0) {
Tao Baod2aecd42017-03-23 14:43:44 -07001135 return 1;
1136 }
1137
1138 // Load source blocks.
1139 if (LoadSourceBlocks(params, tgt, src_blocks, overlap) == -1) {
1140 return -1;
1141 }
1142
1143 if (VerifyBlocks(srchash, params.buffer, *src_blocks, true) == 0) {
1144 // If source and target blocks overlap, stash the source blocks so we can
1145 // resume from possible write errors. In verify mode, we can skip stashing
1146 // because the source blocks won't be overwritten.
1147 if (*overlap && params.canwrite) {
1148 LOG(INFO) << "stashing " << *src_blocks << " overlapping blocks to " << srchash;
1149
1150 bool stash_exists = false;
1151 if (WriteStash(params.stashbase, srchash, *src_blocks, params.buffer, true,
1152 &stash_exists) != 0) {
1153 LOG(ERROR) << "failed to stash overlapping source blocks";
1154 return -1;
1155 }
1156
1157 params.stashed += *src_blocks;
1158 // Can be deleted when the write has completed.
1159 if (!stash_exists) {
1160 params.freestash = srchash;
1161 }
1162 }
1163
1164 // Source blocks have expected content, command can proceed.
1165 return 0;
1166 }
1167
Tao Bao64957ce2018-05-30 16:21:39 -07001168 if (*overlap && LoadStash(params, srchash, true, params.buffer, true) == 0) {
Tao Baod2aecd42017-03-23 14:43:44 -07001169 // Overlapping source blocks were previously stashed, command can proceed. We are recovering
1170 // from an interrupted command, so we don't know if the stash can safely be deleted after this
1171 // command.
1172 return 0;
1173 }
1174
1175 // Valid source data not available, update cannot be resumed.
1176 LOG(ERROR) << "partition has unexpected contents";
1177 PrintHashForCorruptedSourceBlocks(params, params.buffer);
1178
1179 params.isunresumable = true;
1180
1181 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +00001182}
1183
Tao Bao0940fe12015-08-27 16:41:21 -07001184static int PerformCommandMove(CommandParameters& params) {
Tao Bao33567772017-03-13 14:57:34 -07001185 size_t blocks = 0;
1186 bool overlap = false;
1187 RangeSet tgt;
Tao Baod2aecd42017-03-23 14:43:44 -07001188 int status = LoadSrcTgtVersion3(params, tgt, &blocks, true, &overlap);
Sami Tolvanen90221202014-12-09 16:39:47 +00001189
Tao Bao33567772017-03-13 14:57:34 -07001190 if (status == -1) {
1191 LOG(ERROR) << "failed to read blocks for move";
1192 return -1;
1193 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001194
Tao Bao33567772017-03-13 14:57:34 -07001195 if (status == 0) {
1196 params.foundwrites = true;
Tianjie Xu284752e2017-12-05 11:04:17 -08001197 } else {
1198 params.target_verified = true;
1199 if (params.foundwrites) {
1200 LOG(WARNING) << "warning: commands executed out of order [" << params.cmdname << "]";
1201 }
Tao Bao33567772017-03-13 14:57:34 -07001202 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001203
Tao Bao33567772017-03-13 14:57:34 -07001204 if (params.canwrite) {
Sami Tolvanen90221202014-12-09 16:39:47 +00001205 if (status == 0) {
Tao Bao33567772017-03-13 14:57:34 -07001206 LOG(INFO) << " moving " << blocks << " blocks";
1207
1208 if (WriteBlocks(tgt, params.buffer, params.fd) == -1) {
1209 return -1;
1210 }
1211 } else {
1212 LOG(INFO) << "skipping " << blocks << " already moved blocks";
Sami Tolvanen90221202014-12-09 16:39:47 +00001213 }
Tao Bao33567772017-03-13 14:57:34 -07001214 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001215
Tao Bao33567772017-03-13 14:57:34 -07001216 if (!params.freestash.empty()) {
1217 FreeStash(params.stashbase, params.freestash);
1218 params.freestash.clear();
1219 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001220
Tao Baobf5b77d2017-03-30 16:57:29 -07001221 params.written += tgt.blocks();
Sami Tolvanen90221202014-12-09 16:39:47 +00001222
Tao Bao33567772017-03-13 14:57:34 -07001223 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001224}
1225
Tao Bao0940fe12015-08-27 16:41:21 -07001226static int PerformCommandStash(CommandParameters& params) {
Tao Baobcf46492017-03-23 15:28:20 -07001227 // <stash_id> <src_range>
1228 if (params.cpos + 1 >= params.tokens.size()) {
1229 LOG(ERROR) << "missing id and/or src range fields in stash command";
1230 return -1;
1231 }
1232
1233 const std::string& id = params.tokens[params.cpos++];
Tao Bao64957ce2018-05-30 16:21:39 -07001234 if (LoadStash(params, id, true, params.buffer, false) == 0) {
Tao Baobcf46492017-03-23 15:28:20 -07001235 // Stash file already exists and has expected contents. Do not read from source again, as the
1236 // source may have been already overwritten during a previous attempt.
1237 return 0;
1238 }
1239
Tao Bao8f237572017-03-26 13:36:49 -07001240 RangeSet src = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001241 CHECK(static_cast<bool>(src));
Tao Baobcf46492017-03-23 15:28:20 -07001242
Tao Bao64957ce2018-05-30 16:21:39 -07001243 size_t blocks = src.blocks();
1244 allocate(blocks * BLOCKSIZE, params.buffer);
Tao Baobcf46492017-03-23 15:28:20 -07001245 if (ReadBlocks(src, params.buffer, params.fd) == -1) {
1246 return -1;
1247 }
Tao Baobcf46492017-03-23 15:28:20 -07001248 stash_map[id] = src;
1249
1250 if (VerifyBlocks(id, params.buffer, blocks, true) != 0) {
1251 // Source blocks have unexpected contents. If we actually need this data later, this is an
1252 // unrecoverable error. However, the command that uses the data may have already completed
1253 // previously, so the possible failure will occur during source block verification.
1254 LOG(ERROR) << "failed to load source blocks for stash " << id;
1255 return 0;
1256 }
1257
1258 // In verify mode, we don't need to stash any blocks.
1259 if (!params.canwrite) {
1260 return 0;
1261 }
1262
1263 LOG(INFO) << "stashing " << blocks << " blocks to " << id;
Tianjie Xu284752e2017-12-05 11:04:17 -08001264 int result = WriteStash(params.stashbase, id, blocks, params.buffer, false, nullptr);
1265 if (result == 0) {
Tianjie Xu284752e2017-12-05 11:04:17 -08001266 params.stashed += blocks;
1267 }
1268 return result;
Sami Tolvanen90221202014-12-09 16:39:47 +00001269}
1270
Tao Bao0940fe12015-08-27 16:41:21 -07001271static int PerformCommandFree(CommandParameters& params) {
Tao Baobcf46492017-03-23 15:28:20 -07001272 // <stash_id>
1273 if (params.cpos >= params.tokens.size()) {
1274 LOG(ERROR) << "missing stash id in free command";
1275 return -1;
1276 }
Tao Baobaad2d42015-12-06 16:56:27 -08001277
Tao Baobcf46492017-03-23 15:28:20 -07001278 const std::string& id = params.tokens[params.cpos++];
1279 stash_map.erase(id);
Tianjie Xu7eca97e2016-03-22 18:08:12 -07001280
Tao Baobcf46492017-03-23 15:28:20 -07001281 if (params.createdstash || params.canwrite) {
1282 return FreeStash(params.stashbase, id);
1283 }
Tianjie Xu7eca97e2016-03-22 18:08:12 -07001284
Tao Baobcf46492017-03-23 15:28:20 -07001285 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001286}
1287
Tao Bao0940fe12015-08-27 16:41:21 -07001288static int PerformCommandZero(CommandParameters& params) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001289 if (params.cpos >= params.tokens.size()) {
1290 LOG(ERROR) << "missing target blocks for zero";
1291 return -1;
1292 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001293
Tao Baobf5b77d2017-03-30 16:57:29 -07001294 RangeSet tgt = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001295 CHECK(static_cast<bool>(tgt));
Tao Baobf5b77d2017-03-30 16:57:29 -07001296
1297 LOG(INFO) << " zeroing " << tgt.blocks() << " blocks";
1298
1299 allocate(BLOCKSIZE, params.buffer);
1300 memset(params.buffer.data(), 0, BLOCKSIZE);
1301
1302 if (params.canwrite) {
1303 for (const auto& range : tgt) {
1304 off64_t offset = static_cast<off64_t>(range.first) * BLOCKSIZE;
1305 size_t size = (range.second - range.first) * BLOCKSIZE;
1306 if (!discard_blocks(params.fd, offset, size)) {
Tao Bao0940fe12015-08-27 16:41:21 -07001307 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -07001308 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001309
Tao Baobf5b77d2017-03-30 16:57:29 -07001310 if (!check_lseek(params.fd, offset, SEEK_SET)) {
1311 return -1;
1312 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001313
Tao Baobf5b77d2017-03-30 16:57:29 -07001314 for (size_t j = range.first; j < range.second; ++j) {
1315 if (write_all(params.fd, params.buffer, BLOCKSIZE) == -1) {
1316 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +00001317 }
Tao Baobf5b77d2017-03-30 16:57:29 -07001318 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001319 }
Tao Baobf5b77d2017-03-30 16:57:29 -07001320 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001321
Tao Baobf5b77d2017-03-30 16:57:29 -07001322 if (params.cmdname[0] == 'z') {
1323 // Update only for the zero command, as the erase command will call
1324 // this if DEBUG_ERASE is defined.
1325 params.written += tgt.blocks();
1326 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001327
Tao Baobf5b77d2017-03-30 16:57:29 -07001328 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001329}
1330
Tao Bao0940fe12015-08-27 16:41:21 -07001331static int PerformCommandNew(CommandParameters& params) {
Tao Bao60a70af2017-03-26 14:03:52 -07001332 if (params.cpos >= params.tokens.size()) {
1333 LOG(ERROR) << "missing target blocks for new";
1334 return -1;
1335 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001336
Tao Bao8f237572017-03-26 13:36:49 -07001337 RangeSet tgt = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001338 CHECK(static_cast<bool>(tgt));
Tao Bao60a70af2017-03-26 14:03:52 -07001339
1340 if (params.canwrite) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001341 LOG(INFO) << " writing " << tgt.blocks() << " blocks of new data";
Tao Bao60a70af2017-03-26 14:03:52 -07001342
Tao Bao60a70af2017-03-26 14:03:52 -07001343 pthread_mutex_lock(&params.nti.mu);
Tianjie Xu6ed175d2017-07-18 11:29:40 -07001344 params.nti.writer = std::make_unique<RangeSinkWriter>(params.fd, tgt);
Tao Bao60a70af2017-03-26 14:03:52 -07001345 pthread_cond_broadcast(&params.nti.cv);
1346
1347 while (params.nti.writer != nullptr) {
Tianjie Xu3a8d98d2017-04-03 20:01:17 -07001348 if (!params.nti.receiver_available) {
1349 LOG(ERROR) << "missing " << (tgt.blocks() * BLOCKSIZE - params.nti.writer->BytesWritten())
1350 << " bytes of new data";
1351 pthread_mutex_unlock(&params.nti.mu);
1352 return -1;
1353 }
Tao Bao60a70af2017-03-26 14:03:52 -07001354 pthread_cond_wait(&params.nti.cv, &params.nti.mu);
Sami Tolvanen90221202014-12-09 16:39:47 +00001355 }
1356
Tao Bao60a70af2017-03-26 14:03:52 -07001357 pthread_mutex_unlock(&params.nti.mu);
1358 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001359
Tao Baobf5b77d2017-03-30 16:57:29 -07001360 params.written += tgt.blocks();
Sami Tolvanen90221202014-12-09 16:39:47 +00001361
Tao Bao60a70af2017-03-26 14:03:52 -07001362 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001363}
1364
Tao Bao0940fe12015-08-27 16:41:21 -07001365static int PerformCommandDiff(CommandParameters& params) {
Tao Baoc0e1c462017-02-01 10:20:10 -08001366 // <offset> <length>
1367 if (params.cpos + 1 >= params.tokens.size()) {
1368 LOG(ERROR) << "missing patch offset or length for " << params.cmdname;
1369 return -1;
1370 }
Tao Bao0940fe12015-08-27 16:41:21 -07001371
Tao Baoc0e1c462017-02-01 10:20:10 -08001372 size_t offset;
1373 if (!android::base::ParseUint(params.tokens[params.cpos++], &offset)) {
1374 LOG(ERROR) << "invalid patch offset";
1375 return -1;
1376 }
Tao Bao0940fe12015-08-27 16:41:21 -07001377
Tao Baoc0e1c462017-02-01 10:20:10 -08001378 size_t len;
1379 if (!android::base::ParseUint(params.tokens[params.cpos++], &len)) {
1380 LOG(ERROR) << "invalid patch len";
1381 return -1;
1382 }
Tao Bao0940fe12015-08-27 16:41:21 -07001383
Tao Baoc0e1c462017-02-01 10:20:10 -08001384 RangeSet tgt;
1385 size_t blocks = 0;
1386 bool overlap = false;
1387 int status = LoadSrcTgtVersion3(params, tgt, &blocks, false, &overlap);
Tao Bao0940fe12015-08-27 16:41:21 -07001388
Tao Baoc0e1c462017-02-01 10:20:10 -08001389 if (status == -1) {
1390 LOG(ERROR) << "failed to read blocks for diff";
1391 return -1;
1392 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001393
Tao Baoc0e1c462017-02-01 10:20:10 -08001394 if (status == 0) {
1395 params.foundwrites = true;
Tianjie Xu284752e2017-12-05 11:04:17 -08001396 } else {
1397 params.target_verified = true;
1398 if (params.foundwrites) {
1399 LOG(WARNING) << "warning: commands executed out of order [" << params.cmdname << "]";
1400 }
Tao Baoc0e1c462017-02-01 10:20:10 -08001401 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001402
Tao Baoc0e1c462017-02-01 10:20:10 -08001403 if (params.canwrite) {
Sami Tolvanen90221202014-12-09 16:39:47 +00001404 if (status == 0) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001405 LOG(INFO) << "patching " << blocks << " blocks to " << tgt.blocks();
Tao Baoc0e1c462017-02-01 10:20:10 -08001406 Value patch_value(
1407 VAL_BLOB, std::string(reinterpret_cast<const char*>(params.patch_start + offset), len));
Sami Tolvanen90221202014-12-09 16:39:47 +00001408
Tao Bao60a70af2017-03-26 14:03:52 -07001409 RangeSinkWriter writer(params.fd, tgt);
Tao Baoc0e1c462017-02-01 10:20:10 -08001410 if (params.cmdname[0] == 'i') { // imgdiff
Tao Bao1e0941f2017-11-10 11:49:53 -08001411 if (ApplyImagePatch(params.buffer.data(), blocks * BLOCKSIZE, patch_value,
Tao Bao60a70af2017-03-26 14:03:52 -07001412 std::bind(&RangeSinkWriter::Write, &writer, std::placeholders::_1,
1413 std::placeholders::_2),
Tao Bao8b0b0f12018-04-19 21:02:13 -07001414 nullptr) != 0) {
Tao Baoc0e1c462017-02-01 10:20:10 -08001415 LOG(ERROR) << "Failed to apply image patch.";
Tianjie Xu69575552017-05-16 15:51:46 -07001416 failure_type = kPatchApplicationFailure;
Tao Baoc0e1c462017-02-01 10:20:10 -08001417 return -1;
Sami Tolvanen90221202014-12-09 16:39:47 +00001418 }
Tao Baoc0e1c462017-02-01 10:20:10 -08001419 } else {
Tao Bao1e0941f2017-11-10 11:49:53 -08001420 if (ApplyBSDiffPatch(params.buffer.data(), blocks * BLOCKSIZE, patch_value, 0,
Tao Bao60a70af2017-03-26 14:03:52 -07001421 std::bind(&RangeSinkWriter::Write, &writer, std::placeholders::_1,
Tao Bao8b0b0f12018-04-19 21:02:13 -07001422 std::placeholders::_2)) != 0) {
Tao Baoc0e1c462017-02-01 10:20:10 -08001423 LOG(ERROR) << "Failed to apply bsdiff patch.";
Tianjie Xu69575552017-05-16 15:51:46 -07001424 failure_type = kPatchApplicationFailure;
Tao Baoc0e1c462017-02-01 10:20:10 -08001425 return -1;
1426 }
1427 }
1428
1429 // We expect the output of the patcher to fill the tgt ranges exactly.
Tao Bao60a70af2017-03-26 14:03:52 -07001430 if (!writer.Finished()) {
Tao Baoc0e1c462017-02-01 10:20:10 -08001431 LOG(ERROR) << "range sink underrun?";
1432 }
1433 } else {
Tao Baobf5b77d2017-03-30 16:57:29 -07001434 LOG(INFO) << "skipping " << blocks << " blocks already patched to " << tgt.blocks() << " ["
Tao Baoc0e1c462017-02-01 10:20:10 -08001435 << params.cmdline << "]";
Sami Tolvanen90221202014-12-09 16:39:47 +00001436 }
Tao Baoc0e1c462017-02-01 10:20:10 -08001437 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001438
Tao Baoc0e1c462017-02-01 10:20:10 -08001439 if (!params.freestash.empty()) {
1440 FreeStash(params.stashbase, params.freestash);
1441 params.freestash.clear();
1442 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001443
Tao Baobf5b77d2017-03-30 16:57:29 -07001444 params.written += tgt.blocks();
Sami Tolvanen90221202014-12-09 16:39:47 +00001445
Tao Baoc0e1c462017-02-01 10:20:10 -08001446 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001447}
1448
Tao Bao0940fe12015-08-27 16:41:21 -07001449static int PerformCommandErase(CommandParameters& params) {
Tao Baobf5b77d2017-03-30 16:57:29 -07001450 if (DEBUG_ERASE) {
1451 return PerformCommandZero(params);
1452 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001453
Tao Baobf5b77d2017-03-30 16:57:29 -07001454 struct stat sb;
1455 if (fstat(params.fd, &sb) == -1) {
1456 PLOG(ERROR) << "failed to fstat device to erase";
1457 return -1;
1458 }
1459
1460 if (!S_ISBLK(sb.st_mode)) {
1461 LOG(ERROR) << "not a block device; skipping erase";
1462 return -1;
1463 }
1464
1465 if (params.cpos >= params.tokens.size()) {
1466 LOG(ERROR) << "missing target blocks for erase";
1467 return -1;
1468 }
1469
1470 RangeSet tgt = RangeSet::Parse(params.tokens[params.cpos++]);
Tao Bao67983152017-11-04 00:08:08 -07001471 CHECK(static_cast<bool>(tgt));
Tao Baobf5b77d2017-03-30 16:57:29 -07001472
1473 if (params.canwrite) {
1474 LOG(INFO) << " erasing " << tgt.blocks() << " blocks";
1475
1476 for (const auto& range : tgt) {
1477 uint64_t blocks[2];
1478 // offset in bytes
1479 blocks[0] = range.first * static_cast<uint64_t>(BLOCKSIZE);
1480 // length in bytes
1481 blocks[1] = (range.second - range.first) * static_cast<uint64_t>(BLOCKSIZE);
1482
1483 if (ioctl(params.fd, BLKDISCARD, &blocks) == -1) {
1484 PLOG(ERROR) << "BLKDISCARD ioctl failed";
Tao Bao0940fe12015-08-27 16:41:21 -07001485 return -1;
Tao Baobf5b77d2017-03-30 16:57:29 -07001486 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001487 }
Tao Baobf5b77d2017-03-30 16:57:29 -07001488 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001489
Tao Baobf5b77d2017-03-30 16:57:29 -07001490 return 0;
Sami Tolvanen90221202014-12-09 16:39:47 +00001491}
1492
Tao Baoc3901232018-05-21 16:05:56 -07001493using CommandFunction = std::function<int(CommandParameters&)>;
Sami Tolvanen90221202014-12-09 16:39:47 +00001494
Tao Baoc3901232018-05-21 16:05:56 -07001495using CommandMap = std::unordered_map<Command::Type, CommandFunction>;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001496
Tianjie Xuc4447322017-03-06 14:44:59 -08001497static Value* PerformBlockImageUpdate(const char* name, State* state,
1498 const std::vector<std::unique_ptr<Expr>>& argv,
Tao Baoc3901232018-05-21 16:05:56 -07001499 const CommandMap& command_map, bool dryrun) {
Tao Bao33567772017-03-13 14:57:34 -07001500 CommandParameters params = {};
1501 params.canwrite = !dryrun;
Sami Tolvanen90221202014-12-09 16:39:47 +00001502
Tao Bao33567772017-03-13 14:57:34 -07001503 LOG(INFO) << "performing " << (dryrun ? "verification" : "update");
1504 if (state->is_retry) {
1505 is_retry = true;
1506 LOG(INFO) << "This update is a retry.";
1507 }
1508 if (argv.size() != 4) {
1509 ErrorAbort(state, kArgsParsingFailure, "block_image_update expects 4 arguments, got %zu",
1510 argv.size());
1511 return StringValue("");
1512 }
1513
1514 std::vector<std::unique_ptr<Value>> args;
1515 if (!ReadValueArgs(state, argv, &args)) {
1516 return nullptr;
1517 }
1518
Tao Baoc3901232018-05-21 16:05:56 -07001519 // args:
1520 // - block device (or file) to modify in-place
1521 // - transfer list (blob)
1522 // - new data stream (filename within package.zip)
1523 // - patch stream (filename within package.zip, must be uncompressed)
Tao Baoc97edcb2017-03-31 01:18:13 -07001524 const std::unique_ptr<Value>& blockdev_filename = args[0];
1525 const std::unique_ptr<Value>& transfer_list_value = args[1];
1526 const std::unique_ptr<Value>& new_data_fn = args[2];
1527 const std::unique_ptr<Value>& patch_data_fn = args[3];
Tao Bao33567772017-03-13 14:57:34 -07001528
1529 if (blockdev_filename->type != VAL_STRING) {
1530 ErrorAbort(state, kArgsParsingFailure, "blockdev_filename argument to %s must be string", name);
1531 return StringValue("");
1532 }
1533 if (transfer_list_value->type != VAL_BLOB) {
1534 ErrorAbort(state, kArgsParsingFailure, "transfer_list argument to %s must be blob", name);
1535 return StringValue("");
1536 }
1537 if (new_data_fn->type != VAL_STRING) {
1538 ErrorAbort(state, kArgsParsingFailure, "new_data_fn argument to %s must be string", name);
1539 return StringValue("");
1540 }
1541 if (patch_data_fn->type != VAL_STRING) {
1542 ErrorAbort(state, kArgsParsingFailure, "patch_data_fn argument to %s must be string", name);
1543 return StringValue("");
1544 }
1545
1546 UpdaterInfo* ui = static_cast<UpdaterInfo*>(state->cookie);
1547 if (ui == nullptr) {
1548 return StringValue("");
1549 }
1550
1551 FILE* cmd_pipe = ui->cmd_pipe;
1552 ZipArchiveHandle za = ui->package_zip;
1553
1554 if (cmd_pipe == nullptr || za == nullptr) {
1555 return StringValue("");
1556 }
1557
1558 ZipString path_data(patch_data_fn->data.c_str());
1559 ZipEntry patch_entry;
1560 if (FindEntry(za, path_data, &patch_entry) != 0) {
1561 LOG(ERROR) << name << "(): no file \"" << patch_data_fn->data << "\" in package";
1562 return StringValue("");
1563 }
1564
1565 params.patch_start = ui->package_zip_addr + patch_entry.offset;
1566 ZipString new_data(new_data_fn->data.c_str());
1567 ZipEntry new_entry;
1568 if (FindEntry(za, new_data, &new_entry) != 0) {
1569 LOG(ERROR) << name << "(): no file \"" << new_data_fn->data << "\" in package";
1570 return StringValue("");
1571 }
1572
1573 params.fd.reset(TEMP_FAILURE_RETRY(ota_open(blockdev_filename->data.c_str(), O_RDWR)));
1574 if (params.fd == -1) {
1575 PLOG(ERROR) << "open \"" << blockdev_filename->data << "\" failed";
1576 return StringValue("");
1577 }
1578
Tao Bao864c6682018-05-07 11:38:25 -07001579 // Stash directory should be different for each partition to avoid conflicts when updating
1580 // multiple partitions at the same time, so we use the hash of the block device name as the base
1581 // directory.
1582 uint8_t digest[SHA_DIGEST_LENGTH];
1583 SHA1(reinterpret_cast<const uint8_t*>(blockdev_filename->data.data()),
1584 blockdev_filename->data.size(), digest);
1585 params.stashbase = print_sha1(digest);
1586
1587 // Possibly do return early on retry, by checking the marker. If the update on this partition has
1588 // been finished (but interrupted at a later point), there could be leftover on /cache that would
1589 // fail the no-op retry.
1590 std::string updated_marker = GetStashFileName(params.stashbase + ".UPDATED", "", "");
1591 if (is_retry) {
1592 struct stat sb;
1593 int result = stat(updated_marker.c_str(), &sb);
1594 if (result == 0) {
1595 LOG(INFO) << "Skipping already updated partition " << blockdev_filename->data
1596 << " based on marker";
1597 return StringValue("t");
1598 }
1599 } else {
1600 // Delete the obsolete marker if any.
1601 std::string err;
1602 if (!android::base::RemoveFileIfExists(updated_marker, &err)) {
1603 LOG(ERROR) << "Failed to remove partition updated marker " << updated_marker << ": " << err;
1604 return StringValue("");
1605 }
1606 }
1607
Tao Bao33567772017-03-13 14:57:34 -07001608 if (params.canwrite) {
1609 params.nti.za = za;
1610 params.nti.entry = new_entry;
Tianjie Xu107a34f2017-06-29 17:04:21 -07001611 params.nti.brotli_compressed = android::base::EndsWith(new_data_fn->data, ".br");
1612 if (params.nti.brotli_compressed) {
1613 // Initialize brotli decoder state.
1614 params.nti.brotli_decoder_state = BrotliDecoderCreateInstance(nullptr, nullptr, nullptr);
1615 }
Tianjie Xu3a8d98d2017-04-03 20:01:17 -07001616 params.nti.receiver_available = true;
Tao Bao33567772017-03-13 14:57:34 -07001617
1618 pthread_mutex_init(&params.nti.mu, nullptr);
1619 pthread_cond_init(&params.nti.cv, nullptr);
1620 pthread_attr_t attr;
1621 pthread_attr_init(&attr);
1622 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_JOINABLE);
1623
1624 int error = pthread_create(&params.thread, &attr, unzip_new_data, &params.nti);
1625 if (error != 0) {
1626 PLOG(ERROR) << "pthread_create failed";
1627 return StringValue("");
Tianjie Xu7ce287d2016-05-31 09:29:49 -07001628 }
Tao Bao33567772017-03-13 14:57:34 -07001629 }
1630
1631 std::vector<std::string> lines = android::base::Split(transfer_list_value->data, "\n");
1632 if (lines.size() < 2) {
Tianjie Xu5ad80282018-01-28 15:37:48 -08001633 ErrorAbort(state, kArgsParsingFailure, "too few lines in the transfer list [%zd]",
Tao Bao33567772017-03-13 14:57:34 -07001634 lines.size());
1635 return StringValue("");
1636 }
1637
1638 // First line in transfer list is the version number.
1639 if (!android::base::ParseInt(lines[0], &params.version, 3, 4)) {
1640 LOG(ERROR) << "unexpected transfer list version [" << lines[0] << "]";
1641 return StringValue("");
1642 }
1643
1644 LOG(INFO) << "blockimg version is " << params.version;
1645
1646 // Second line in transfer list is the total number of blocks we expect to write.
1647 size_t total_blocks;
1648 if (!android::base::ParseUint(lines[1], &total_blocks)) {
Tianjie Xu5ad80282018-01-28 15:37:48 -08001649 ErrorAbort(state, kArgsParsingFailure, "unexpected block count [%s]", lines[1].c_str());
Tao Bao33567772017-03-13 14:57:34 -07001650 return StringValue("");
1651 }
1652
1653 if (total_blocks == 0) {
1654 return StringValue("t");
1655 }
1656
Tao Bao33567772017-03-13 14:57:34 -07001657 if (lines.size() < 4) {
Tianjie Xu5ad80282018-01-28 15:37:48 -08001658 ErrorAbort(state, kArgsParsingFailure, "too few lines in the transfer list [%zu]",
Tao Bao33567772017-03-13 14:57:34 -07001659 lines.size());
1660 return StringValue("");
1661 }
1662
1663 // Third line is how many stash entries are needed simultaneously.
1664 LOG(INFO) << "maximum stash entries " << lines[2];
1665
1666 // Fourth line is the maximum number of blocks that will be stashed simultaneously
1667 size_t stash_max_blocks;
1668 if (!android::base::ParseUint(lines[3], &stash_max_blocks)) {
Tianjie Xu5ad80282018-01-28 15:37:48 -08001669 ErrorAbort(state, kArgsParsingFailure, "unexpected maximum stash blocks [%s]",
Tao Bao33567772017-03-13 14:57:34 -07001670 lines[3].c_str());
1671 return StringValue("");
1672 }
1673
Tao Bao864c6682018-05-07 11:38:25 -07001674 int res = CreateStash(state, stash_max_blocks, params.stashbase);
Tao Bao33567772017-03-13 14:57:34 -07001675 if (res == -1) {
1676 return StringValue("");
1677 }
1678
1679 params.createdstash = res;
1680
Tao Bao26efb0a2018-05-21 14:59:55 -07001681 // When performing an update, save the index and cmdline of the current command into the
1682 // last_command_file.
Tianjie Xu284752e2017-12-05 11:04:17 -08001683 // Upon resuming an update, read the saved index first; then
1684 // 1. In verification mode, check if the 'move' or 'diff' commands before the saved index has
1685 // the expected target blocks already. If not, these commands cannot be skipped and we need
1686 // to attempt to execute them again. Therefore, we will delete the last_command_file so that
1687 // the update will resume from the start of the transfer list.
1688 // 2. In update mode, skip all commands before the saved index. Therefore, we can avoid deleting
1689 // stashes with duplicate id unintentionally (b/69858743); and also speed up the update.
1690 // If an update succeeds or is unresumable, delete the last_command_file.
Tao Bao26efb0a2018-05-21 14:59:55 -07001691 bool skip_executed_command = true;
1692 size_t saved_last_command_index;
Tianjie Xu284752e2017-12-05 11:04:17 -08001693 if (!ParseLastCommandFile(&saved_last_command_index)) {
1694 DeleteLastCommandFile();
Tao Bao26efb0a2018-05-21 14:59:55 -07001695 // We failed to parse the last command. Disallow skipping executed commands.
1696 skip_executed_command = false;
Tianjie Xu284752e2017-12-05 11:04:17 -08001697 }
1698
Tao Bao33567772017-03-13 14:57:34 -07001699 int rc = -1;
1700
Tao Baoab207062018-05-21 14:48:49 -07001701 static constexpr size_t kTransferListHeaderLines = 4;
Tao Bao33567772017-03-13 14:57:34 -07001702 // Subsequent lines are all individual transfer commands
Tao Baoab207062018-05-21 14:48:49 -07001703 for (size_t i = kTransferListHeaderLines; i < lines.size(); i++) {
Tianjie Xu284752e2017-12-05 11:04:17 -08001704 const std::string& line = lines[i];
Tao Bao33567772017-03-13 14:57:34 -07001705 if (line.empty()) continue;
1706
Tao Bao26efb0a2018-05-21 14:59:55 -07001707 size_t cmdindex = i - kTransferListHeaderLines;
Tao Bao33567772017-03-13 14:57:34 -07001708 params.tokens = android::base::Split(line, " ");
1709 params.cpos = 0;
Tao Baoc3901232018-05-21 16:05:56 -07001710 params.cmdname = params.tokens[params.cpos++];
1711 params.cmdline = line;
Tianjie Xu284752e2017-12-05 11:04:17 -08001712 params.target_verified = false;
Tao Bao33567772017-03-13 14:57:34 -07001713
Tao Baoc3901232018-05-21 16:05:56 -07001714 Command::Type cmd_type = Command::ParseType(params.cmdname);
1715 if (cmd_type == Command::Type::LAST) {
Tao Bao33567772017-03-13 14:57:34 -07001716 LOG(ERROR) << "unexpected command [" << params.cmdname << "]";
1717 goto pbiudone;
Tianjie Xuc4447322017-03-06 14:44:59 -08001718 }
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001719
Tao Baoc3901232018-05-21 16:05:56 -07001720 const CommandFunction& performer = command_map.at(cmd_type);
Tianjie Xu5fe280a2016-10-17 18:15:20 -07001721
Tianjie Xuc2420842018-02-27 17:05:39 -08001722 // Skip the command if we explicitly set the corresponding function pointer to nullptr, e.g.
1723 // "erase" during block_image_verify.
Tao Baoc3901232018-05-21 16:05:56 -07001724 if (performer == nullptr) {
Tianjie Xuc2420842018-02-27 17:05:39 -08001725 LOG(DEBUG) << "skip executing command [" << line << "]";
1726 continue;
Tianjie Xu284752e2017-12-05 11:04:17 -08001727 }
1728
Tao Bao98f875e2018-05-07 15:03:30 -07001729 // Skip all commands before the saved last command index when resuming an update, except for
1730 // "new" command. Because new commands read in the data sequentially.
Tao Bao26efb0a2018-05-21 14:59:55 -07001731 if (params.canwrite && skip_executed_command && cmdindex <= saved_last_command_index &&
Tao Baoc3901232018-05-21 16:05:56 -07001732 cmd_type != Command::Type::NEW) {
Tao Bao26efb0a2018-05-21 14:59:55 -07001733 LOG(INFO) << "Skipping already executed command: " << cmdindex
Tianjie Xu284752e2017-12-05 11:04:17 -08001734 << ", last executed command for previous update: " << saved_last_command_index;
1735 continue;
1736 }
1737
Tao Baoc3901232018-05-21 16:05:56 -07001738 if (performer(params) == -1) {
Tao Bao33567772017-03-13 14:57:34 -07001739 LOG(ERROR) << "failed to execute command [" << line << "]";
1740 goto pbiudone;
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001741 }
1742
Tao Bao26efb0a2018-05-21 14:59:55 -07001743 // In verify mode, check if the commands before the saved last_command_index have been executed
1744 // correctly. If some target blocks have unexpected contents, delete the last command file so
1745 // that we will resume the update from the first command in the transfer list.
1746 if (!params.canwrite && skip_executed_command && cmdindex <= saved_last_command_index) {
Tianjie Xu284752e2017-12-05 11:04:17 -08001747 // TODO(xunchang) check that the cmdline of the saved index is correct.
Tao Baoc3901232018-05-21 16:05:56 -07001748 if ((cmd_type == Command::Type::MOVE || cmd_type == Command::Type::BSDIFF ||
1749 cmd_type == Command::Type::IMGDIFF) &&
Tianjie Xu284752e2017-12-05 11:04:17 -08001750 !params.target_verified) {
1751 LOG(WARNING) << "Previously executed command " << saved_last_command_index << ": "
1752 << params.cmdline << " doesn't produce expected target blocks.";
Tao Bao26efb0a2018-05-21 14:59:55 -07001753 skip_executed_command = false;
Tianjie Xu284752e2017-12-05 11:04:17 -08001754 DeleteLastCommandFile();
1755 }
1756 }
Tao Baoc3901232018-05-21 16:05:56 -07001757
Sami Tolvanen90221202014-12-09 16:39:47 +00001758 if (params.canwrite) {
Tao Bao33567772017-03-13 14:57:34 -07001759 if (ota_fsync(params.fd) == -1) {
Tianjie Xu16255832016-04-30 11:49:59 -07001760 failure_type = kFsyncFailure;
Tao Bao039f2da2016-11-22 16:29:50 -08001761 PLOG(ERROR) << "fsync failed";
Tao Bao33567772017-03-13 14:57:34 -07001762 goto pbiudone;
1763 }
Tianjie Xuc2b2bb52018-05-15 15:09:59 -07001764
Tao Bao26efb0a2018-05-21 14:59:55 -07001765 if (!UpdateLastCommandIndex(cmdindex, params.cmdline)) {
Tianjie Xuc2b2bb52018-05-15 15:09:59 -07001766 LOG(WARNING) << "Failed to update the last command file.";
1767 }
1768
Tao Bao33567772017-03-13 14:57:34 -07001769 fprintf(cmd_pipe, "set_progress %.4f\n", static_cast<double>(params.written) / total_blocks);
1770 fflush(cmd_pipe);
Sami Tolvanen90221202014-12-09 16:39:47 +00001771 }
Tao Bao33567772017-03-13 14:57:34 -07001772 }
Sami Tolvanen90221202014-12-09 16:39:47 +00001773
Tao Bao33567772017-03-13 14:57:34 -07001774 rc = 0;
Tianjie Xu16255832016-04-30 11:49:59 -07001775
Tao Bao33567772017-03-13 14:57:34 -07001776pbiudone:
Tianjie Xu5450c842017-10-18 13:15:21 -07001777 if (params.canwrite) {
1778 pthread_mutex_lock(&params.nti.mu);
1779 if (params.nti.receiver_available) {
1780 LOG(WARNING) << "new data receiver is still available after executing all commands.";
1781 }
1782 params.nti.receiver_available = false;
1783 pthread_cond_broadcast(&params.nti.cv);
1784 pthread_mutex_unlock(&params.nti.mu);
1785 int ret = pthread_join(params.thread, nullptr);
1786 if (ret != 0) {
1787 LOG(WARNING) << "pthread join returned with " << strerror(ret);
1788 }
1789
1790 if (rc == 0) {
1791 LOG(INFO) << "wrote " << params.written << " blocks; expected " << total_blocks;
1792 LOG(INFO) << "stashed " << params.stashed << " blocks";
1793 LOG(INFO) << "max alloc needed was " << params.buffer.size();
1794
1795 const char* partition = strrchr(blockdev_filename->data.c_str(), '/');
1796 if (partition != nullptr && *(partition + 1) != 0) {
1797 fprintf(cmd_pipe, "log bytes_written_%s: %zu\n", partition + 1, params.written * BLOCKSIZE);
1798 fprintf(cmd_pipe, "log bytes_stashed_%s: %zu\n", partition + 1, params.stashed * BLOCKSIZE);
1799 fflush(cmd_pipe);
1800 }
1801 // Delete stash only after successfully completing the update, as it may contain blocks needed
1802 // to complete the update later.
1803 DeleteStash(params.stashbase);
Tianjie Xu284752e2017-12-05 11:04:17 -08001804 DeleteLastCommandFile();
Tao Bao864c6682018-05-07 11:38:25 -07001805
1806 // Create a marker on /cache partition, which allows skipping the update on this partition on
1807 // retry. The marker will be removed once booting into normal boot, or before starting next
1808 // fresh install.
1809 if (!SetPartitionUpdatedMarker(updated_marker)) {
1810 LOG(WARNING) << "Failed to set updated marker; continuing";
1811 }
Tianjie Xu5450c842017-10-18 13:15:21 -07001812 }
1813
1814 pthread_mutex_destroy(&params.nti.mu);
1815 pthread_cond_destroy(&params.nti.cv);
1816 } else if (rc == 0) {
1817 LOG(INFO) << "verified partition contents; update may be resumed";
1818 }
1819
Tao Bao33567772017-03-13 14:57:34 -07001820 if (ota_fsync(params.fd) == -1) {
1821 failure_type = kFsyncFailure;
1822 PLOG(ERROR) << "fsync failed";
1823 }
1824 // params.fd will be automatically closed because it's a unique_fd.
1825
Tianjie Xu107a34f2017-06-29 17:04:21 -07001826 if (params.nti.brotli_decoder_state != nullptr) {
1827 BrotliDecoderDestroyInstance(params.nti.brotli_decoder_state);
1828 }
1829
Tianjie Xu284752e2017-12-05 11:04:17 -08001830 // Delete the last command file if the update cannot be resumed.
1831 if (params.isunresumable) {
1832 DeleteLastCommandFile();
1833 }
1834
Tao Bao33567772017-03-13 14:57:34 -07001835 // Only delete the stash if the update cannot be resumed, or it's a verification run and we
1836 // created the stash.
1837 if (params.isunresumable || (!params.canwrite && params.createdstash)) {
1838 DeleteStash(params.stashbase);
1839 }
1840
1841 if (failure_type != kNoCause && state->cause_code == kNoCause) {
1842 state->cause_code = failure_type;
1843 }
1844
1845 return StringValue(rc == 0 ? "t" : "");
Sami Tolvanen90221202014-12-09 16:39:47 +00001846}
1847
Tao Bao33567772017-03-13 14:57:34 -07001848/**
1849 * The transfer list is a text file containing commands to transfer data from one place to another
1850 * on the target partition. We parse it and execute the commands in order:
1851 *
1852 * zero [rangeset]
1853 * - Fill the indicated blocks with zeros.
1854 *
1855 * new [rangeset]
1856 * - Fill the blocks with data read from the new_data file.
1857 *
1858 * erase [rangeset]
1859 * - Mark the given blocks as empty.
1860 *
1861 * move <...>
1862 * bsdiff <patchstart> <patchlen> <...>
1863 * imgdiff <patchstart> <patchlen> <...>
1864 * - Read the source blocks, apply a patch (or not in the case of move), write result to target
1865 * blocks. bsdiff or imgdiff specifies the type of patch; move means no patch at all.
1866 *
1867 * See the comments in LoadSrcTgtVersion3() for a description of the <...> format.
1868 *
1869 * stash <stash_id> <src_range>
1870 * - Load the given source range and stash the data in the given slot of the stash table.
1871 *
1872 * free <stash_id>
1873 * - Free the given stash data.
1874 *
1875 * The creator of the transfer list will guarantee that no block is read (ie, used as the source for
1876 * a patch or move) after it has been written.
1877 *
1878 * The creator will guarantee that a given stash is loaded (with a stash command) before it's used
1879 * in a move/bsdiff/imgdiff command.
1880 *
1881 * Within one command the source and target ranges may overlap so in general we need to read the
1882 * entire source into memory before writing anything to the target blocks.
1883 *
1884 * All the patch data is concatenated into one patch_data file in the update package. It must be
1885 * stored uncompressed because we memory-map it in directly from the archive. (Since patches are
1886 * already compressed, we lose very little by not compressing their concatenation.)
1887 *
1888 * Commands that read data from the partition (i.e. move/bsdiff/imgdiff/stash) have one or more
1889 * additional hashes before the range parameters, which are used to check if the command has already
1890 * been completed and verify the integrity of the source data.
1891 */
Tianjie Xuc4447322017-03-06 14:44:59 -08001892Value* BlockImageVerifyFn(const char* name, State* state,
1893 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc3901232018-05-21 16:05:56 -07001894 // Commands which are not allowed are set to nullptr to skip them completely.
1895 const CommandMap command_map{
1896 // clang-format off
1897 { Command::Type::BSDIFF, PerformCommandDiff },
1898 { Command::Type::ERASE, nullptr },
1899 { Command::Type::FREE, PerformCommandFree },
1900 { Command::Type::IMGDIFF, PerformCommandDiff },
1901 { Command::Type::MOVE, PerformCommandMove },
1902 { Command::Type::NEW, nullptr },
1903 { Command::Type::STASH, PerformCommandStash },
1904 { Command::Type::ZERO, nullptr },
1905 // clang-format on
1906 };
1907 CHECK_EQ(static_cast<size_t>(Command::Type::LAST), command_map.size());
Sami Tolvanen90221202014-12-09 16:39:47 +00001908
Tao Baoc3901232018-05-21 16:05:56 -07001909 // Perform a dry run without writing to test if an update can proceed.
1910 return PerformBlockImageUpdate(name, state, argv, command_map, true);
Sami Tolvanen90221202014-12-09 16:39:47 +00001911}
1912
Tianjie Xuc4447322017-03-06 14:44:59 -08001913Value* BlockImageUpdateFn(const char* name, State* state,
1914 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc3901232018-05-21 16:05:56 -07001915 const CommandMap command_map{
1916 // clang-format off
1917 { Command::Type::BSDIFF, PerformCommandDiff },
1918 { Command::Type::ERASE, PerformCommandErase },
1919 { Command::Type::FREE, PerformCommandFree },
1920 { Command::Type::IMGDIFF, PerformCommandDiff },
1921 { Command::Type::MOVE, PerformCommandMove },
1922 { Command::Type::NEW, PerformCommandNew },
1923 { Command::Type::STASH, PerformCommandStash },
1924 { Command::Type::ZERO, PerformCommandZero },
1925 // clang-format on
1926 };
1927 CHECK_EQ(static_cast<size_t>(Command::Type::LAST), command_map.size());
Sami Tolvanen90221202014-12-09 16:39:47 +00001928
Tao Baoc3901232018-05-21 16:05:56 -07001929 return PerformBlockImageUpdate(name, state, argv, command_map, false);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001930}
1931
Tianjie Xuc4447322017-03-06 14:44:59 -08001932Value* RangeSha1Fn(const char* name, State* state, const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc97edcb2017-03-31 01:18:13 -07001933 if (argv.size() != 2) {
1934 ErrorAbort(state, kArgsParsingFailure, "range_sha1 expects 2 arguments, got %zu", argv.size());
1935 return StringValue("");
1936 }
1937
1938 std::vector<std::unique_ptr<Value>> args;
1939 if (!ReadValueArgs(state, argv, &args)) {
1940 return nullptr;
1941 }
1942
1943 const std::unique_ptr<Value>& blockdev_filename = args[0];
1944 const std::unique_ptr<Value>& ranges = args[1];
1945
1946 if (blockdev_filename->type != VAL_STRING) {
1947 ErrorAbort(state, kArgsParsingFailure, "blockdev_filename argument to %s must be string", name);
1948 return StringValue("");
1949 }
1950 if (ranges->type != VAL_STRING) {
1951 ErrorAbort(state, kArgsParsingFailure, "ranges argument to %s must be string", name);
1952 return StringValue("");
1953 }
1954
1955 android::base::unique_fd fd(ota_open(blockdev_filename->data.c_str(), O_RDWR));
1956 if (fd == -1) {
1957 ErrorAbort(state, kFileOpenFailure, "open \"%s\" failed: %s", blockdev_filename->data.c_str(),
1958 strerror(errno));
1959 return StringValue("");
1960 }
1961
1962 RangeSet rs = RangeSet::Parse(ranges->data);
Tao Bao67983152017-11-04 00:08:08 -07001963 CHECK(static_cast<bool>(rs));
Tao Baoc97edcb2017-03-31 01:18:13 -07001964
1965 SHA_CTX ctx;
1966 SHA1_Init(&ctx);
1967
1968 std::vector<uint8_t> buffer(BLOCKSIZE);
Tao Baobf5b77d2017-03-30 16:57:29 -07001969 for (const auto& range : rs) {
1970 if (!check_lseek(fd, static_cast<off64_t>(range.first) * BLOCKSIZE, SEEK_SET)) {
Tao Baoc97edcb2017-03-31 01:18:13 -07001971 ErrorAbort(state, kLseekFailure, "failed to seek %s: %s", blockdev_filename->data.c_str(),
1972 strerror(errno));
1973 return StringValue("");
1974 }
1975
Tao Baobf5b77d2017-03-30 16:57:29 -07001976 for (size_t j = range.first; j < range.second; ++j) {
Tao Baoc97edcb2017-03-31 01:18:13 -07001977 if (read_all(fd, buffer, BLOCKSIZE) == -1) {
1978 ErrorAbort(state, kFreadFailure, "failed to read %s: %s", blockdev_filename->data.c_str(),
1979 strerror(errno));
Tianjie Xuc4447322017-03-06 14:44:59 -08001980 return StringValue("");
Tao Baoc97edcb2017-03-31 01:18:13 -07001981 }
1982
1983 SHA1_Update(&ctx, buffer.data(), BLOCKSIZE);
Tianjie Xuc4447322017-03-06 14:44:59 -08001984 }
Tao Baoc97edcb2017-03-31 01:18:13 -07001985 }
1986 uint8_t digest[SHA_DIGEST_LENGTH];
1987 SHA1_Final(digest, &ctx);
Tianjie Xuc4447322017-03-06 14:44:59 -08001988
Tao Baoc97edcb2017-03-31 01:18:13 -07001989 return StringValue(print_sha1(digest));
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07001990}
1991
Tianjie Xu57bed6d2015-12-15 11:47:30 -08001992// This function checks if a device has been remounted R/W prior to an incremental
1993// OTA update. This is an common cause of update abortion. The function reads the
1994// 1st block of each partition and check for mounting time/count. It return string "t"
1995// if executes successfully and an empty string otherwise.
1996
Tianjie Xuc4447322017-03-06 14:44:59 -08001997Value* CheckFirstBlockFn(const char* name, State* state,
1998 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc97edcb2017-03-31 01:18:13 -07001999 if (argv.size() != 1) {
2000 ErrorAbort(state, kArgsParsingFailure, "check_first_block expects 1 argument, got %zu",
2001 argv.size());
2002 return StringValue("");
2003 }
Tianjie Xuc4447322017-03-06 14:44:59 -08002004
Tao Baoc97edcb2017-03-31 01:18:13 -07002005 std::vector<std::unique_ptr<Value>> args;
2006 if (!ReadValueArgs(state, argv, &args)) {
2007 return nullptr;
2008 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002009
Tao Baoc97edcb2017-03-31 01:18:13 -07002010 const std::unique_ptr<Value>& arg_filename = args[0];
Tianjie Xu5fe280a2016-10-17 18:15:20 -07002011
Tao Baoc97edcb2017-03-31 01:18:13 -07002012 if (arg_filename->type != VAL_STRING) {
2013 ErrorAbort(state, kArgsParsingFailure, "filename argument to %s must be string", name);
2014 return StringValue("");
2015 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002016
Tao Baoc97edcb2017-03-31 01:18:13 -07002017 android::base::unique_fd fd(ota_open(arg_filename->data.c_str(), O_RDONLY));
2018 if (fd == -1) {
2019 ErrorAbort(state, kFileOpenFailure, "open \"%s\" failed: %s", arg_filename->data.c_str(),
2020 strerror(errno));
2021 return StringValue("");
2022 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002023
Tao Baobf5b77d2017-03-30 16:57:29 -07002024 RangeSet blk0(std::vector<Range>{ Range{ 0, 1 } });
Tao Baoc97edcb2017-03-31 01:18:13 -07002025 std::vector<uint8_t> block0_buffer(BLOCKSIZE);
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002026
Tao Baoc97edcb2017-03-31 01:18:13 -07002027 if (ReadBlocks(blk0, block0_buffer, fd) == -1) {
2028 ErrorAbort(state, kFreadFailure, "failed to read %s: %s", arg_filename->data.c_str(),
2029 strerror(errno));
2030 return StringValue("");
2031 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002032
Tao Baoc97edcb2017-03-31 01:18:13 -07002033 // https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout
2034 // Super block starts from block 0, offset 0x400
2035 // 0x2C: len32 Mount time
2036 // 0x30: len32 Write time
2037 // 0x34: len16 Number of mounts since the last fsck
2038 // 0x38: len16 Magic signature 0xEF53
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002039
Tao Baoc97edcb2017-03-31 01:18:13 -07002040 time_t mount_time = *reinterpret_cast<uint32_t*>(&block0_buffer[0x400 + 0x2C]);
2041 uint16_t mount_count = *reinterpret_cast<uint16_t*>(&block0_buffer[0x400 + 0x34]);
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002042
Tao Baoc97edcb2017-03-31 01:18:13 -07002043 if (mount_count > 0) {
2044 uiPrintf(state, "Device was remounted R/W %" PRIu16 " times", mount_count);
2045 uiPrintf(state, "Last remount happened on %s", ctime(&mount_time));
2046 }
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002047
Tao Baoc97edcb2017-03-31 01:18:13 -07002048 return StringValue("t");
Tianjie Xu57bed6d2015-12-15 11:47:30 -08002049}
2050
Tianjie Xuc4447322017-03-06 14:44:59 -08002051Value* BlockImageRecoverFn(const char* name, State* state,
2052 const std::vector<std::unique_ptr<Expr>>& argv) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002053 if (argv.size() != 2) {
2054 ErrorAbort(state, kArgsParsingFailure, "block_image_recover expects 2 arguments, got %zu",
2055 argv.size());
2056 return StringValue("");
2057 }
2058
2059 std::vector<std::unique_ptr<Value>> args;
2060 if (!ReadValueArgs(state, argv, &args)) {
2061 return nullptr;
2062 }
2063
2064 const std::unique_ptr<Value>& filename = args[0];
2065 const std::unique_ptr<Value>& ranges = args[1];
2066
2067 if (filename->type != VAL_STRING) {
2068 ErrorAbort(state, kArgsParsingFailure, "filename argument to %s must be string", name);
2069 return StringValue("");
2070 }
2071 if (ranges->type != VAL_STRING) {
2072 ErrorAbort(state, kArgsParsingFailure, "ranges argument to %s must be string", name);
2073 return StringValue("");
2074 }
Tao Bao67983152017-11-04 00:08:08 -07002075 RangeSet rs = RangeSet::Parse(ranges->data);
2076 if (!rs) {
2077 ErrorAbort(state, kArgsParsingFailure, "failed to parse ranges: %s", ranges->data.c_str());
2078 return StringValue("");
2079 }
Tao Baoc97edcb2017-03-31 01:18:13 -07002080
2081 // Output notice to log when recover is attempted
2082 LOG(INFO) << filename->data << " image corrupted, attempting to recover...";
2083
2084 // When opened with O_RDWR, libfec rewrites corrupted blocks when they are read
2085 fec::io fh(filename->data, O_RDWR);
2086
2087 if (!fh) {
2088 ErrorAbort(state, kLibfecFailure, "fec_open \"%s\" failed: %s", filename->data.c_str(),
2089 strerror(errno));
2090 return StringValue("");
2091 }
2092
2093 if (!fh.has_ecc() || !fh.has_verity()) {
2094 ErrorAbort(state, kLibfecFailure, "unable to use metadata to correct errors");
2095 return StringValue("");
2096 }
2097
2098 fec_status status;
Tao Baoc97edcb2017-03-31 01:18:13 -07002099 if (!fh.get_status(status)) {
2100 ErrorAbort(state, kLibfecFailure, "failed to read FEC status");
2101 return StringValue("");
2102 }
2103
Tao Baoc97edcb2017-03-31 01:18:13 -07002104 uint8_t buffer[BLOCKSIZE];
Tao Bao67983152017-11-04 00:08:08 -07002105 for (const auto& range : rs) {
Tao Baobf5b77d2017-03-30 16:57:29 -07002106 for (size_t j = range.first; j < range.second; ++j) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002107 // Stay within the data area, libfec validates and corrects metadata
Tao Baobf5b77d2017-03-30 16:57:29 -07002108 if (status.data_size <= static_cast<uint64_t>(j) * BLOCKSIZE) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002109 continue;
2110 }
2111
Tao Baobf5b77d2017-03-30 16:57:29 -07002112 if (fh.pread(buffer, BLOCKSIZE, static_cast<off64_t>(j) * BLOCKSIZE) != BLOCKSIZE) {
Tao Baoc97edcb2017-03-31 01:18:13 -07002113 ErrorAbort(state, kLibfecFailure, "failed to recover %s (block %zu): %s",
2114 filename->data.c_str(), j, strerror(errno));
Tianjie Xuc4447322017-03-06 14:44:59 -08002115 return StringValue("");
Tao Baoc97edcb2017-03-31 01:18:13 -07002116 }
2117
2118 // If we want to be able to recover from a situation where rewriting a corrected
2119 // block doesn't guarantee the same data will be returned when re-read later, we
2120 // can save a copy of corrected blocks to /cache. Note:
2121 //
2122 // 1. Maximum space required from /cache is the same as the maximum number of
2123 // corrupted blocks we can correct. For RS(255, 253) and a 2 GiB partition,
2124 // this would be ~16 MiB, for example.
2125 //
2126 // 2. To find out if this block was corrupted, call fec_get_status after each
2127 // read and check if the errors field value has increased.
Tianjie Xuc4447322017-03-06 14:44:59 -08002128 }
Tao Baoc97edcb2017-03-31 01:18:13 -07002129 }
2130 LOG(INFO) << "..." << filename->data << " image recovered successfully.";
2131 return StringValue("t");
Sami Tolvanen0a7b4732015-06-25 10:25:36 +01002132}
2133
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07002134void RegisterBlockImageFunctions() {
Tao Baoc97edcb2017-03-31 01:18:13 -07002135 RegisterFunction("block_image_verify", BlockImageVerifyFn);
2136 RegisterFunction("block_image_update", BlockImageUpdateFn);
2137 RegisterFunction("block_image_recover", BlockImageRecoverFn);
2138 RegisterFunction("check_first_block", CheckFirstBlockFn);
2139 RegisterFunction("range_sha1", RangeSha1Fn);
Doug Zongkerbc7ffed2014-08-15 14:31:52 -07002140}