blob: 2ac313f814e3cf14485a659274b79a9965320bf7 [file] [log] [blame]
/*
* Copyright (C) 2019 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 "partition_installer.h"
#include <sys/statvfs.h>
#include <android-base/file.h>
#include <android-base/logging.h>
#include <android-base/unique_fd.h>
#include <ext4_utils/ext4_utils.h>
#include <fs_mgr_dm_linear.h>
#include <libdm/dm.h>
#include <libgsi/libgsi.h>
#include "file_paths.h"
#include "gsi_service.h"
#include "libgsi_private.h"
namespace android {
namespace gsi {
using namespace std::literals;
using namespace android::dm;
using namespace android::fiemap;
using namespace android::fs_mgr;
using android::base::unique_fd;
// The default size of userdata.img for GSI.
// We are looking for /data to have atleast 40% free space
static constexpr uint32_t kMinimumFreeSpaceThreshold = 40;
PartitionInstaller::PartitionInstaller(GsiService* service, const std::string& install_dir,
const std::string& name, const std::string& active_dsu,
int64_t size, bool read_only)
: service_(service),
install_dir_(install_dir),
name_(name),
active_dsu_(active_dsu),
size_(size),
readOnly_(read_only) {
images_ = ImageManager::Open(MetadataDir(active_dsu), install_dir_);
}
PartitionInstaller::~PartitionInstaller() {
Finish();
if (!succeeded_) {
// Close open handles before we remove files.
system_device_ = nullptr;
PostInstallCleanup(images_.get());
}
if (IsAshmemMapped()) {
UnmapAshmem();
}
}
void PartitionInstaller::PostInstallCleanup() {
auto manager = ImageManager::Open(MetadataDir(active_dsu_), install_dir_);
if (!manager) {
LOG(ERROR) << "Could not open image manager";
return;
}
return PostInstallCleanup(manager.get());
}
void PartitionInstaller::PostInstallCleanup(ImageManager* manager) {
std::string file = GetBackingFile(name_);
if (manager->IsImageMapped(file)) {
LOG(ERROR) << "unmap " << file;
manager->UnmapImageDevice(file);
}
manager->DeleteBackingImage(file);
}
int PartitionInstaller::StartInstall() {
if (int status = PerformSanityChecks()) {
return status;
}
if (int status = Preallocate()) {
return status;
}
if (!readOnly_) {
if (!Format()) {
return IGsiService::INSTALL_ERROR_GENERIC;
}
succeeded_ = true;
} else {
// Map ${name}_gsi so we can write to it.
system_device_ = OpenPartition(GetBackingFile(name_));
if (!system_device_) {
return IGsiService::INSTALL_ERROR_GENERIC;
}
// Clear the progress indicator.
service_->UpdateProgress(IGsiService::STATUS_NO_OPERATION, 0);
}
return IGsiService::INSTALL_OK;
}
int PartitionInstaller::PerformSanityChecks() {
if (!images_) {
LOG(ERROR) << "unable to create image manager";
return IGsiService::INSTALL_ERROR_GENERIC;
}
if (size_ < 0) {
LOG(ERROR) << "image size " << size_ << " is negative";
return IGsiService::INSTALL_ERROR_GENERIC;
}
if (android::gsi::IsGsiRunning()) {
LOG(ERROR) << "cannot install gsi inside a live gsi";
return IGsiService::INSTALL_ERROR_GENERIC;
}
struct statvfs sb;
if (statvfs(install_dir_.c_str(), &sb)) {
PLOG(ERROR) << "failed to read file system stats";
return IGsiService::INSTALL_ERROR_GENERIC;
}
// This is the same as android::vold::GetFreebytes() but we also
// need the total file system size so we open code it here.
uint64_t free_space = 1ULL * sb.f_bavail * sb.f_frsize;
uint64_t fs_size = sb.f_blocks * sb.f_frsize;
if (free_space <= (size_)) {
LOG(ERROR) << "not enough free space (only " << free_space << " bytes available)";
return IGsiService::INSTALL_ERROR_NO_SPACE;
}
// We are asking for 40% of the /data to be empty.
// TODO: may be not hard code it like this
double free_space_percent = ((1.0 * free_space) / fs_size) * 100;
if (free_space_percent < kMinimumFreeSpaceThreshold) {
LOG(ERROR) << "free space " << static_cast<uint64_t>(free_space_percent)
<< "% is below the minimum threshold of " << kMinimumFreeSpaceThreshold << "%";
return IGsiService::INSTALL_ERROR_FILE_SYSTEM_CLUTTERED;
}
return IGsiService::INSTALL_OK;
}
int PartitionInstaller::Preallocate() {
std::string file = GetBackingFile(name_);
if (!images_->UnmapImageIfExists(file)) {
LOG(ERROR) << "failed to UnmapImageIfExists " << file;
return IGsiService::INSTALL_ERROR_GENERIC;
}
// always delete the old one when it presents in case there might a partition
// with same name but different size.
if (images_->BackingImageExists(file)) {
if (!images_->DeleteBackingImage(file)) {
LOG(ERROR) << "failed to DeleteBackingImage " << file;
return IGsiService::INSTALL_ERROR_GENERIC;
}
}
service_->StartAsyncOperation("create " + name_, size_);
if (!CreateImage(file, size_)) {
LOG(ERROR) << "Could not create userdata image";
return IGsiService::INSTALL_ERROR_GENERIC;
}
service_->UpdateProgress(IGsiService::STATUS_COMPLETE, 0);
return IGsiService::INSTALL_OK;
}
bool PartitionInstaller::CreateImage(const std::string& name, uint64_t size) {
auto progress = [this](uint64_t bytes, uint64_t /* total */) -> bool {
service_->UpdateProgress(IGsiService::STATUS_WORKING, bytes);
if (service_->should_abort()) return false;
return true;
};
int flags = ImageManager::CREATE_IMAGE_DEFAULT;
if (readOnly_) {
flags |= ImageManager::CREATE_IMAGE_READONLY;
}
return images_->CreateBackingImage(name, size, flags, std::move(progress));
}
std::unique_ptr<MappedDevice> PartitionInstaller::OpenPartition(const std::string& name) {
return MappedDevice::Open(images_.get(), 10s, name);
}
bool PartitionInstaller::CommitGsiChunk(int stream_fd, int64_t bytes) {
service_->StartAsyncOperation("write " + name_, size_);
if (bytes < 0) {
LOG(ERROR) << "chunk size " << bytes << " is negative";
return false;
}
static const size_t kBlockSize = 4096;
auto buffer = std::make_unique<char[]>(kBlockSize);
int progress = -1;
uint64_t remaining = bytes;
while (remaining) {
size_t max_to_read = std::min(static_cast<uint64_t>(kBlockSize), remaining);
ssize_t rv = TEMP_FAILURE_RETRY(read(stream_fd, buffer.get(), max_to_read));
if (rv < 0) {
PLOG(ERROR) << "read gsi chunk";
return false;
}
if (rv == 0) {
LOG(ERROR) << "no bytes left in stream";
return false;
}
if (!CommitGsiChunk(buffer.get(), rv)) {
return false;
}
CHECK(static_cast<uint64_t>(rv) <= remaining);
remaining -= rv;
// Only update the progress when the % (or permille, in this case)
// significantly changes.
int new_progress = ((size_ - remaining) * 1000) / size_;
if (new_progress != progress) {
service_->UpdateProgress(IGsiService::STATUS_WORKING, size_ - remaining);
}
}
service_->UpdateProgress(IGsiService::STATUS_COMPLETE, size_);
return true;
}
bool PartitionInstaller::IsFinishedWriting() {
return gsi_bytes_written_ == size_;
}
bool PartitionInstaller::IsAshmemMapped() {
return ashmem_data_ != MAP_FAILED;
}
bool PartitionInstaller::CommitGsiChunk(const void* data, size_t bytes) {
if (static_cast<uint64_t>(bytes) > size_ - gsi_bytes_written_) {
// We cannot write past the end of the image file.
LOG(ERROR) << "chunk size " << bytes << " exceeds remaining image size (" << size_
<< " expected, " << gsi_bytes_written_ << " written)";
return false;
}
if (service_->should_abort()) {
return false;
}
if (!android::base::WriteFully(system_device_->fd(), data, bytes)) {
PLOG(ERROR) << "write failed";
return false;
}
gsi_bytes_written_ += bytes;
return true;
}
int PartitionInstaller::GetPartitionFd() {
return system_device_->fd();
}
bool PartitionInstaller::MapAshmem(int fd, size_t size) {
ashmem_size_ = size;
ashmem_data_ = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
return ashmem_data_ != MAP_FAILED;
}
void PartitionInstaller::UnmapAshmem() {
if (munmap(ashmem_data_, ashmem_size_) != 0) {
PLOG(ERROR) << "cannot munmap";
return;
}
ashmem_data_ = MAP_FAILED;
ashmem_size_ = -1;
}
bool PartitionInstaller::CommitGsiChunk(size_t bytes) {
if (!IsAshmemMapped()) {
PLOG(ERROR) << "ashmem is not mapped";
return false;
}
bool success = CommitGsiChunk(ashmem_data_, bytes);
if (success && IsFinishedWriting()) {
UnmapAshmem();
}
return success;
}
const std::string PartitionInstaller::GetBackingFile(std::string name) {
return name + "_gsi";
}
bool PartitionInstaller::Format() {
auto file = GetBackingFile(name_);
auto device = OpenPartition(file);
if (!device) {
return false;
}
// libcutils checks the first 4K, no matter the block size.
std::string zeroes(4096, 0);
if (!android::base::WriteFully(device->fd(), zeroes.data(), zeroes.size())) {
PLOG(ERROR) << "write " << file;
return false;
}
return true;
}
int PartitionInstaller::Finish() {
if (readOnly_ && gsi_bytes_written_ != size_) {
// We cannot boot if the image is incomplete.
LOG(ERROR) << "image incomplete; expected " << size_ << " bytes, waiting for "
<< (size_ - gsi_bytes_written_) << " bytes";
return IGsiService::INSTALL_ERROR_GENERIC;
}
if (system_device_ != nullptr && fsync(system_device_->fd())) {
PLOG(ERROR) << "fsync failed for " << name_ << "_gsi";
return IGsiService::INSTALL_ERROR_GENERIC;
}
system_device_ = {};
// If files moved (are no longer pinned), the metadata file will be invalid.
// This check can be removed once b/133967059 is fixed.
if (!images_->Validate()) {
return IGsiService::INSTALL_ERROR_GENERIC;
}
succeeded_ = true;
return IGsiService::INSTALL_OK;
}
int PartitionInstaller::WipeWritable(const std::string& active_dsu, const std::string& install_dir,
const std::string& name) {
auto image = ImageManager::Open(MetadataDir(active_dsu), install_dir);
// The device object has to be destroyed before the image object
auto device = MappedDevice::Open(image.get(), 10s, name);
if (!device) {
return IGsiService::INSTALL_ERROR_GENERIC;
}
// Wipe the first 1MiB of the device, ensuring both the first block and
// the superblock are destroyed.
static constexpr uint64_t kEraseSize = 1024 * 1024;
std::string zeroes(4096, 0);
uint64_t erase_size = std::min(kEraseSize, get_block_device_size(device->fd()));
for (uint64_t i = 0; i < erase_size; i += zeroes.size()) {
if (!android::base::WriteFully(device->fd(), zeroes.data(), zeroes.size())) {
PLOG(ERROR) << "write userdata_gsi";
return IGsiService::INSTALL_ERROR_GENERIC;
}
}
return IGsiService::INSTALL_OK;
}
} // namespace gsi
} // namespace android