7ae0169842
bootloader_message.h currently divides /misc into four segments. The
space between 2K and 16K is reserved for vendor use (e.g. bootloader
persists flags). This CL adds a vendor tool "misc_writer", to allow
writing data to the vendor space in /misc, before getting a dedicated
HAL for accessing /misc partition (b/131775112).
Targets need to explicitly include the module, then invoke the
executable to write data. For example, the following command will write
3-byte data ("0xABCDEF") to offset 4 in vendor space (i.e. 2048 + 4 in
/misc).
$ /vendor/bin/misc_writer --vendor-space-offset 4 --hex-string 0xABCDEF
Bug: 132906936
Test: Run recovery_unit_test on crosshatch.
Test: Call the command via init.hardware.rc on crosshatch. Check that
the call finishes successfully. Then check the contents written to
/misc (`dd bs=1 skip=2048 if=/dev/block/sda2 count=32 | xxd`).
Change-Id: I79548fc63fc79b705a0320868690569c3106949f
154 lines
6 KiB
C++
154 lines
6 KiB
C++
/*
|
|
* Copyright (C) 2016 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#include <string>
|
|
#include <string_view>
|
|
#include <vector>
|
|
|
|
#include <android-base/file.h>
|
|
#include <android-base/strings.h>
|
|
#include <bootloader_message/bootloader_message.h>
|
|
#include <gtest/gtest.h>
|
|
|
|
using namespace std::string_literals;
|
|
|
|
extern void SetMiscBlockDeviceForTest(std::string_view misc_device);
|
|
|
|
TEST(BootloaderMessageTest, read_and_write_bootloader_message) {
|
|
TemporaryFile temp_misc;
|
|
|
|
// Write the BCB.
|
|
bootloader_message boot = {};
|
|
strlcpy(boot.command, "command", sizeof(boot.command));
|
|
strlcpy(boot.recovery, "message1\nmessage2\n", sizeof(boot.recovery));
|
|
strlcpy(boot.status, "status1", sizeof(boot.status));
|
|
|
|
std::string err;
|
|
ASSERT_TRUE(write_bootloader_message_to(boot, temp_misc.path, &err))
|
|
<< "Failed to write BCB: " << err;
|
|
|
|
// Read and verify.
|
|
bootloader_message boot_verify;
|
|
ASSERT_TRUE(read_bootloader_message_from(&boot_verify, temp_misc.path, &err))
|
|
<< "Failed to read BCB: " << err;
|
|
|
|
ASSERT_EQ(std::string(reinterpret_cast<const char*>(&boot), sizeof(boot)),
|
|
std::string(reinterpret_cast<const char*>(&boot_verify), sizeof(boot_verify)));
|
|
}
|
|
|
|
TEST(BootloaderMessageTest, update_bootloader_message_in_struct) {
|
|
// Write the options to BCB.
|
|
std::vector<std::string> options = { "option1", "option2" };
|
|
|
|
bootloader_message boot = {};
|
|
// Inject some bytes into boot.
|
|
strlcpy(boot.recovery, "random message", sizeof(boot.recovery));
|
|
strlcpy(boot.status, "status bytes", sizeof(boot.status));
|
|
strlcpy(boot.stage, "stage bytes", sizeof(boot.stage));
|
|
strlcpy(boot.reserved, "reserved bytes", sizeof(boot.reserved));
|
|
|
|
ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
|
|
|
|
// Verify that command and recovery fields should be set.
|
|
ASSERT_EQ("boot-recovery", std::string(boot.command));
|
|
std::string expected = "recovery\n" + android::base::Join(options, "\n") + "\n";
|
|
ASSERT_EQ(expected, std::string(boot.recovery));
|
|
|
|
// The rest should be intact.
|
|
ASSERT_EQ("status bytes", std::string(boot.status));
|
|
ASSERT_EQ("stage bytes", std::string(boot.stage));
|
|
ASSERT_EQ("reserved bytes", std::string(boot.reserved));
|
|
}
|
|
|
|
TEST(BootloaderMessageTest, update_bootloader_message_recovery_options_empty) {
|
|
// Write empty vector.
|
|
std::vector<std::string> options;
|
|
|
|
// Read and verify.
|
|
bootloader_message boot = {};
|
|
ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
|
|
|
|
// command and recovery fields should be set.
|
|
ASSERT_EQ("boot-recovery", std::string(boot.command));
|
|
ASSERT_EQ("recovery\n", std::string(boot.recovery));
|
|
|
|
// The rest should be empty.
|
|
ASSERT_EQ(std::string(sizeof(boot.status), '\0'), std::string(boot.status, sizeof(boot.status)));
|
|
ASSERT_EQ(std::string(sizeof(boot.stage), '\0'), std::string(boot.stage, sizeof(boot.stage)));
|
|
ASSERT_EQ(std::string(sizeof(boot.reserved), '\0'),
|
|
std::string(boot.reserved, sizeof(boot.reserved)));
|
|
}
|
|
|
|
TEST(BootloaderMessageTest, update_bootloader_message_recovery_options_long) {
|
|
// Write super long message.
|
|
std::vector<std::string> options;
|
|
for (int i = 0; i < 100; i++) {
|
|
options.push_back("option: " + std::to_string(i));
|
|
}
|
|
|
|
// Read and verify.
|
|
bootloader_message boot = {};
|
|
ASSERT_TRUE(update_bootloader_message_in_struct(&boot, options));
|
|
|
|
// Make sure it's long enough.
|
|
std::string expected = "recovery\n" + android::base::Join(options, "\n") + "\n";
|
|
ASSERT_GE(expected.size(), sizeof(boot.recovery));
|
|
|
|
// command and recovery fields should be set.
|
|
ASSERT_EQ("boot-recovery", std::string(boot.command));
|
|
ASSERT_EQ(expected.substr(0, sizeof(boot.recovery) - 1), std::string(boot.recovery));
|
|
ASSERT_EQ('\0', boot.recovery[sizeof(boot.recovery) - 1]);
|
|
|
|
// The rest should be empty.
|
|
ASSERT_EQ(std::string(sizeof(boot.status), '\0'), std::string(boot.status, sizeof(boot.status)));
|
|
ASSERT_EQ(std::string(sizeof(boot.stage), '\0'), std::string(boot.stage, sizeof(boot.stage)));
|
|
ASSERT_EQ(std::string(sizeof(boot.reserved), '\0'),
|
|
std::string(boot.reserved, sizeof(boot.reserved)));
|
|
}
|
|
|
|
TEST(BootloaderMessageTest, WriteMiscPartitionVendorSpace) {
|
|
TemporaryFile temp_misc;
|
|
ASSERT_TRUE(android::base::WriteStringToFile(std::string(4096, '\x00'), temp_misc.path));
|
|
SetMiscBlockDeviceForTest(temp_misc.path);
|
|
|
|
constexpr std::string_view kTestMessage = "kTestMessage";
|
|
std::string err;
|
|
ASSERT_TRUE(WriteMiscPartitionVendorSpace(kTestMessage.data(), kTestMessage.size(), 0, &err));
|
|
|
|
std::string message;
|
|
message.resize(kTestMessage.size());
|
|
ASSERT_TRUE(ReadMiscPartitionVendorSpace(message.data(), message.size(), 0, &err));
|
|
ASSERT_EQ(kTestMessage, message);
|
|
|
|
// Write with an offset.
|
|
ASSERT_TRUE(WriteMiscPartitionVendorSpace("\x00\x00", 2, 5, &err));
|
|
ASSERT_TRUE(ReadMiscPartitionVendorSpace(message.data(), message.size(), 0, &err));
|
|
ASSERT_EQ("kTest\x00\x00ssage"s, message);
|
|
|
|
// Write with the right size.
|
|
auto start_offset =
|
|
WIPE_PACKAGE_OFFSET_IN_MISC - VENDOR_SPACE_OFFSET_IN_MISC - kTestMessage.size();
|
|
ASSERT_TRUE(
|
|
WriteMiscPartitionVendorSpace(kTestMessage.data(), kTestMessage.size(), start_offset, &err));
|
|
|
|
// Out-of-bound write.
|
|
ASSERT_FALSE(WriteMiscPartitionVendorSpace(kTestMessage.data(), kTestMessage.size(),
|
|
start_offset + 1, &err));
|
|
|
|
// Message won't fit.
|
|
std::string long_message(WIPE_PACKAGE_OFFSET_IN_MISC - VENDOR_SPACE_OFFSET_IN_MISC + 1, 'a');
|
|
ASSERT_FALSE(WriteMiscPartitionVendorSpace(long_message.data(), long_message.size(), 0, &err));
|
|
}
|