Merge "updater: Drop the support for BBOTA v1 and v2." am: 5479506c9c am: 7b82ad12f6

am: 0ec16d8831

Change-Id: Iaa368fdab1940c3b206e9c43396c364790f707b8
This commit is contained in:
Tao Bao 2017-03-24 23:17:09 +00:00 committed by android-build-merger
commit eb7c0dc6d0

View file

@ -429,46 +429,11 @@ struct CommandParameters {
uint8_t* patch_start; uint8_t* patch_start;
}; };
// Do a source/target load for move/bsdiff/imgdiff in version 1.
// We expect to parse the remainder of the parameter tokens as:
//
// <src_range> <tgt_range>
//
// The source range is loaded into the provided buffer, reallocating
// it to make it larger if necessary.
static int LoadSrcTgtVersion1(CommandParameters& params, RangeSet& tgt, size_t& src_blocks,
std::vector<uint8_t>& buffer, int fd) {
if (params.cpos + 1 >= params.tokens.size()) {
LOG(ERROR) << "invalid parameters";
return -1;
}
// <src_range>
RangeSet src = parse_range(params.tokens[params.cpos++]);
// <tgt_range>
tgt = parse_range(params.tokens[params.cpos++]);
allocate(src.size * BLOCKSIZE, buffer);
int rc = ReadBlocks(src, buffer, fd);
src_blocks = src.size;
return rc;
}
// Print the hash in hex for corrupted source blocks (excluding the stashed blocks which is // Print the hash in hex for corrupted source blocks (excluding the stashed blocks which is
// handled separately). // handled separately).
static void PrintHashForCorruptedSourceBlocks(const CommandParameters& params, static void PrintHashForCorruptedSourceBlocks(const CommandParameters& params,
const std::vector<uint8_t>& buffer) { const std::vector<uint8_t>& buffer) {
LOG(INFO) << "unexpected contents of source blocks in cmd:\n" << params.cmdline; LOG(INFO) << "unexpected contents of source blocks in cmd:\n" << params.cmdline;
if (params.version < 3) {
// TODO handle version 1,2
LOG(WARNING) << "version number " << params.version << " is not supported to print hashes";
return;
}
CHECK(params.tokens[0] == "move" || params.tokens[0] == "bsdiff" || CHECK(params.tokens[0] == "move" || params.tokens[0] == "bsdiff" ||
params.tokens[0] == "imgdiff"); params.tokens[0] == "imgdiff");
@ -896,20 +861,18 @@ static int CreateStash(State* state, size_t maxblocks, const std::string& blockd
} }
static int SaveStash(CommandParameters& params, const std::string& base, static int SaveStash(CommandParameters& params, const std::string& base,
std::vector<uint8_t>& buffer, int fd, bool usehash) { std::vector<uint8_t>& buffer, int fd) {
// <stash_id> <src_range> // <stash_id> <src_range>
if (params.cpos + 1 >= params.tokens.size()) { if (params.cpos + 1 >= params.tokens.size()) {
LOG(ERROR) << "missing id and/or src range fields in stash command"; LOG(ERROR) << "missing id and/or src range fields in stash command";
return -1; return -1;
} }
const std::string& id = params.tokens[params.cpos++];
const std::string& id = params.tokens[params.cpos++];
size_t blocks = 0; size_t blocks = 0;
if (usehash && LoadStash(params, base, id, true, &blocks, buffer, false) == 0) { if (LoadStash(params, base, id, true, &blocks, buffer, false) == 0) {
// Stash file already exists and has expected contents. Do not // Stash file already exists and has expected contents. Do not read from source again, as the
// read from source again, as the source may have been already // source may have been already overwritten during a previous attempt.
// overwritten during a previous attempt.
return 0; return 0;
} }
@ -922,17 +885,16 @@ static int SaveStash(CommandParameters& params, const std::string& base,
blocks = src.size; blocks = src.size;
stash_map[id] = src; stash_map[id] = src;
if (usehash && VerifyBlocks(id, buffer, blocks, true) != 0) { if (VerifyBlocks(id, buffer, blocks, true) != 0) {
// Source blocks have unexpected contents. If we actually need this // Source blocks have unexpected contents. If we actually need this data later, this is an
// data later, this is an unrecoverable error. However, the command // unrecoverable error. However, the command that uses the data may have already completed
// that uses the data may have already completed previously, so the // previously, so the possible failure will occur during source block verification.
// possible failure will occur during source block verification.
LOG(ERROR) << "failed to load source blocks for stash " << id; LOG(ERROR) << "failed to load source blocks for stash " << id;
return 0; return 0;
} }
// In verify mode, we don't need to stash any blocks. // In verify mode, we don't need to stash any blocks.
if (!params.canwrite && usehash) { if (!params.canwrite) {
return 0; return 0;
} }
@ -1061,26 +1023,35 @@ static int LoadSrcTgtVersion2(CommandParameters& params, RangeSet& tgt, size_t&
return 0; return 0;
} }
// Do a source/target load for move/bsdiff/imgdiff in version 3. /**
// * Do a source/target load for move/bsdiff/imgdiff in version 3.
// Parameters are the same as for LoadSrcTgtVersion2, except for 'onehash', which *
// tells the function whether to expect separate source and targe block hashes, or * We expect to parse the remainder of the parameter tokens as one of:
// if they are both the same and only one hash should be expected, and *
// 'isunresumable', which receives a non-zero value if block verification fails in * <tgt_range> <src_block_count> <src_range>
// a way that the update cannot be resumed anymore. * (loads data from source image only)
// *
// If the function is unable to load the necessary blocks or their contents don't * <tgt_range> <src_block_count> - <[stash_id:stash_range] ...>
// match the hashes, the return value is -1 and the command should be aborted. * (loads data from stashes only)
// *
// If the return value is 1, the command has already been completed according to * <tgt_range> <src_block_count> <src_range> <src_loc> <[stash_id:stash_range] ...>
// the contents of the target blocks, and should not be performed again. * (loads data from both source image and stashes)
// *
// If the return value is 0, source blocks have expected content and the command * Parameters are the same as for LoadSrcTgtVersion2, except for 'onehash', which tells the function
// can be performed. * whether to expect separate source and targe block hashes, or if they are both the same and only
* one hash should be expected, and 'isunresumable', which receives a non-zero value if block
* verification fails in a way that the update cannot be resumed anymore.
*
* If the function is unable to load the necessary blocks or their contents don't match the hashes,
* the return value is -1 and the command should be aborted.
*
* If the return value is 1, the command has already been completed according to the contents of the
* target blocks, and should not be performed again.
*
* If the return value is 0, source blocks have expected content and the command can be performed.
*/
static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t& src_blocks, static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t& src_blocks,
bool onehash, bool& overlap) { bool onehash, bool& overlap) {
if (params.cpos >= params.tokens.size()) { if (params.cpos >= params.tokens.size()) {
LOG(ERROR) << "missing source hash"; LOG(ERROR) << "missing source hash";
return -1; return -1;
@ -1099,8 +1070,8 @@ static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t&
tgthash = params.tokens[params.cpos++]; tgthash = params.tokens[params.cpos++];
} }
if (LoadSrcTgtVersion2(params, tgt, src_blocks, params.buffer, params.fd, if (LoadSrcTgtVersion2(params, tgt, src_blocks, params.buffer, params.fd, params.stashbase,
params.stashbase, &overlap) == -1) { &overlap) == -1) {
return -1; return -1;
} }
@ -1111,7 +1082,7 @@ static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t&
} }
if (VerifyBlocks(tgthash, tgtbuffer, tgt.size, false) == 0) { if (VerifyBlocks(tgthash, tgtbuffer, tgt.size, false) == 0) {
// Target blocks already have expected content, command should be skipped // Target blocks already have expected content, command should be skipped.
return 1; return 1;
} }
@ -1130,13 +1101,13 @@ static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t&
} }
params.stashed += src_blocks; params.stashed += src_blocks;
// Can be deleted when the write has completed // Can be deleted when the write has completed.
if (!stash_exists) { if (!stash_exists) {
params.freestash = srchash; params.freestash = srchash;
} }
} }
// Source blocks have expected content, command can proceed // Source blocks have expected content, command can proceed.
return 0; return 0;
} }
@ -1148,7 +1119,7 @@ static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t&
return 0; return 0;
} }
// Valid source data not available, update cannot be resumed // Valid source data not available, update cannot be resumed.
LOG(ERROR) << "partition has unexpected contents"; LOG(ERROR) << "partition has unexpected contents";
PrintHashForCorruptedSourceBlocks(params, params.buffer); PrintHashForCorruptedSourceBlocks(params, params.buffer);
@ -1160,17 +1131,8 @@ static int LoadSrcTgtVersion3(CommandParameters& params, RangeSet& tgt, size_t&
static int PerformCommandMove(CommandParameters& params) { static int PerformCommandMove(CommandParameters& params) {
size_t blocks = 0; size_t blocks = 0;
bool overlap = false; bool overlap = false;
int status = 0;
RangeSet tgt; RangeSet tgt;
int status = LoadSrcTgtVersion3(params, tgt, blocks, true, overlap);
if (params.version == 1) {
status = LoadSrcTgtVersion1(params, tgt, blocks, params.buffer, params.fd);
} else if (params.version == 2) {
status = LoadSrcTgtVersion2(params, tgt, blocks, params.buffer, params.fd,
params.stashbase, nullptr);
} else if (params.version >= 3) {
status = LoadSrcTgtVersion3(params, tgt, blocks, true, overlap);
}
if (status == -1) { if (status == -1) {
LOG(ERROR) << "failed to read blocks for move"; LOG(ERROR) << "failed to read blocks for move";
@ -1193,7 +1155,6 @@ static int PerformCommandMove(CommandParameters& params) {
} else { } else {
LOG(INFO) << "skipping " << blocks << " already moved blocks"; LOG(INFO) << "skipping " << blocks << " already moved blocks";
} }
} }
if (!params.freestash.empty()) { if (!params.freestash.empty()) {
@ -1207,8 +1168,7 @@ static int PerformCommandMove(CommandParameters& params) {
} }
static int PerformCommandStash(CommandParameters& params) { static int PerformCommandStash(CommandParameters& params) {
return SaveStash(params, params.stashbase, params.buffer, params.fd, return SaveStash(params, params.stashbase, params.buffer, params.fd);
(params.version >= 3));
} }
static int PerformCommandFree(CommandParameters& params) { static int PerformCommandFree(CommandParameters& params) {
@ -1337,15 +1297,7 @@ static int PerformCommandDiff(CommandParameters& params) {
RangeSet tgt; RangeSet tgt;
size_t blocks = 0; size_t blocks = 0;
bool overlap = false; bool overlap = false;
int status = 0; int status = LoadSrcTgtVersion3(params, tgt, blocks, false, overlap);
if (params.version == 1) {
status = LoadSrcTgtVersion1(params, tgt, blocks, params.buffer, params.fd);
} else if (params.version == 2) {
status = LoadSrcTgtVersion2(params, tgt, blocks, params.buffer, params.fd,
params.stashbase, nullptr);
} else if (params.version >= 3) {
status = LoadSrcTgtVersion3(params, tgt, blocks, false, overlap);
}
if (status == -1) { if (status == -1) {
LOG(ERROR) << "failed to read blocks for diff"; LOG(ERROR) << "failed to read blocks for diff";
@ -1496,8 +1448,7 @@ static Value* PerformBlockImageUpdate(const char* name, State* state,
const Value* patch_data_fn = args[3].get(); const Value* patch_data_fn = args[3].get();
if (blockdev_filename->type != VAL_STRING) { if (blockdev_filename->type != VAL_STRING) {
ErrorAbort(state, kArgsParsingFailure, "blockdev_filename argument to %s must be string", ErrorAbort(state, kArgsParsingFailure, "blockdev_filename argument to %s must be string", name);
name);
return StringValue(""); return StringValue("");
} }
if (transfer_list_value->type != VAL_BLOB) { if (transfer_list_value->type != VAL_BLOB) {
@ -1509,8 +1460,7 @@ static Value* PerformBlockImageUpdate(const char* name, State* state,
return StringValue(""); return StringValue("");
} }
if (patch_data_fn->type != VAL_STRING) { if (patch_data_fn->type != VAL_STRING) {
ErrorAbort(state, kArgsParsingFailure, "patch_data_fn argument to %s must be string", ErrorAbort(state, kArgsParsingFailure, "patch_data_fn argument to %s must be string", name);
name);
return StringValue(""); return StringValue("");
} }
@ -1571,15 +1521,15 @@ static Value* PerformBlockImageUpdate(const char* name, State* state,
return StringValue(""); return StringValue("");
} }
// First line in transfer list is the version number // First line in transfer list is the version number.
if (!android::base::ParseInt(lines[0], &params.version, 1, 4)) { if (!android::base::ParseInt(lines[0], &params.version, 3, 4)) {
LOG(ERROR) << "unexpected transfer list version [" << lines[0] << "]"; LOG(ERROR) << "unexpected transfer list version [" << lines[0] << "]";
return StringValue(""); return StringValue("");
} }
LOG(INFO) << "blockimg version is " << params.version; LOG(INFO) << "blockimg version is " << params.version;
// Second line in transfer list is the total number of blocks we expect to write // Second line in transfer list is the total number of blocks we expect to write.
size_t total_blocks; size_t total_blocks;
if (!android::base::ParseUint(lines[1], &total_blocks)) { if (!android::base::ParseUint(lines[1], &total_blocks)) {
ErrorAbort(state, kArgsParsingFailure, "unexpected block count [%s]\n", lines[1].c_str()); ErrorAbort(state, kArgsParsingFailure, "unexpected block count [%s]\n", lines[1].c_str());
@ -1591,14 +1541,13 @@ static Value* PerformBlockImageUpdate(const char* name, State* state,
} }
size_t start = 2; size_t start = 2;
if (params.version >= 2) {
if (lines.size() < 4) { if (lines.size() < 4) {
ErrorAbort(state, kArgsParsingFailure, "too few lines in the transfer list [%zu]\n", ErrorAbort(state, kArgsParsingFailure, "too few lines in the transfer list [%zu]\n",
lines.size()); lines.size());
return StringValue(""); return StringValue("");
} }
// Third line is how many stash entries are needed simultaneously // Third line is how many stash entries are needed simultaneously.
LOG(INFO) << "maximum stash entries " << lines[2]; LOG(INFO) << "maximum stash entries " << lines[2];
// Fourth line is the maximum number of blocks that will be stashed simultaneously // Fourth line is the maximum number of blocks that will be stashed simultaneously
@ -1617,14 +1566,12 @@ static Value* PerformBlockImageUpdate(const char* name, State* state,
params.createdstash = res; params.createdstash = res;
start += 2; start += 2;
}
// Build a map of the available commands // Build a map of the available commands
std::unordered_map<std::string, const Command*> cmd_map; std::unordered_map<std::string, const Command*> cmd_map;
for (size_t i = 0; i < cmdcount; ++i) { for (size_t i = 0; i < cmdcount; ++i) {
if (cmd_map.find(commands[i].name) != cmd_map.end()) { if (cmd_map.find(commands[i].name) != cmd_map.end()) {
LOG(ERROR) << "Error: command [" << commands[i].name LOG(ERROR) << "Error: command [" << commands[i].name << "] already exists in the cmd map.";
<< "] already exists in the cmd map.";
return StringValue(strdup("")); return StringValue(strdup(""));
} }
cmd_map[commands[i].name] = &commands[i]; cmd_map[commands[i].name] = &commands[i];
@ -1660,8 +1607,7 @@ static Value* PerformBlockImageUpdate(const char* name, State* state,
PLOG(ERROR) << "fsync failed"; PLOG(ERROR) << "fsync failed";
goto pbiudone; goto pbiudone;
} }
fprintf(cmd_pipe, "set_progress %.4f\n", fprintf(cmd_pipe, "set_progress %.4f\n", static_cast<double>(params.written) / total_blocks);
static_cast<double>(params.written) / total_blocks);
fflush(cmd_pipe); fflush(cmd_pipe);
} }
} }
@ -1675,14 +1621,12 @@ static Value* PerformBlockImageUpdate(const char* name, State* state,
const char* partition = strrchr(blockdev_filename->data.c_str(), '/'); const char* partition = strrchr(blockdev_filename->data.c_str(), '/');
if (partition != nullptr && *(partition + 1) != 0) { if (partition != nullptr && *(partition + 1) != 0) {
fprintf(cmd_pipe, "log bytes_written_%s: %zu\n", partition + 1, fprintf(cmd_pipe, "log bytes_written_%s: %zu\n", partition + 1, params.written * BLOCKSIZE);
params.written * BLOCKSIZE); fprintf(cmd_pipe, "log bytes_stashed_%s: %zu\n", partition + 1, params.stashed * BLOCKSIZE);
fprintf(cmd_pipe, "log bytes_stashed_%s: %zu\n", partition + 1,
params.stashed * BLOCKSIZE);
fflush(cmd_pipe); fflush(cmd_pipe);
} }
// Delete stash only after successfully completing the update, as it // Delete stash only after successfully completing the update, as it may contain blocks needed
// may contain blocks needed to complete the update later. // to complete the update later.
DeleteStash(params.stashbase); DeleteStash(params.stashbase);
} else { } else {
LOG(INFO) << "verified partition contents; update may be resumed"; LOG(INFO) << "verified partition contents; update may be resumed";
@ -1697,8 +1641,8 @@ pbiudone:
} }
// params.fd will be automatically closed because it's a unique_fd. // params.fd will be automatically closed because it's a unique_fd.
// Only delete the stash if the update cannot be resumed, or it's // Only delete the stash if the update cannot be resumed, or it's a verification run and we
// a verification run and we created the stash. // created the stash.
if (params.isunresumable || (!params.canwrite && params.createdstash)) { if (params.isunresumable || (!params.canwrite && params.createdstash)) {
DeleteStash(params.stashbase); DeleteStash(params.stashbase);
} }
@ -1710,62 +1654,50 @@ pbiudone:
return StringValue(rc == 0 ? "t" : ""); return StringValue(rc == 0 ? "t" : "");
} }
// The transfer list is a text file containing commands to /**
// transfer data from one place to another on the target * The transfer list is a text file containing commands to transfer data from one place to another
// partition. We parse it and execute the commands in order: * on the target partition. We parse it and execute the commands in order:
// *
// zero [rangeset] * zero [rangeset]
// - fill the indicated blocks with zeros * - Fill the indicated blocks with zeros.
// *
// new [rangeset] * new [rangeset]
// - fill the blocks with data read from the new_data file * - Fill the blocks with data read from the new_data file.
// *
// erase [rangeset] * erase [rangeset]
// - mark the given blocks as empty * - Mark the given blocks as empty.
// *
// move <...> * move <...>
// bsdiff <patchstart> <patchlen> <...> * bsdiff <patchstart> <patchlen> <...>
// imgdiff <patchstart> <patchlen> <...> * imgdiff <patchstart> <patchlen> <...>
// - read the source blocks, apply a patch (or not in the * - Read the source blocks, apply a patch (or not in the case of move), write result to target
// case of move), write result to target blocks. bsdiff or * blocks. bsdiff or imgdiff specifies the type of patch; move means no patch at all.
// imgdiff specifies the type of patch; move means no patch *
// at all. * See the comments in LoadSrcTgtVersion3() for a description of the <...> format.
// *
// The format of <...> differs between versions 1 and 2; * stash <stash_id> <src_range>
// see the LoadSrcTgtVersion{1,2}() functions for a * - Load the given source range and stash the data in the given slot of the stash table.
// description of what's expected. *
// * free <stash_id>
// stash <stash_id> <src_range> * - Free the given stash data.
// - (version 2+ only) load the given source range and stash *
// the data in the given slot of the stash table. * The creator of the transfer list will guarantee that no block is read (ie, used as the source for
// * a patch or move) after it has been written.
// free <stash_id> *
// - (version 3+ only) free the given stash data. * The creator will guarantee that a given stash is loaded (with a stash command) before it's used
// * in a move/bsdiff/imgdiff command.
// The creator of the transfer list will guarantee that no block *
// is read (ie, used as the source for a patch or move) after it * Within one command the source and target ranges may overlap so in general we need to read the
// has been written. * entire source into memory before writing anything to the target blocks.
// *
// In version 2, the creator will guarantee that a given stash is * All the patch data is concatenated into one patch_data file in the update package. It must be
// loaded (with a stash command) before it's used in a * stored uncompressed because we memory-map it in directly from the archive. (Since patches are
// move/bsdiff/imgdiff command. * already compressed, we lose very little by not compressing their concatenation.)
// *
// Within one command the source and target ranges may overlap so * Commands that read data from the partition (i.e. move/bsdiff/imgdiff/stash) have one or more
// in general we need to read the entire source into memory before * additional hashes before the range parameters, which are used to check if the command has already
// writing anything to the target blocks. * been completed and verify the integrity of the source data.
// */
// All the patch data is concatenated into one patch_data file in
// the update package. It must be stored uncompressed because we
// memory-map it in directly from the archive. (Since patches are
// already compressed, we lose very little by not compressing
// their concatenation.)
//
// In version 3, commands that read data from the partition (i.e.
// move/bsdiff/imgdiff/stash) have one or more additional hashes
// before the range parameters, which are used to check if the
// command has already been completed and verify the integrity of
// the source data.
Value* BlockImageVerifyFn(const char* name, State* state, Value* BlockImageVerifyFn(const char* name, State* state,
const std::vector<std::unique_ptr<Expr>>& argv) { const std::vector<std::unique_ptr<Expr>>& argv) {
// Commands which are not tested are set to nullptr to skip them completely // Commands which are not tested are set to nullptr to skip them completely