| // Copyright 2018 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include "fvm.h" |
| |
| #include <dirent.h> |
| #include <fcntl.h> |
| #include <fuchsia/device/llcpp/fidl.h> |
| #include <fuchsia/hardware/block/llcpp/fidl.h> |
| #include <fuchsia/hardware/block/partition/llcpp/fidl.h> |
| #include <fuchsia/hardware/block/volume/llcpp/fidl.h> |
| #include <lib/fdio/cpp/caller.h> |
| #include <lib/fdio/directory.h> |
| #include <lib/fzl/vmo-mapper.h> |
| #include <lib/zx/channel.h> |
| #include <lib/zx/fifo.h> |
| #include <lib/zx/time.h> |
| #include <lib/zx/vmo.h> |
| #include <zircon/status.h> |
| #include <zircon/syscalls.h> |
| |
| #include <algorithm> |
| #include <cstddef> |
| #include <memory> |
| |
| #include <block-client/cpp/client.h> |
| #include <fbl/algorithm.h> |
| #include <fbl/array.h> |
| #include <fbl/string_buffer.h> |
| #include <fbl/unique_fd.h> |
| #include <fs-management/fvm.h> |
| #include <fs-management/mount.h> |
| #include <ramdevice-client/ramdisk.h> |
| |
| #include "pave-logging.h" |
| #include "src/lib/uuid/uuid.h" |
| #include "src/security/zxcrypt/fdio-volume.h" |
| #include "src/storage/fvm/format.h" |
| #include "src/storage/fvm/fvm.h" |
| #include "src/storage/fvm/fvm_sparse.h" |
| |
| namespace paver { |
| namespace { |
| |
| using uuid::Uuid; |
| |
| namespace block = ::llcpp::fuchsia::hardware::block; |
| namespace partition = ::llcpp::fuchsia::hardware::block::partition; |
| namespace volume = ::llcpp::fuchsia::hardware::block::volume; |
| namespace device = ::llcpp::fuchsia::device; |
| |
| using ::llcpp::fuchsia::hardware::block::volume::VolumeInfo; |
| using ::llcpp::fuchsia::hardware::block::volume::VolumeManagerInfo; |
| |
| // The number of additional slices a partition will need to become |
| // zxcrypt'd. |
| // |
| // TODO(aarongreen): Replace this with a value supplied by ulib/zxcrypt. |
| constexpr size_t kZxcryptExtraSlices = 1; |
| |
| // Looks up the topological path of a device. |
| // |buf| is the buffer the path will be written to. |buf_len| is the total |
| // capcity of the buffer, including space for a null byte. |
| // Upon success, |buf| will contain the null-terminated topological path. |
| zx_status_t GetTopoPathFromFd(const fbl::unique_fd& fd, char* buf, size_t buf_len) { |
| fdio_cpp::UnownedFdioCaller caller(fd.get()); |
| auto resp = ::llcpp::fuchsia::device::Controller::Call::GetTopologicalPath(caller.channel()); |
| if (!resp.ok()) { |
| return resp.status(); |
| } |
| if (resp->result.is_err()) { |
| return resp->result.err(); |
| } |
| |
| auto& response = resp->result.response(); |
| strncpy(buf, response.path.data(), std::min(buf_len, response.path.size())); |
| buf[response.path.size()] = '\0'; |
| return ZX_OK; |
| } |
| |
| // Confirm that the file descriptor to the underlying partition exists within an |
| // FVM, not, for example, a GPT or MBR. |
| // |
| // |out| is true if |fd| is a VPartition, else false. |
| zx_status_t FvmIsVirtualPartition(const fbl::unique_fd& fd, bool* out) { |
| char path[PATH_MAX]; |
| zx_status_t status = GetTopoPathFromFd(fd, path, sizeof(path)); |
| if (status != ZX_OK) { |
| return ZX_ERR_IO; |
| } |
| |
| *out = strstr(path, "fvm") != nullptr; |
| return ZX_OK; |
| } |
| |
| // Describes the state of a partition actively being written |
| // out to disk. |
| struct PartitionInfo { |
| PartitionInfo() = default; |
| |
| fvm::PartitionDescriptor* pd = nullptr; |
| fvm::PartitionDescriptor aligned_pd = {}; |
| fbl::unique_fd new_part; |
| bool active = false; |
| }; |
| |
| ptrdiff_t GetExtentOffset(size_t extent) { |
| return sizeof(fvm::PartitionDescriptor) + extent * sizeof(fvm::ExtentDescriptor); |
| } |
| |
| fvm::ExtentDescriptor GetExtent(fvm::PartitionDescriptor* pd, size_t extent) { |
| fvm::ExtentDescriptor descriptor = {}; |
| const auto* descriptor_ptr = reinterpret_cast<uint8_t*>(pd) + GetExtentOffset(extent); |
| memcpy(&descriptor, descriptor_ptr, sizeof(fvm::ExtentDescriptor)); |
| return descriptor; |
| } |
| |
| // Registers a FIFO |
| zx_status_t RegisterFastBlockIo(const fbl::unique_fd& fd, const zx::vmo& vmo, vmoid_t* out_vmoid, |
| block_client::Client* out_client) { |
| fdio_cpp::UnownedFdioCaller caller(fd.get()); |
| |
| auto result = block::Block::Call::GetFifo(caller.channel()); |
| if (!result.ok()) { |
| return result.status(); |
| } |
| auto& response = result.value(); |
| if (response.status != ZX_OK) { |
| return response.status; |
| } |
| |
| zx::vmo dup; |
| if (vmo.duplicate(ZX_RIGHT_SAME_RIGHTS, &dup) != ZX_OK) { |
| ERROR("Couldn't duplicate buffer vmo\n"); |
| return ZX_ERR_IO; |
| } |
| |
| auto result2 = block::Block::Call::AttachVmo(caller.channel(), std::move(dup)); |
| if (result2.status() != ZX_OK) { |
| return result2.status(); |
| } |
| const auto& response2 = result2.value(); |
| if (response2.status != ZX_OK) { |
| return response2.status; |
| } |
| |
| *out_vmoid = response2.vmoid->id; |
| return block_client::Client::Create(std::move(response.fifo), out_client); |
| } |
| |
| zx_status_t FlushClient(block_client::Client* client) { |
| block_fifo_request_t request; |
| request.group = 0; |
| request.vmoid = block::VMOID_INVALID; |
| request.opcode = BLOCKIO_FLUSH; |
| request.length = 0; |
| request.vmo_offset = 0; |
| request.dev_offset = 0; |
| |
| return client->Transaction(&request, 1); |
| } |
| |
| // Stream an FVM partition to disk. |
| zx_status_t StreamFvmPartition(fvm::SparseReader* reader, PartitionInfo* part, |
| const fzl::VmoMapper& mapper, const block_client::Client& client, |
| size_t block_size, block_fifo_request_t* request) { |
| size_t slice_size = reader->Image()->slice_size; |
| const size_t vmo_cap = mapper.size(); |
| for (size_t e = 0; e < part->aligned_pd.extent_count; e++) { |
| LOG("Writing extent %zu... \n", e); |
| fvm::ExtentDescriptor ext = GetExtent(part->pd, e); |
| size_t offset = ext.slice_start * slice_size; |
| size_t bytes_left = ext.extent_length; |
| |
| // Write real data |
| while (bytes_left > 0) { |
| size_t actual; |
| zx_status_t status = reader->ReadData(reinterpret_cast<uint8_t*>(mapper.start()), |
| std::min(bytes_left, vmo_cap), &actual); |
| if (status != ZX_OK) { |
| ERROR("Error reading partition data: %s\n", zx_status_get_string(status)); |
| return status; |
| } |
| |
| const size_t vmo_sz = actual; |
| bytes_left -= actual; |
| |
| if (vmo_sz == 0) { |
| ERROR("Read nothing from src_fd; %zu bytes left\n", bytes_left); |
| return ZX_ERR_IO; |
| } else if (vmo_sz % block_size != 0) { |
| ERROR("Cannot write non-block size multiple: %zu\n", vmo_sz); |
| return ZX_ERR_IO; |
| } |
| |
| uint64_t length = vmo_sz / block_size; |
| if (length > UINT32_MAX) { |
| ERROR("Error writing partition: Too large\n"); |
| return ZX_ERR_OUT_OF_RANGE; |
| } |
| request->length = static_cast<uint32_t>(length); |
| request->vmo_offset = 0; |
| request->dev_offset = offset / block_size; |
| |
| ssize_t r; |
| if ((r = client.Transaction(request, 1)) != ZX_OK) { |
| ERROR("Error writing partition data\n"); |
| return static_cast<zx_status_t>(r); |
| } |
| |
| offset += vmo_sz; |
| } |
| |
| // Write trailing zeroes (which are implied, but were omitted from |
| // transfer). |
| bytes_left = (ext.slice_count * slice_size) - ext.extent_length; |
| if (bytes_left > 0) { |
| LOG("%zu bytes written, %zu zeroes left\n", ext.extent_length, bytes_left); |
| memset(mapper.start(), 0, vmo_cap); |
| } |
| while (bytes_left > 0) { |
| uint64_t length = std::min(bytes_left, vmo_cap) / block_size; |
| if (length > UINT32_MAX) { |
| ERROR("Error writing trailing zeroes: Too large(%lu)\n", length); |
| return ZX_ERR_OUT_OF_RANGE; |
| } |
| request->length = static_cast<uint32_t>(length); |
| request->vmo_offset = 0; |
| request->dev_offset = offset / block_size; |
| |
| zx_status_t status; |
| if ((status = client.Transaction(request, 1)) != ZX_OK) { |
| ERROR("Error writing trailing zeroes length:%u dev_offset:%lu vmo_offset:%lu\n", |
| request->length, request->dev_offset, request->vmo_offset); |
| return status; |
| } |
| |
| offset += request->length * block_size; |
| bytes_left -= request->length * block_size; |
| } |
| } |
| return ZX_OK; |
| } |
| |
| } // namespace |
| |
| fbl::unique_fd TryBindToFvmDriver(const fbl::unique_fd& devfs_root, |
| const fbl::unique_fd& partition_fd, zx::duration timeout) { |
| char path[PATH_MAX] = {}; |
| zx_status_t status = GetTopoPathFromFd(partition_fd, path, sizeof(path)); |
| if (status != ZX_OK) { |
| ERROR("Failed to get topological path\n"); |
| return fbl::unique_fd(); |
| } |
| |
| char fvm_path[PATH_MAX]; |
| snprintf(fvm_path, sizeof(fvm_path), "%s/fvm", &path[5]); |
| |
| fbl::unique_fd fvm(openat(devfs_root.get(), fvm_path, O_RDWR)); |
| if (fvm) { |
| return fvm; |
| } |
| |
| fdio_cpp::UnownedFdioCaller caller(partition_fd.get()); |
| constexpr char kFvmDriverLib[] = "/boot/driver/fvm.so"; |
| auto resp = ::llcpp::fuchsia::device::Controller::Call::Rebind(caller.channel(), |
| fidl::StringView(kFvmDriverLib)); |
| status = resp.status(); |
| if (status == ZX_OK) { |
| if (resp->result.is_err()) { |
| status = resp->result.err(); |
| } |
| } |
| if (status != ZX_OK && status != ZX_ERR_ALREADY_BOUND) { |
| ERROR("Could not rebind fvm driver, Error %d\n", status); |
| return fbl::unique_fd(); |
| } |
| |
| if (wait_for_device_at(devfs_root.get(), fvm_path, timeout.get()) != ZX_OK) { |
| ERROR("Error waiting for fvm driver to bind\n"); |
| return fbl::unique_fd(); |
| } |
| return fbl::unique_fd(openat(devfs_root.get(), fvm_path, O_RDWR)); |
| } |
| |
| fbl::unique_fd FvmPartitionFormat(const fbl::unique_fd& devfs_root, fbl::unique_fd partition_fd, |
| const fvm::SparseImage& header, BindOption option, |
| FormatResult* format_result) { |
| // Although the format (based on the magic in the FVM superblock) |
| // indicates this is (or at least was) an FVM image, it may be invalid. |
| // |
| // Attempt to bind the FVM driver to this partition, but fall-back to |
| // reinitializing the FVM image so the rest of the paving |
| // process can continue successfully. |
| fbl::unique_fd fvm_fd; |
| if (format_result != nullptr) { |
| *format_result = FormatResult::kUnknown; |
| } |
| if (option == BindOption::TryBind) { |
| disk_format_t df = detect_disk_format(partition_fd.get()); |
| if (df == DISK_FORMAT_FVM) { |
| fvm_fd = TryBindToFvmDriver(devfs_root, partition_fd, zx::sec(3)); |
| if (fvm_fd) { |
| LOG("Found already formatted FVM.\n"); |
| fdio_cpp::UnownedFdioCaller volume_manager(fvm_fd.get()); |
| auto result = volume::VolumeManager::Call::GetInfo( |
| fdio_cpp::UnownedFdioCaller(fvm_fd.get()).channel()); |
| if (result.status() == ZX_OK) { |
| auto get_maximum_slice_count = [](const fvm::SparseImage& header) { |
| return fvm::Header::FromDiskSize(fvm::kMaxUsablePartitions, header.maximum_disk_size, |
| header.slice_size) |
| .GetAllocationTableAllocatedEntryCount(); |
| }; |
| if (result->info->slice_size != header.slice_size) { |
| ERROR("Mismatched slice size. Reinitializing FVM.\n"); |
| } else if (header.maximum_disk_size > 0 && |
| result->info->maximum_slice_count < get_maximum_slice_count(header)) { |
| ERROR("Mismatched maximum slice count. Reinitializing FVM.\n"); |
| } else { |
| if (format_result != nullptr) { |
| *format_result = FormatResult::kPreserved; |
| } |
| return fvm_fd; |
| } |
| } else { |
| ERROR("Could not query FVM for info. Reinitializing FVM.\n"); |
| } |
| } else { |
| ERROR("Saw DISK_FORMAT_FVM, but could not bind driver. Reinitializing FVM.\n"); |
| } |
| } |
| } |
| |
| LOG("Initializing partition as FVM\n"); |
| { |
| if (format_result != nullptr) { |
| *format_result = FormatResult::kReformatted; |
| } |
| |
| fdio_cpp::UnownedFdioCaller partition_connection(partition_fd.get()); |
| auto block_info_result = block::Block::Call::GetInfo(partition_connection.channel()); |
| if (!block_info_result.ok()) { |
| ERROR("Failed to query block info: %s\n", zx_status_get_string(block_info_result.status())); |
| return fbl::unique_fd(); |
| } |
| |
| uint64_t initial_disk_size = |
| block_info_result->info->block_count * block_info_result->info->block_size; |
| uint64_t max_disk_size = |
| (header.maximum_disk_size == 0) ? initial_disk_size : header.maximum_disk_size; |
| |
| zx_status_t status = fvm_init_preallocated(partition_fd.get(), initial_disk_size, max_disk_size, |
| header.slice_size); |
| if (status != ZX_OK) { |
| ERROR("Failed to initialize fvm: %s\n", zx_status_get_string(status)); |
| return fbl::unique_fd(); |
| } |
| } |
| |
| return TryBindToFvmDriver(devfs_root, partition_fd, zx::sec(3)); |
| } |
| |
| namespace { |
| |
| // Formats a block device as a zxcrypt volume. |
| // |
| // On success, returns a file descriptor to an FVM. |
| // On failure, returns -1 |
| zx_status_t ZxcryptCreate(PartitionInfo* part) { |
| zx_status_t status; |
| |
| char path[PATH_MAX]; |
| status = GetTopoPathFromFd(part->new_part, path, sizeof(path)); |
| if (status != ZX_OK) { |
| ERROR("Failed to get topological path\n"); |
| return status; |
| } |
| // TODO(security): fxbug.dev/31073. We need to bind with channel in order to pass a key here. |
| // TODO(security): fxbug.dev/31733. The created volume must marked as needing key rotation. |
| |
| fbl::unique_fd devfs_root(open("/dev", O_RDONLY)); |
| std::unique_ptr<zxcrypt::FdioVolume> volume; |
| if ((status = zxcrypt::FdioVolume::CreateWithDeviceKey( |
| std::move(part->new_part), std::move(devfs_root), &volume)) != ZX_OK) { |
| ERROR("Could not create zxcrypt volume\n"); |
| return status; |
| } |
| zx::channel zxcrypt_manager_chan; |
| if ((status = volume->OpenManager(zx::sec(3), zxcrypt_manager_chan.reset_and_get_address())) != |
| ZX_OK) { |
| ERROR("Could not open zxcrypt volume manager\n"); |
| return status; |
| } |
| |
| zxcrypt::FdioVolumeManager zxcrypt_manager(std::move(zxcrypt_manager_chan)); |
| uint8_t slot = 0; |
| if ((status = zxcrypt_manager.UnsealWithDeviceKey(slot)) != ZX_OK) { |
| ERROR("Could not unseal zxcrypt volume\n"); |
| return status; |
| } |
| |
| if ((status = volume->Open(zx::sec(3), &part->new_part)) != ZX_OK) { |
| ERROR("Could not open zxcrypt volume\n"); |
| return status; |
| } |
| |
| fvm::ExtentDescriptor ext = GetExtent(part->pd, 0); |
| size_t reserved = volume->reserved_slices(); |
| |
| // |Create| guarantees at least |reserved| + 1 slices are allocated. If the first extent had a |
| // single slice, we're done. |
| size_t allocated = std::max(reserved + 1, ext.slice_count); |
| size_t needed = reserved + ext.slice_count; |
| if (allocated >= needed) { |
| return ZX_OK; |
| } |
| |
| // Otherwise, extend by the number of slices we stole for metadata |
| uint64_t offset = allocated - reserved; |
| uint64_t length = needed - allocated; |
| { |
| fdio_cpp::UnownedFdioCaller partition_connection(part->new_part.get()); |
| auto result = volume::Volume::Call::Extend(partition_connection.channel(), offset, length); |
| status = result.ok() ? result.value().status : result.status(); |
| if (status != ZX_OK) { |
| ERROR("Failed to extend zxcrypt volume: %s\n", zx_status_get_string(status)); |
| return status; |
| } |
| } |
| |
| return ZX_OK; |
| } |
| |
| // Returns |ZX_OK| if |partition_fd| is a child of |fvm_fd|. |
| zx_status_t FvmPartitionIsChild(const fbl::unique_fd& fvm_fd, const fbl::unique_fd& partition_fd) { |
| char fvm_path[PATH_MAX]; |
| char part_path[PATH_MAX]; |
| zx_status_t status; |
| if ((status = GetTopoPathFromFd(fvm_fd, fvm_path, sizeof(fvm_path))) != ZX_OK) { |
| ERROR("Couldn't get topological path of FVM\n"); |
| return status; |
| } else if ((status = GetTopoPathFromFd(partition_fd, part_path, sizeof(part_path))) != ZX_OK) { |
| ERROR("Couldn't get topological path of partition\n"); |
| return status; |
| } |
| if (strncmp(fvm_path, part_path, strlen(fvm_path))) { |
| ERROR("Partition does not exist within FVM\n"); |
| return ZX_ERR_BAD_STATE; |
| } |
| return ZX_OK; |
| } |
| |
| void RecommendWipe(const char* problem) { |
| Warn(problem, "Please run 'install-disk-image wipe' to wipe your partitions"); |
| } |
| |
| // Deletes all partitions within the FVM with a type GUID matching |type_guid| |
| // until there are none left. |
| zx_status_t WipeAllFvmPartitionsWithGUID(const fbl::unique_fd& fvm_fd, const uint8_t type_guid[]) { |
| fbl::unique_fd old_part; |
| while ((old_part.reset(open_partition(nullptr, type_guid, ZX_MSEC(500), nullptr))), old_part) { |
| bool is_vpartition; |
| if (FvmIsVirtualPartition(old_part, &is_vpartition) != ZX_OK) { |
| ERROR("Couldn't confirm old vpartition type\n"); |
| return ZX_ERR_IO; |
| } |
| if (FvmPartitionIsChild(fvm_fd, old_part) != ZX_OK) { |
| RecommendWipe("Streaming a partition type which also exists outside the target FVM"); |
| return ZX_ERR_BAD_STATE; |
| } |
| if (!is_vpartition) { |
| RecommendWipe("Streaming a partition type which also exists in a GPT"); |
| return ZX_ERR_BAD_STATE; |
| } |
| |
| // We're paving a partition that already exists within the FVM: let's |
| // destroy it before we pave anew. |
| |
| fdio_cpp::UnownedFdioCaller partition_connection(old_part.get()); |
| auto result = volume::Volume::Call::Destroy(partition_connection.channel()); |
| zx_status_t status = result.ok() ? result.value().status : result.status(); |
| if (status != ZX_OK) { |
| ERROR("Couldn't destroy partition: %s\n", zx_status_get_string(status)); |
| return status; |
| } |
| } |
| |
| return ZX_OK; |
| } |
| |
| // Calculate the amount of space necessary for the incoming partitions, |
| // validating the header along the way. Additionally, deletes any old partitions |
| // which match the type GUID of the provided partition. |
| // |
| // Parses the information from the |reader| into |parts|. |
| zx_status_t PreProcessPartitions(const fbl::unique_fd& fvm_fd, |
| const std::unique_ptr<fvm::SparseReader>& reader, |
| const fbl::Array<PartitionInfo>& parts, |
| size_t* out_requested_slices) { |
| fvm::PartitionDescriptor* part = reader->Partitions(); |
| fvm::SparseImage* hdr = reader->Image(); |
| |
| // Validate the header and determine the necessary slice requirements for |
| // all partitions and all offsets. |
| size_t requested_slices = 0; |
| for (size_t p = 0; p < hdr->partition_count; p++) { |
| parts[p].pd = part; |
| memcpy(&parts[p].aligned_pd, part, sizeof(fvm::PartitionDescriptor)); |
| if (parts[p].pd->magic != fvm::kPartitionDescriptorMagic) { |
| ERROR("Bad partition magic\n"); |
| return ZX_ERR_IO; |
| } |
| |
| zx_status_t status = WipeAllFvmPartitionsWithGUID(fvm_fd, parts[p].pd->type); |
| if (status != ZX_OK) { |
| ERROR("Failure wiping old partitions matching this GUID\n"); |
| return status; |
| } |
| |
| fvm::ExtentDescriptor ext = GetExtent(parts[p].pd, 0); |
| if (ext.magic != fvm::kExtentDescriptorMagic) { |
| ERROR("Bad extent magic\n"); |
| return ZX_ERR_IO; |
| } |
| if (ext.slice_start != 0) { |
| ERROR("First slice must start at zero\n"); |
| return ZX_ERR_IO; |
| } |
| if (ext.slice_count == 0) { |
| ERROR("Extents must have > 0 slices\n"); |
| return ZX_ERR_IO; |
| } |
| if (ext.extent_length > ext.slice_count * hdr->slice_size) { |
| ERROR("Extent length(%lu) must fit within allocated slice count(%lu * %lu)\n", |
| ext.extent_length, ext.slice_count, hdr->slice_size); |
| return ZX_ERR_IO; |
| } |
| |
| // Filter drivers may require additional space. |
| if ((parts[p].aligned_pd.flags & fvm::kSparseFlagZxcrypt) != 0) { |
| requested_slices += kZxcryptExtraSlices; |
| } |
| |
| for (size_t e = 1; e < parts[p].aligned_pd.extent_count; e++) { |
| ext = GetExtent(parts[p].pd, e); |
| if (ext.magic != fvm::kExtentDescriptorMagic) { |
| ERROR("Bad extent magic\n"); |
| return ZX_ERR_IO; |
| } else if (ext.slice_count == 0) { |
| ERROR("Extents must have > 0 slices\n"); |
| return ZX_ERR_IO; |
| } else if (ext.extent_length > ext.slice_count * hdr->slice_size) { |
| char name[BLOCK_NAME_LEN + 1]; |
| name[BLOCK_NAME_LEN] = '\0'; |
| memcpy(&name, parts[p].aligned_pd.name, sizeof(BLOCK_NAME_LEN)); |
| ERROR("Partition(%s) extent length(%lu) must fit within allocated slice count(%lu * %lu)\n", |
| name, ext.extent_length, ext.slice_count, hdr->slice_size); |
| return ZX_ERR_IO; |
| } |
| |
| requested_slices += ext.slice_count; |
| } |
| part = reinterpret_cast<fvm::PartitionDescriptor*>( |
| reinterpret_cast<uint8_t*>(parts[p].pd) + sizeof(fvm::PartitionDescriptor) + |
| parts[p].aligned_pd.extent_count * sizeof(fvm::ExtentDescriptor)); |
| } |
| |
| *out_requested_slices = requested_slices; |
| return ZX_OK; |
| } |
| |
| // Allocates the space requested by the partitions by creating new |
| // partitions and filling them with extents. This guarantees that |
| // streaming the data to the device will not run into "no space" issues |
| // later. |
| zx_status_t AllocatePartitions(const fbl::unique_fd& devfs_root, const fbl::unique_fd& fvm_fd, |
| fbl::Array<PartitionInfo>* parts) { |
| for (size_t p = 0; p < parts->size(); p++) { |
| fvm::ExtentDescriptor ext = GetExtent((*parts)[p].pd, 0); |
| alloc_req_t alloc = {}; |
| // Allocate this partition as inactive so it gets deleted on the next |
| // reboot if this stream fails. |
| alloc.flags = (*parts)[p].active ? 0 : volume::ALLOCATE_PARTITION_FLAG_INACTIVE; |
| alloc.slice_count = ext.slice_count; |
| memcpy(&alloc.type, (*parts)[p].pd->type, sizeof(alloc.type)); |
| memcpy(&alloc.guid, uuid::Uuid::Generate().bytes(), uuid::kUuidSize); |
| memcpy(&alloc.name, (*parts)[p].pd->name, sizeof(alloc.name)); |
| LOG("Allocating partition %s consisting of %zu slices\n", alloc.name, alloc.slice_count); |
| (*parts)[p].new_part.reset( |
| fvm_allocate_partition_with_devfs(devfs_root.get(), fvm_fd.get(), &alloc)); |
| if (!(*parts)[p].new_part) { |
| ERROR("Couldn't allocate partition\n"); |
| return ZX_ERR_NO_SPACE; |
| } |
| |
| // Add filter drivers. |
| if (((*parts)[p].pd->flags & fvm::kSparseFlagZxcrypt) != 0) { |
| LOG("Creating zxcrypt volume\n"); |
| zx_status_t status = ZxcryptCreate(&(*parts)[p]); |
| if (status != ZX_OK) { |
| return status; |
| } |
| } |
| |
| // The 0th index extent is allocated alongside the partition, so we |
| // begin indexing from the 1st extent here. |
| for (size_t e = 1; e < (*parts)[p].pd->extent_count; e++) { |
| ext = GetExtent((*parts)[p].pd, e); |
| uint64_t offset = ext.slice_start; |
| uint64_t length = ext.slice_count; |
| |
| fdio_cpp::UnownedFdioCaller partition_connection((*parts)[p].new_part.get()); |
| auto result = volume::Volume::Call::Extend(partition_connection.channel(), offset, length); |
| auto status = result.ok() ? result.value().status : result.status(); |
| if (status != ZX_OK) { |
| ERROR("Failed to extend partition: %s\n", zx_status_get_string(status)); |
| return status; |
| } |
| } |
| } |
| |
| return ZX_OK; |
| } |
| |
| // Holds the description of a partition with a single extent. Note that even though some code asks |
| // for a PartitionDescriptor, in reality it treats that as a descriptor followed by a bunch of |
| // extents, so this copes with that de-facto pattern. |
| struct FvmPartition { |
| fvm::PartitionDescriptor descriptor; |
| fvm::ExtentDescriptor extent; |
| }; |
| |
| // Description of the basic FVM partitions, with no real information about extents. |
| // In order to use the partitions, they should be formatted with the appropriate |
| // filesystem. |
| constexpr FvmPartition kBasicPartitions[] = {{{0, GUID_BLOB_VALUE, "blobfs", 0, 0}, {0, 0, 1, 0}}, |
| {{0, GUID_DATA_VALUE, "minfs", 0, 0}, {0, 0, 1, 0}}}; |
| |
| } // namespace |
| |
| zx::status<> AllocateEmptyPartitions(const fbl::unique_fd& devfs_root, |
| const fbl::unique_fd& fvm_fd) { |
| fbl::Array<PartitionInfo> partitions(new PartitionInfo[2], 2); |
| partitions[0].pd = const_cast<fvm::PartitionDescriptor*>(&kBasicPartitions[0].descriptor); |
| partitions[1].pd = const_cast<fvm::PartitionDescriptor*>(&kBasicPartitions[1].descriptor); |
| partitions[0].active = true; |
| partitions[1].active = true; |
| |
| return zx::make_status(AllocatePartitions(devfs_root, fvm_fd, &partitions)); |
| } |
| |
| zx::status<> FvmStreamPartitions(const fbl::unique_fd& devfs_root, |
| std::unique_ptr<PartitionClient> partition_client, |
| std::unique_ptr<fvm::ReaderInterface> payload) { |
| std::unique_ptr<fvm::SparseReader> reader; |
| zx::status<> status = zx::ok(); |
| if (status = zx::make_status(fvm::SparseReader::Create(std::move(payload), &reader)); |
| status.is_error()) { |
| return status.take_error(); |
| } |
| |
| LOG("Header Validated - OK\n"); |
| |
| fvm::SparseImage* hdr = reader->Image(); |
| // Acquire an fd to the FVM, either by finding one that already |
| // exists, or formatting a new one. |
| fbl::unique_fd fvm_fd( |
| FvmPartitionFormat(devfs_root, partition_client->block_fd(), *hdr, BindOption::TryBind)); |
| if (!fvm_fd) { |
| ERROR("Couldn't find FVM partition\n"); |
| return zx::error(ZX_ERR_IO); |
| } |
| |
| fbl::Array<PartitionInfo> parts(new PartitionInfo[hdr->partition_count], hdr->partition_count); |
| |
| // Parse the incoming image and calculate its size. |
| // |
| // Additionally, delete the old versions of any new partitions. |
| size_t requested_slices = 0; |
| if (status = zx::make_status(PreProcessPartitions(fvm_fd, reader, parts, &requested_slices)); |
| status.is_error()) { |
| ERROR("Failed to validate partitions: %s\n", status.status_string()); |
| return status.take_error(); |
| } |
| |
| // Contend with issues from an image that may be too large for this device. |
| VolumeInfo info; |
| status = zx::make_status( |
| fvm_query(fvm_fd.get(), reinterpret_cast<fuchsia_hardware_block_volume_VolumeInfo*>(&info))); |
| if (status.is_error()) { |
| ERROR("Failed to acquire FVM info: %s\n", status.status_string()); |
| return status.take_error(); |
| } |
| size_t free_slices = info.pslice_total_count - info.pslice_allocated_count; |
| if (info.pslice_total_count < requested_slices) { |
| char buf[256]; |
| snprintf(buf, sizeof(buf), "Image size (%zu) > Storage size (%zu)", |
| requested_slices * hdr->slice_size, info.pslice_total_count * hdr->slice_size); |
| Warn(buf, "Image is too large to be paved to device"); |
| return zx::error(ZX_ERR_NO_SPACE); |
| } |
| if (free_slices < requested_slices) { |
| Warn("Not enough space to non-destructively pave", |
| "Automatically reinitializing FVM; Expect data loss"); |
| fvm_fd = |
| FvmPartitionFormat(devfs_root, partition_client->block_fd(), *hdr, BindOption::Reformat); |
| if (!fvm_fd) { |
| ERROR("Couldn't reformat FVM partition.\n"); |
| return zx::error(ZX_ERR_IO); |
| } |
| LOG("FVM Reformatted successfully.\n"); |
| } |
| |
| LOG("Partitions pre-validated successfully: Enough space exists to pave.\n"); |
| |
| // Actually allocate the storage for the incoming image. |
| if (status = zx::make_status(AllocatePartitions(devfs_root, fvm_fd, &parts)); status.is_error()) { |
| ERROR("Failed to allocate partitions: %s\n", status.status_string()); |
| return status.take_error(); |
| } |
| |
| LOG("Partition space pre-allocated successfully.\n"); |
| |
| constexpr size_t vmo_size = 1 << 20; |
| |
| fzl::VmoMapper mapping; |
| zx::vmo vmo; |
| if (mapping.CreateAndMap(vmo_size, ZX_VM_PERM_READ | ZX_VM_PERM_WRITE, nullptr, &vmo) != ZX_OK) { |
| ERROR("Failed to create stream VMO\n"); |
| return zx::error(ZX_ERR_NO_MEMORY); |
| } |
| |
| fdio_cpp::FdioCaller volume_manager(std::move(fvm_fd)); |
| |
| // Now that all partitions are preallocated, begin streaming data to them. |
| for (size_t p = 0; p < parts.size(); p++) { |
| vmoid_t vmoid; |
| block_client::Client client; |
| auto status = zx::make_status(RegisterFastBlockIo(parts[p].new_part, vmo, &vmoid, &client)); |
| if (status.is_error()) { |
| ERROR("Failed to register fast block IO\n"); |
| return status.take_error(); |
| } |
| |
| fdio_cpp::UnownedFdioCaller partition_connection(parts[p].new_part.get()); |
| auto result = block::Block::Call::GetInfo(partition_connection.channel()); |
| if (!result.ok()) { |
| ERROR("Couldn't get partition block info: %s\n", zx_status_get_string(result.status())); |
| return zx::error(result.status()); |
| } |
| const auto& response = result.value(); |
| if (response.status != ZX_OK) { |
| ERROR("Couldn't get partition block info: %s\n", zx_status_get_string(response.status)); |
| return zx::error(response.status); |
| } |
| |
| size_t block_size = response.info->block_size; |
| |
| block_fifo_request_t request; |
| request.group = 0; |
| request.vmoid = vmoid; |
| request.opcode = BLOCKIO_WRITE; |
| |
| LOG("Streaming partition %zu\n", p); |
| status = zx::make_status( |
| StreamFvmPartition(reader.get(), &parts[p], mapping, client, block_size, &request)); |
| LOG("Done streaming partition %zu\n", p); |
| if (status.is_error()) { |
| ERROR("Failed to stream partition status=%d\n", status.error_value()); |
| return status.take_error(); |
| } |
| if (status = zx::make_status(FlushClient(&client)); status.is_error()) { |
| ERROR("Failed to flush client\n"); |
| return status.take_error(); |
| } |
| LOG("Done flushing partition %zu\n", p); |
| } |
| |
| for (size_t p = 0; p < parts.size(); p++) { |
| fdio_cpp::UnownedFdioCaller partition_connection(parts[p].new_part.get()); |
| // Upgrade the old partition (currently active) to the new partition (currently |
| // inactive) so the new partition persists. |
| auto result = partition::Partition::Call::GetInstanceGuid(partition_connection.channel()); |
| if (!result.ok() || result.value().status != ZX_OK) { |
| ERROR("Failed to get unique GUID of new partition\n"); |
| return zx::error(ZX_ERR_BAD_STATE); |
| } |
| auto* guid = result.value().guid.get(); |
| |
| auto result2 = volume::VolumeManager::Call::Activate(volume_manager.channel(), *guid, *guid); |
| if (result2.status() != ZX_OK || result2.value().status != ZX_OK) { |
| ERROR("Failed to upgrade partition\n"); |
| return zx::error(ZX_ERR_IO); |
| } |
| } |
| |
| return zx::ok(); |
| } |
| |
| // Unbinds the FVM driver from the given device. Assumes that the driver is either |
| // loaded or not (but not in the process of being loaded). |
| zx_status_t FvmUnbind(const fbl::unique_fd& devfs_root, const char* device) { |
| size_t len = strnlen(device, PATH_MAX); |
| constexpr const char* kDevPath = "/dev/"; |
| constexpr size_t kDevPathLen = std::char_traits<char>::length(kDevPath); |
| |
| if (len == PATH_MAX || len <= kDevPathLen) { |
| ERROR("Invalid device name: %s\n", device); |
| return ZX_ERR_INVALID_ARGS; |
| } |
| fbl::StringBuffer<PATH_MAX> name_buffer; |
| name_buffer.Append(device + kDevPathLen); |
| name_buffer.Append("/fvm"); |
| |
| zx::channel local, remote; |
| zx_status_t status = zx::channel::create(0, &local, &remote); |
| if (status != ZX_OK) { |
| return status; |
| } |
| fdio_cpp::UnownedFdioCaller caller(devfs_root.get()); |
| status = fdio_service_connect_at(caller.borrow_channel(), name_buffer.data(), remote.release()); |
| if (status != ZX_OK) { |
| ERROR("Unable to connect to FVM service: %s on device %s\n", zx_status_get_string(status), |
| name_buffer.data()); |
| return status; |
| } |
| auto resp = device::Controller::Call::ScheduleUnbind(local.borrow()); |
| if (resp.status() != ZX_OK) { |
| ERROR("Failed to schedule FVM unbind: %s on device %s\n", zx_status_get_string(resp.status()), |
| name_buffer.data()); |
| return resp.status(); |
| } |
| if (resp->result.is_err()) { |
| ERROR("FVM unbind failed: %s on device %s\n", zx_status_get_string(resp->result.err()), |
| name_buffer.data()); |
| return resp->result.err(); |
| } |
| return ZX_OK; |
| } |
| |
| } // namespace paver |