Merge "updater: Add SourceInfo::{ReadAll,DumpBuffer,Overlaps}." (d460afe9) · Commits · e / os / android_bootable_recovery

tests/unit/commands_test.cpp

+116 −0

Original line number	Diff line number	Diff line
		@@ -14,10 +14,13 @@
		* limitations under the License.
		*/

		#include <algorithm>
		#include <string>

		#include <gtest/gtest.h>
		#include <openssl/sha.h>

		#include "otautil/print_sha1.h"
		#include "otautil/rangeset.h"
		#include "private/commands.h"

		@@ -380,3 +383,116 @@ TEST(CommandsTest, Parse_InvalidNumberOfArgs) {
		ASSERT_FALSE(Command::Parse(input, 0, &err));
		}
		}

		TEST(SourceInfoTest, Overlaps) {
		ASSERT_TRUE(SourceInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 7, 9 }, { 16, 20 } }), {}, {})
		.Overlaps(TargetInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 7, 9 }, { 16, 20 } }))));

		ASSERT_TRUE(SourceInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 7, 9 }, { 16, 20 } }), {}, {})
		.Overlaps(TargetInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 4, 7 }, { 16, 23 } }))));

		ASSERT_FALSE(SourceInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 7, 9 }, { 16, 20 } }), {}, {})
		.Overlaps(TargetInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 9, 16 } }))));
		}

		TEST(SourceInfoTest, Overlaps_EmptySourceOrTarget) {
		ASSERT_FALSE(SourceInfo().Overlaps(TargetInfo()));

		ASSERT_FALSE(SourceInfo().Overlaps(
		TargetInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb", RangeSet({ { 7, 9 }, { 16, 20 } }))));

		ASSERT_FALSE(SourceInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 7, 9 }, { 16, 20 } }), {}, {})
		.Overlaps(TargetInfo()));
		}

		TEST(SourceInfoTest, Overlaps_WithStashes) {
		ASSERT_FALSE(SourceInfo("a6cbdf3f416960f02189d3a814ec7e9e95c44a0d",
		RangeSet({ { 81, 175 }, { 265, 266 } }), // source ranges
		RangeSet({ { 0, 94 }, { 95, 96 } }), // source location
		{ StashInfo("9eedf00d11061549e32503cadf054ec6fbfa7a23",
		RangeSet({ { 94, 95 } })) })
		.Overlaps(TargetInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 175, 265 } }))));

		ASSERT_TRUE(SourceInfo("a6cbdf3f416960f02189d3a814ec7e9e95c44a0d",
		RangeSet({ { 81, 175 }, { 265, 266 } }), // source ranges
		RangeSet({ { 0, 94 }, { 95, 96 } }), // source location
		{ StashInfo("9eedf00d11061549e32503cadf054ec6fbfa7a23",
		RangeSet({ { 94, 95 } })) })
		.Overlaps(TargetInfo("1d74d1a60332fd38cf9405f1bae67917888da6cb",
		RangeSet({ { 265, 266 } }))));
		}

		// The block size should be specified by the caller of ReadAll (i.e. from Command instance during
		// normal run).
		constexpr size_t kBlockSize = 4096;

		TEST(SourceInfoTest, ReadAll) {
		// "2727756cfee3fbfe24bf5650123fd7743d7b3465" is the SHA-1 hex digest of 8192 * 'a'.
		const SourceInfo source("2727756cfee3fbfe24bf5650123fd7743d7b3465", RangeSet({ { 0, 2 } }), {},
		{});
		auto block_reader = [](const RangeSet& src, std::vector<uint8_t>* block_buffer) -> int {
		std::fill_n(block_buffer->begin(), src.blocks() * kBlockSize, 'a');
		return 0;
		};
		auto stash_reader = [](const std::string&, std::vector<uint8_t>*) -> int { return 0; };
		std::vector<uint8_t> buffer(source.blocks() * kBlockSize);
		ASSERT_TRUE(source.ReadAll(&buffer, kBlockSize, block_reader, stash_reader));
		ASSERT_EQ(source.blocks() * kBlockSize, buffer.size());

		uint8_t digest[SHA_DIGEST_LENGTH];
		SHA1(buffer.data(), buffer.size(), digest);
		ASSERT_EQ(source.hash(), print_sha1(digest));
		}

		TEST(SourceInfoTest, ReadAll_WithStashes) {
		const SourceInfo source(
		// SHA-1 hex digest of 8192 * 'a' + 4096 * 'b'.
		"ee3ebea26130769c10ad13604712100346d48660", RangeSet({ { 0, 2 } }), RangeSet({ { 0, 2 } }),
		{ StashInfo("1e41f7a59e80c6eb4dc043caae80d273f130bed8", RangeSet({ { 2, 3 } })) });
		auto block_reader = [](const RangeSet& src, std::vector<uint8_t>* block_buffer) -> int {
		std::fill_n(block_buffer->begin(), src.blocks() * kBlockSize, 'a');
		return 0;
		};
		auto stash_reader = [](const std::string&, std::vector<uint8_t>* stash_buffer) -> int {
		std::fill_n(stash_buffer->begin(), kBlockSize, 'b');
		return 0;
		};
		std::vector<uint8_t> buffer(source.blocks() * kBlockSize);
		ASSERT_TRUE(source.ReadAll(&buffer, kBlockSize, block_reader, stash_reader));
		ASSERT_EQ(source.blocks() * kBlockSize, buffer.size());

		uint8_t digest[SHA_DIGEST_LENGTH];
		SHA1(buffer.data(), buffer.size(), digest);
		ASSERT_EQ(source.hash(), print_sha1(digest));
		}

		TEST(SourceInfoTest, ReadAll_BufferTooSmall) {
		const SourceInfo source("2727756cfee3fbfe24bf5650123fd7743d7b3465", RangeSet({ { 0, 2 } }), {},
		{});
		auto block_reader = [](const RangeSet&, std::vector<uint8_t>*) -> int { return 0; };
		auto stash_reader = [](const std::string&, std::vector<uint8_t>*) -> int { return 0; };
		std::vector<uint8_t> buffer(source.blocks() * kBlockSize - 1);
		ASSERT_FALSE(source.ReadAll(&buffer, kBlockSize, block_reader, stash_reader));
		}

		TEST(SourceInfoTest, ReadAll_FailingReader) {
		const SourceInfo source(
		"ee3ebea26130769c10ad13604712100346d48660", RangeSet({ { 0, 2 } }), RangeSet({ { 0, 2 } }),
		{ StashInfo("1e41f7a59e80c6eb4dc043caae80d273f130bed8", RangeSet({ { 2, 3 } })) });
		std::vector<uint8_t> buffer(source.blocks() * kBlockSize);
		auto failing_block_reader = [](const RangeSet&, std::vector<uint8_t>*) -> int { return -1; };
		auto stash_reader = [](const std::string&, std::vector<uint8_t>*) -> int { return 0; };
		ASSERT_FALSE(source.ReadAll(&buffer, kBlockSize, failing_block_reader, stash_reader));

		auto block_reader = [](const RangeSet&, std::vector<uint8_t>*) -> int { return 0; };
		auto failing_stash_reader = [](const std::string&, std::vector<uint8_t>*) -> int { return -1; };
		ASSERT_FALSE(source.ReadAll(&buffer, kBlockSize, block_reader, failing_stash_reader));
		}

updater/commands.cpp

+70 −0

Original line number	Diff line number	Diff line
		@@ -16,6 +16,10 @@

		#include "private/commands.h"

		#include <stdint.h>
		#include <string.h>

		#include <functional>
		#include <ostream>
		#include <string>
		#include <vector>
		@@ -24,7 +28,9 @@
		#include <android-base/parseint.h>
		#include <android-base/stringprintf.h>
		#include <android-base/strings.h>
		#include <openssl/sha.h>

		#include "otautil/print_sha1.h"
		#include "otautil/rangeset.h"

		using namespace std::string_literals;
		@@ -303,6 +309,70 @@ Command Command::Parse(const std::string& line, size_t index, std::string* err)
		return Command(op, index, line, patch_info, target_info, source_info, stash_info);
		}

		bool SourceInfo::Overlaps(const TargetInfo& target) const {
		return ranges_.Overlaps(target.ranges());
		}

		// Moves blocks in the 'source' vector to the specified locations (as in 'locs') in the 'dest'
		// vector. Note that source and dest may be the same buffer.
		static void MoveRange(std::vector<uint8_t>* dest, const RangeSet& locs,
		const std::vector<uint8_t>& source, size_t block_size) {
		const uint8_t* from = source.data();
		uint8_t* to = dest->data();
		size_t start = locs.blocks();
		// Must do the movement backward.
		for (auto it = locs.crbegin(); it != locs.crend(); it++) {
		size_t blocks = it->second - it->first;
		start -= blocks;
		memmove(to + (it->first * block_size), from + (start * block_size), blocks * block_size);
		}
		}

		bool SourceInfo::ReadAll(
		std::vector<uint8_t>* buffer, size_t block_size,
		const std::function<int(const RangeSet&, std::vector<uint8_t>*)>& block_reader,
		const std::function<int(const std::string&, std::vector<uint8_t>*)>& stash_reader) const {
		if (buffer->size() < blocks() * block_size) {
		return false;
		}

		// Read in the source ranges.
		if (ranges_) {
		if (block_reader(ranges_, buffer) != 0) {
		return false;
		}
		if (location_) {
		MoveRange(buffer, location_, *buffer, block_size);
		}
		}

		// Read in the stashes.
		for (const StashInfo& stash : stashes_) {
		std::vector<uint8_t> stash_buffer(stash.blocks() * block_size);
		if (stash_reader(stash.id(), &stash_buffer) != 0) {
		return false;
		}
		MoveRange(buffer, stash.ranges(), stash_buffer, block_size);
		}
		return true;
		}

		void SourceInfo::DumpBuffer(const std::vector<uint8_t>& buffer, size_t block_size) const {
		LOG(INFO) << "Dumping hashes in hex for " << ranges_.blocks() << " source blocks";

		const RangeSet& location = location_ ? location_ : RangeSet({ Range{ 0, ranges_.blocks() } });
		for (size_t i = 0; i < ranges_.blocks(); i++) {
		size_t block_num = ranges_.GetBlockNumber(i);
		size_t buffer_index = location.GetBlockNumber(i);
		CHECK_LE((buffer_index + 1) * block_size, buffer.size());

		uint8_t digest[SHA_DIGEST_LENGTH];
		SHA1(buffer.data() + buffer_index * block_size, block_size, digest);
		std::string hexdigest = print_sha1(digest);
		LOG(INFO) << " block number: " << block_num << ", SHA-1: " << hexdigest;
		}
		}

		std::ostream& operator<<(std::ostream& os, const Command& command) {
		os << command.index() << ": " << command.cmdline();
		return os;

updater/include/private/commands.h

+26 −0

Original line number	Diff line number	Diff line
		@@ -16,6 +16,9 @@

		#pragma once

		#include <stdint.h>

		#include <functional>
		#include <ostream>
		#include <string>
		#include <vector>
		@@ -111,6 +114,23 @@ class SourceInfo {
		}
		}

		// Reads all the data specified by this SourceInfo object into the given 'buffer', by calling the
		// given readers. Caller needs to specify the block size for the represented blocks. The given
		// buffer needs to be sufficiently large. Otherwise it returns false. 'block_reader' and
		// 'stash_reader' read the specified data into the given buffer (guaranteed to be large enough)
		// respectively. The readers should return 0 on success, or -1 on error.
		bool ReadAll(
		std::vector<uint8_t>* buffer, size_t block_size,
		const std::function<int(const RangeSet&, std::vector<uint8_t>*)>& block_reader,
		const std::function<int(const std::string&, std::vector<uint8_t>*)>& stash_reader) const;

		// Whether this SourceInfo overlaps with the given TargetInfo object.
		bool Overlaps(const TargetInfo& target) const;

		// Dumps the hashes in hex for the given buffer that's loaded from this SourceInfo object
		// (excluding the stashed blocks which are handled separately).
		void DumpBuffer(const std::vector<uint8_t>& buffer, size_t block_size) const;

		const std::string& hash() const {
		return hash_;
		}
		@@ -334,6 +354,10 @@ class Command {
		return hash_tree_info_;
		}

		size_t block_size() const {
		return block_size_;
		}

		constexpr explicit operator bool() const {
		return type_ != Type::LAST;
		}
		@@ -377,6 +401,8 @@ class Command {
		StashInfo stash_;
		// The hash_tree info. Only meaningful for COMPUTE_HASH_TREE.
		HashTreeInfo hash_tree_info_;
		// The unit size of each block to be used in this command.
		size_t block_size_{ 4096 };
		};

		std::ostream& operator<<(std::ostream& os, const Command& command);