876 lines
30 KiB
C++
876 lines
30 KiB
C++
/*
|
|
* Copyright (C) 2020 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 "snapuserd.h"
|
|
|
|
#include <csignal>
|
|
|
|
#include <libsnapshot/snapuserd_client.h>
|
|
|
|
namespace android {
|
|
namespace snapshot {
|
|
|
|
using namespace android;
|
|
using namespace android::dm;
|
|
using android::base::unique_fd;
|
|
|
|
#define SNAP_LOG(level) LOG(level) << misc_name_ << ": "
|
|
#define SNAP_PLOG(level) PLOG(level) << misc_name_ << ": "
|
|
|
|
static constexpr size_t PAYLOAD_SIZE = (1UL << 20);
|
|
|
|
static_assert(PAYLOAD_SIZE >= BLOCK_SIZE);
|
|
|
|
void BufferSink::Initialize(size_t size) {
|
|
buffer_size_ = size;
|
|
buffer_offset_ = 0;
|
|
buffer_ = std::make_unique<uint8_t[]>(size);
|
|
}
|
|
|
|
void* BufferSink::GetPayloadBuffer(size_t size) {
|
|
if ((buffer_size_ - buffer_offset_) < size) return nullptr;
|
|
|
|
char* buffer = reinterpret_cast<char*>(GetBufPtr());
|
|
struct dm_user_message* msg = (struct dm_user_message*)(&(buffer[0]));
|
|
return (char*)msg->payload.buf + buffer_offset_;
|
|
}
|
|
|
|
void* BufferSink::GetBuffer(size_t requested, size_t* actual) {
|
|
void* buf = GetPayloadBuffer(requested);
|
|
if (!buf) {
|
|
*actual = 0;
|
|
return nullptr;
|
|
}
|
|
*actual = requested;
|
|
return buf;
|
|
}
|
|
|
|
struct dm_user_header* BufferSink::GetHeaderPtr() {
|
|
CHECK(sizeof(struct dm_user_header) <= buffer_size_);
|
|
char* buf = reinterpret_cast<char*>(GetBufPtr());
|
|
struct dm_user_header* header = (struct dm_user_header*)(&(buf[0]));
|
|
return header;
|
|
}
|
|
|
|
Snapuserd::Snapuserd(const std::string& misc_name, const std::string& cow_device,
|
|
const std::string& backing_device) {
|
|
misc_name_ = misc_name;
|
|
cow_device_ = cow_device;
|
|
backing_store_device_ = backing_device;
|
|
control_device_ = "/dev/dm-user/" + misc_name;
|
|
}
|
|
|
|
// Construct kernel COW header in memory
|
|
// This header will be in sector 0. The IO
|
|
// request will always be 4k. After constructing
|
|
// the header, zero out the remaining block.
|
|
void Snapuserd::ConstructKernelCowHeader() {
|
|
void* buffer = bufsink_.GetPayloadBuffer(BLOCK_SIZE);
|
|
CHECK(buffer != nullptr);
|
|
|
|
memset(buffer, 0, BLOCK_SIZE);
|
|
|
|
struct disk_header* dh = reinterpret_cast<struct disk_header*>(buffer);
|
|
|
|
dh->magic = SNAP_MAGIC;
|
|
dh->valid = SNAPSHOT_VALID;
|
|
dh->version = SNAPSHOT_DISK_VERSION;
|
|
dh->chunk_size = CHUNK_SIZE;
|
|
}
|
|
|
|
// Start the replace operation. This will read the
|
|
// internal COW format and if the block is compressed,
|
|
// it will be de-compressed.
|
|
bool Snapuserd::ProcessReplaceOp(const CowOperation* cow_op) {
|
|
if (!reader_->ReadData(*cow_op, &bufsink_)) {
|
|
SNAP_LOG(ERROR) << "ReadData failed for chunk: " << cow_op->new_block;
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
// Start the copy operation. This will read the backing
|
|
// block device which is represented by cow_op->source.
|
|
bool Snapuserd::ProcessCopyOp(const CowOperation* cow_op) {
|
|
void* buffer = bufsink_.GetPayloadBuffer(BLOCK_SIZE);
|
|
CHECK(buffer != nullptr);
|
|
|
|
// Issue a single 4K IO. However, this can be optimized
|
|
// if the successive blocks are contiguous.
|
|
if (!android::base::ReadFullyAtOffset(backing_store_fd_, buffer, BLOCK_SIZE,
|
|
cow_op->source * BLOCK_SIZE)) {
|
|
SNAP_LOG(ERROR) << "Copy-op failed. Read from backing store at: " << cow_op->source;
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::ProcessZeroOp() {
|
|
// Zero out the entire block
|
|
void* buffer = bufsink_.GetPayloadBuffer(BLOCK_SIZE);
|
|
CHECK(buffer != nullptr);
|
|
|
|
memset(buffer, 0, BLOCK_SIZE);
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::ProcessCowOp(const CowOperation* cow_op) {
|
|
CHECK(cow_op != nullptr);
|
|
|
|
switch (cow_op->type) {
|
|
case kCowReplaceOp: {
|
|
return ProcessReplaceOp(cow_op);
|
|
}
|
|
|
|
case kCowZeroOp: {
|
|
return ProcessZeroOp();
|
|
}
|
|
|
|
case kCowCopyOp: {
|
|
return ProcessCopyOp(cow_op);
|
|
}
|
|
|
|
default: {
|
|
SNAP_LOG(ERROR) << "Unknown operation-type found: " << cow_op->type;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
int Snapuserd::ReadUnalignedSector(sector_t sector, size_t size,
|
|
std::map<sector_t, const CowOperation*>::iterator& it) {
|
|
size_t skip_sector_size = 0;
|
|
|
|
SNAP_LOG(DEBUG) << "ReadUnalignedSector: sector " << sector << " size: " << size
|
|
<< " Aligned sector: " << it->second;
|
|
|
|
if (!ProcessCowOp(it->second)) {
|
|
SNAP_LOG(ERROR) << "ReadUnalignedSector: " << sector << " failed";
|
|
return -1;
|
|
}
|
|
|
|
int num_sectors_skip = sector - it->first;
|
|
|
|
if (num_sectors_skip > 0) {
|
|
skip_sector_size = num_sectors_skip << SECTOR_SHIFT;
|
|
char* buffer = reinterpret_cast<char*>(bufsink_.GetBufPtr());
|
|
struct dm_user_message* msg = (struct dm_user_message*)(&(buffer[0]));
|
|
|
|
memmove(msg->payload.buf, (char*)msg->payload.buf + skip_sector_size,
|
|
(BLOCK_SIZE - skip_sector_size));
|
|
}
|
|
|
|
bufsink_.ResetBufferOffset();
|
|
return std::min(size, (BLOCK_SIZE - skip_sector_size));
|
|
}
|
|
|
|
/*
|
|
* Read the data for a given COW Operation.
|
|
*
|
|
* Kernel can issue IO at a sector granularity.
|
|
* Hence, an IO may end up with reading partial
|
|
* data from a COW operation or we may also
|
|
* end up with interspersed request between
|
|
* two COW operations.
|
|
*
|
|
*/
|
|
int Snapuserd::ReadData(sector_t sector, size_t size) {
|
|
/*
|
|
* chunk_map stores COW operation at 4k granularity.
|
|
* If the requested IO with the sector falls on the 4k
|
|
* boundary, then we can read the COW op directly without
|
|
* any issue.
|
|
*
|
|
* However, if the requested sector is not 4K aligned,
|
|
* then we will have the find the nearest COW operation
|
|
* and chop the 4K block to fetch the requested sector.
|
|
*/
|
|
std::map<sector_t, const CowOperation*>::iterator it = chunk_map_.find(sector);
|
|
if (it == chunk_map_.end()) {
|
|
it = chunk_map_.lower_bound(sector);
|
|
if (it != chunk_map_.begin()) {
|
|
--it;
|
|
}
|
|
|
|
/*
|
|
* If the IO is spanned between two COW operations,
|
|
* split the IO into two parts:
|
|
*
|
|
* 1: Read the first part from the single COW op
|
|
* 2: Read the second part from the next COW op.
|
|
*
|
|
* Ex: Let's say we have a 1024 Bytes IO request.
|
|
*
|
|
* 0 COW OP-1 4096 COW OP-2 8192
|
|
* |******************|*******************|
|
|
* |*****|*****|
|
|
* 3584 4608
|
|
* <- 1024B - >
|
|
*
|
|
* We have two COW operations which are 4k blocks.
|
|
* The IO is requested for 1024 Bytes which are spanned
|
|
* between two COW operations. We will split this IO
|
|
* into two parts:
|
|
*
|
|
* 1: IO of size 512B from offset 3584 bytes (COW OP-1)
|
|
* 2: IO of size 512B from offset 4096 bytes (COW OP-2)
|
|
*/
|
|
return ReadUnalignedSector(sector, size, it);
|
|
}
|
|
|
|
int num_ops = DIV_ROUND_UP(size, BLOCK_SIZE);
|
|
while (num_ops) {
|
|
if (!ProcessCowOp(it->second)) {
|
|
return -1;
|
|
}
|
|
num_ops -= 1;
|
|
it++;
|
|
// Update the buffer offset
|
|
bufsink_.UpdateBufferOffset(BLOCK_SIZE);
|
|
|
|
SNAP_LOG(DEBUG) << "ReadData at sector: " << sector << " size: " << size;
|
|
}
|
|
|
|
// Reset the buffer offset
|
|
bufsink_.ResetBufferOffset();
|
|
return size;
|
|
}
|
|
|
|
/*
|
|
* dm-snap does prefetch reads while reading disk-exceptions.
|
|
* By default, prefetch value is set to 12; this means that
|
|
* dm-snap will issue 12 areas wherein each area is a 4k page
|
|
* of disk-exceptions.
|
|
*
|
|
* If during prefetch, if the chunk-id seen is beyond the
|
|
* actual number of metadata page, fill the buffer with zero.
|
|
* When dm-snap starts parsing the buffer, it will stop
|
|
* reading metadata page once the buffer content is zero.
|
|
*/
|
|
bool Snapuserd::ZerofillDiskExceptions(size_t read_size) {
|
|
size_t size = exceptions_per_area_ * sizeof(struct disk_exception);
|
|
|
|
if (read_size > size) {
|
|
return false;
|
|
}
|
|
|
|
void* buffer = bufsink_.GetPayloadBuffer(size);
|
|
CHECK(buffer != nullptr);
|
|
|
|
memset(buffer, 0, size);
|
|
return true;
|
|
}
|
|
|
|
/*
|
|
* A disk exception is a simple mapping of old_chunk to new_chunk.
|
|
* When dm-snapshot device is created, kernel requests these mapping.
|
|
*
|
|
* Each disk exception is of size 16 bytes. Thus a single 4k page can
|
|
* have:
|
|
*
|
|
* exceptions_per_area_ = 4096/16 = 256. This entire 4k page
|
|
* is considered a metadata page and it is represented by chunk ID.
|
|
*
|
|
* Convert the chunk ID to index into the vector which gives us
|
|
* the metadata page.
|
|
*/
|
|
bool Snapuserd::ReadDiskExceptions(chunk_t chunk, size_t read_size) {
|
|
uint32_t stride = exceptions_per_area_ + 1;
|
|
size_t size;
|
|
|
|
// ChunkID to vector index
|
|
lldiv_t divresult = lldiv(chunk, stride);
|
|
|
|
if (divresult.quot < vec_.size()) {
|
|
size = exceptions_per_area_ * sizeof(struct disk_exception);
|
|
|
|
CHECK(read_size == size);
|
|
|
|
void* buffer = bufsink_.GetPayloadBuffer(size);
|
|
CHECK(buffer != nullptr);
|
|
|
|
memcpy(buffer, vec_[divresult.quot].get(), size);
|
|
} else {
|
|
return ZerofillDiskExceptions(read_size);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
loff_t Snapuserd::GetMergeStartOffset(void* merged_buffer, void* unmerged_buffer,
|
|
int* unmerged_exceptions) {
|
|
loff_t offset = 0;
|
|
*unmerged_exceptions = 0;
|
|
|
|
while (*unmerged_exceptions <= exceptions_per_area_) {
|
|
struct disk_exception* merged_de =
|
|
reinterpret_cast<struct disk_exception*>((char*)merged_buffer + offset);
|
|
struct disk_exception* cow_de =
|
|
reinterpret_cast<struct disk_exception*>((char*)unmerged_buffer + offset);
|
|
|
|
// Unmerged op by the kernel
|
|
if (merged_de->old_chunk != 0) {
|
|
CHECK(merged_de->new_chunk != 0);
|
|
CHECK(merged_de->old_chunk == cow_de->old_chunk);
|
|
CHECK(merged_de->new_chunk == cow_de->new_chunk);
|
|
|
|
offset += sizeof(struct disk_exception);
|
|
*unmerged_exceptions += 1;
|
|
continue;
|
|
}
|
|
|
|
// Merge complete on this exception. However, we don't know how many
|
|
// merged in this cycle; hence break here.
|
|
CHECK(merged_de->new_chunk == 0);
|
|
CHECK(merged_de->old_chunk == 0);
|
|
|
|
break;
|
|
}
|
|
|
|
CHECK(!(*unmerged_exceptions == exceptions_per_area_));
|
|
|
|
SNAP_LOG(DEBUG) << "Unmerged_Exceptions: " << *unmerged_exceptions << " Offset: " << offset;
|
|
return offset;
|
|
}
|
|
|
|
int Snapuserd::GetNumberOfMergedOps(void* merged_buffer, void* unmerged_buffer, loff_t offset,
|
|
int unmerged_exceptions, bool* copy_op) {
|
|
int merged_ops_cur_iter = 0;
|
|
|
|
// Find the operations which are merged in this cycle.
|
|
while ((unmerged_exceptions + merged_ops_cur_iter) < exceptions_per_area_) {
|
|
struct disk_exception* merged_de =
|
|
reinterpret_cast<struct disk_exception*>((char*)merged_buffer + offset);
|
|
struct disk_exception* cow_de =
|
|
reinterpret_cast<struct disk_exception*>((char*)unmerged_buffer + offset);
|
|
|
|
CHECK(merged_de->new_chunk == 0);
|
|
CHECK(merged_de->old_chunk == 0);
|
|
|
|
if (cow_de->new_chunk != 0) {
|
|
merged_ops_cur_iter += 1;
|
|
offset += sizeof(struct disk_exception);
|
|
const CowOperation* cow_op = chunk_map_[ChunkToSector(cow_de->new_chunk)];
|
|
CHECK(cow_op != nullptr);
|
|
CHECK(cow_op->new_block == cow_de->old_chunk);
|
|
if (cow_op->type == kCowCopyOp) {
|
|
*copy_op = true;
|
|
}
|
|
// zero out to indicate that operation is merged.
|
|
cow_de->old_chunk = 0;
|
|
cow_de->new_chunk = 0;
|
|
} else if (cow_de->old_chunk == 0) {
|
|
// Already merged op in previous iteration or
|
|
// This could also represent a partially filled area.
|
|
//
|
|
// If the op was merged in previous cycle, we don't have
|
|
// to count them.
|
|
CHECK(cow_de->new_chunk == 0);
|
|
break;
|
|
} else {
|
|
SNAP_LOG(ERROR) << "Error in merge operation. Found invalid metadata";
|
|
SNAP_LOG(ERROR) << "merged_de-old-chunk: " << merged_de->old_chunk;
|
|
SNAP_LOG(ERROR) << "merged_de-new-chunk: " << merged_de->new_chunk;
|
|
SNAP_LOG(ERROR) << "cow_de-old-chunk: " << cow_de->old_chunk;
|
|
SNAP_LOG(ERROR) << "cow_de-new-chunk: " << cow_de->new_chunk;
|
|
return -1;
|
|
}
|
|
}
|
|
|
|
if (*copy_op) {
|
|
CHECK(merged_ops_cur_iter == 1);
|
|
}
|
|
return merged_ops_cur_iter;
|
|
}
|
|
|
|
bool Snapuserd::ProcessMergeComplete(chunk_t chunk, void* buffer) {
|
|
uint32_t stride = exceptions_per_area_ + 1;
|
|
CowHeader header;
|
|
|
|
if (!reader_->GetHeader(&header)) {
|
|
SNAP_LOG(ERROR) << "Failed to get header";
|
|
return false;
|
|
}
|
|
|
|
// ChunkID to vector index
|
|
lldiv_t divresult = lldiv(chunk, stride);
|
|
CHECK(divresult.quot < vec_.size());
|
|
SNAP_LOG(DEBUG) << "ProcessMergeComplete: chunk: " << chunk
|
|
<< " Metadata-Index: " << divresult.quot;
|
|
|
|
int unmerged_exceptions = 0;
|
|
loff_t offset = GetMergeStartOffset(buffer, vec_[divresult.quot].get(), &unmerged_exceptions);
|
|
|
|
bool copy_op = false;
|
|
// Check if the merged operation is a copy operation. If so, then we need
|
|
// to explicitly sync the metadata before initiating the next merge.
|
|
// For ex: Consider a following sequence of copy operations in the COW file:
|
|
//
|
|
// Op-1: Copy 2 -> 3
|
|
// Op-2: Copy 1 -> 2
|
|
// Op-3: Copy 5 -> 10
|
|
//
|
|
// Op-1 and Op-2 are overlapping copy operations. The merge sequence will
|
|
// look like:
|
|
//
|
|
// Merge op-1: Copy 2 -> 3
|
|
// Merge op-2: Copy 1 -> 2
|
|
// Merge op-3: Copy 5 -> 10
|
|
//
|
|
// Now, let's say we have a crash _after_ Merge op-2; Block 2 contents would
|
|
// have been over-written by Block-1 after merge op-2. During next reboot,
|
|
// kernel will request the metadata for all the un-merged blocks. If we had
|
|
// not sync the metadata after Merge-op 1 and Merge op-2, snapuser daemon
|
|
// will think that these merge operations are still pending and hence will
|
|
// inform the kernel that Op-1 and Op-2 are un-merged blocks. When kernel
|
|
// resumes back the merging process, it will attempt to redo the Merge op-1
|
|
// once again. However, block 2 contents are wrong as it has the contents
|
|
// of block 1 from previous merge cycle. Although, merge will silently succeed,
|
|
// this will lead to silent data corruption.
|
|
//
|
|
int merged_ops_cur_iter = GetNumberOfMergedOps(buffer, vec_[divresult.quot].get(), offset,
|
|
unmerged_exceptions, ©_op);
|
|
|
|
// There should be at least one operation merged in this cycle
|
|
CHECK(merged_ops_cur_iter > 0);
|
|
|
|
header.num_merge_ops += merged_ops_cur_iter;
|
|
reader_->UpdateMergeProgress(merged_ops_cur_iter);
|
|
if (!writer_->CommitMerge(merged_ops_cur_iter, copy_op)) {
|
|
SNAP_LOG(ERROR) << "CommitMerge failed...";
|
|
return false;
|
|
}
|
|
|
|
SNAP_LOG(DEBUG) << "Merge success: " << merged_ops_cur_iter << "chunk: " << chunk;
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::IsChunkIdMetadata(chunk_t chunk) {
|
|
uint32_t stride = exceptions_per_area_ + 1;
|
|
lldiv_t divresult = lldiv(chunk, stride);
|
|
|
|
return (divresult.rem == NUM_SNAPSHOT_HDR_CHUNKS);
|
|
}
|
|
|
|
// Find the next free chunk-id to be assigned. Check if the next free
|
|
// chunk-id represents a metadata page. If so, skip it.
|
|
chunk_t Snapuserd::GetNextAllocatableChunkId(chunk_t chunk) {
|
|
chunk_t next_chunk = chunk + 1;
|
|
|
|
if (IsChunkIdMetadata(next_chunk)) {
|
|
next_chunk += 1;
|
|
}
|
|
return next_chunk;
|
|
}
|
|
|
|
/*
|
|
* Read the metadata from COW device and
|
|
* construct the metadata as required by the kernel.
|
|
*
|
|
* Please see design on kernel COW format
|
|
*
|
|
* 1: Read the metadata from internal COW device
|
|
* 2: There are 3 COW operations:
|
|
* a: Replace op
|
|
* b: Copy op
|
|
* c: Zero op
|
|
* 3: For each of the 3 operations, op->new_block
|
|
* represents the block number in the base device
|
|
* for which one of the 3 operations have to be applied.
|
|
* This represents the old_chunk in the kernel COW format
|
|
* 4: We need to assign new_chunk for a corresponding old_chunk
|
|
* 5: The algorithm is similar to how kernel assigns chunk number
|
|
* while creating exceptions. However, there are few cases
|
|
* which needs to be addressed here:
|
|
* a: During merge process, kernel scans the metadata page
|
|
* from backwards when merge is initiated. Since, we need
|
|
* to make sure that the merge ordering follows our COW format,
|
|
* we read the COW operation from backwards and populate the
|
|
* metadata so that when kernel starts the merging from backwards,
|
|
* those ops correspond to the beginning of our COW format.
|
|
* b: Kernel can merge successive operations if the two chunk IDs
|
|
* are contiguous. This can be problematic when there is a crash
|
|
* during merge; specifically when the merge operation has dependency.
|
|
* These dependencies can only happen during copy operations.
|
|
*
|
|
* To avoid this problem, we make sure that no two copy-operations
|
|
* do not have contiguous chunk IDs. Additionally, we make sure
|
|
* that each copy operation is merged individually.
|
|
* 6: Use a monotonically increasing chunk number to assign the
|
|
* new_chunk
|
|
* 7: Each chunk-id represents either a: Metadata page or b: Data page
|
|
* 8: Chunk-id representing a data page is stored in a map.
|
|
* 9: Chunk-id representing a metadata page is converted into a vector
|
|
* index. We store this in vector as kernel requests metadata during
|
|
* two stage:
|
|
* a: When initial dm-snapshot device is created, kernel requests
|
|
* all the metadata and stores it in its internal data-structures.
|
|
* b: During merge, kernel once again requests the same metadata
|
|
* once-again.
|
|
* In both these cases, a quick lookup based on chunk-id is done.
|
|
* 10: When chunk number is incremented, we need to make sure that
|
|
* if the chunk is representing a metadata page and skip.
|
|
* 11: Each 4k page will contain 256 disk exceptions. We call this
|
|
* exceptions_per_area_
|
|
* 12: Kernel will stop issuing metadata IO request when new-chunk ID is 0.
|
|
*/
|
|
bool Snapuserd::ReadMetadata() {
|
|
reader_ = std::make_unique<CowReader>();
|
|
CowHeader header;
|
|
CowOptions options;
|
|
bool prev_copy_op = false;
|
|
bool metadata_found = false;
|
|
|
|
SNAP_LOG(DEBUG) << "ReadMetadata Start...";
|
|
|
|
if (!reader_->Parse(cow_fd_)) {
|
|
SNAP_LOG(ERROR) << "Failed to parse";
|
|
return false;
|
|
}
|
|
|
|
if (!reader_->GetHeader(&header)) {
|
|
SNAP_LOG(ERROR) << "Failed to get header";
|
|
return false;
|
|
}
|
|
|
|
CHECK(header.block_size == BLOCK_SIZE);
|
|
|
|
SNAP_LOG(DEBUG) << "Merge-ops: " << header.num_merge_ops;
|
|
reader_->InitializeMerge();
|
|
|
|
writer_ = std::make_unique<CowWriter>(options);
|
|
writer_->InitializeMerge(cow_fd_.get(), &header);
|
|
|
|
// Initialize the iterator for reading metadata
|
|
cowop_riter_ = reader_->GetRevOpIter();
|
|
|
|
exceptions_per_area_ = (CHUNK_SIZE << SECTOR_SHIFT) / sizeof(struct disk_exception);
|
|
|
|
// Start from chunk number 2. Chunk 0 represents header and chunk 1
|
|
// represents first metadata page.
|
|
chunk_t data_chunk_id = NUM_SNAPSHOT_HDR_CHUNKS + 1;
|
|
size_t num_ops = 0;
|
|
|
|
loff_t offset = 0;
|
|
std::unique_ptr<uint8_t[]> de_ptr =
|
|
std::make_unique<uint8_t[]>(exceptions_per_area_ * sizeof(struct disk_exception));
|
|
|
|
// This memset is important. Kernel will stop issuing IO when new-chunk ID
|
|
// is 0. When Area is not filled completely with all 256 exceptions,
|
|
// this memset will ensure that metadata read is completed.
|
|
memset(de_ptr.get(), 0, (exceptions_per_area_ * sizeof(struct disk_exception)));
|
|
|
|
while (!cowop_riter_->Done()) {
|
|
const CowOperation* cow_op = &cowop_riter_->Get();
|
|
struct disk_exception* de =
|
|
reinterpret_cast<struct disk_exception*>((char*)de_ptr.get() + offset);
|
|
|
|
if (IsMetadataOp(*cow_op)) {
|
|
cowop_riter_->Next();
|
|
continue;
|
|
}
|
|
|
|
metadata_found = true;
|
|
if ((cow_op->type == kCowCopyOp || prev_copy_op)) {
|
|
data_chunk_id = GetNextAllocatableChunkId(data_chunk_id);
|
|
}
|
|
|
|
prev_copy_op = (cow_op->type == kCowCopyOp);
|
|
|
|
// Construct the disk-exception
|
|
de->old_chunk = cow_op->new_block;
|
|
de->new_chunk = data_chunk_id;
|
|
|
|
SNAP_LOG(DEBUG) << "Old-chunk: " << de->old_chunk << "New-chunk: " << de->new_chunk;
|
|
|
|
// Store operation pointer.
|
|
chunk_map_[ChunkToSector(data_chunk_id)] = cow_op;
|
|
num_ops += 1;
|
|
offset += sizeof(struct disk_exception);
|
|
cowop_riter_->Next();
|
|
|
|
if (num_ops == exceptions_per_area_) {
|
|
// Store it in vector at the right index. This maps the chunk-id to
|
|
// vector index.
|
|
vec_.push_back(std::move(de_ptr));
|
|
offset = 0;
|
|
num_ops = 0;
|
|
|
|
// Create buffer for next area
|
|
de_ptr = std::make_unique<uint8_t[]>(exceptions_per_area_ *
|
|
sizeof(struct disk_exception));
|
|
memset(de_ptr.get(), 0, (exceptions_per_area_ * sizeof(struct disk_exception)));
|
|
|
|
if (cowop_riter_->Done()) {
|
|
vec_.push_back(std::move(de_ptr));
|
|
SNAP_LOG(DEBUG) << "ReadMetadata() completed; Number of Areas: " << vec_.size();
|
|
}
|
|
}
|
|
|
|
data_chunk_id = GetNextAllocatableChunkId(data_chunk_id);
|
|
}
|
|
|
|
// Partially filled area or there is no metadata
|
|
// If there is no metadata, fill with zero so that kernel
|
|
// is aware that merge is completed.
|
|
if (num_ops || !metadata_found) {
|
|
vec_.push_back(std::move(de_ptr));
|
|
SNAP_LOG(DEBUG) << "ReadMetadata() completed. Partially filled area num_ops: " << num_ops
|
|
<< "Areas : " << vec_.size();
|
|
}
|
|
|
|
SNAP_LOG(DEBUG) << "ReadMetadata() completed. Final_chunk_id: " << data_chunk_id
|
|
<< "Num Sector: " << ChunkToSector(data_chunk_id);
|
|
|
|
// Total number of sectors required for creating dm-user device
|
|
num_sectors_ = ChunkToSector(data_chunk_id);
|
|
metadata_read_done_ = true;
|
|
return true;
|
|
}
|
|
|
|
void MyLogger(android::base::LogId, android::base::LogSeverity severity, const char*, const char*,
|
|
unsigned int, const char* message) {
|
|
if (severity == android::base::ERROR) {
|
|
fprintf(stderr, "%s\n", message);
|
|
} else {
|
|
fprintf(stdout, "%s\n", message);
|
|
}
|
|
}
|
|
|
|
// Read Header from dm-user misc device. This gives
|
|
// us the sector number for which IO is issued by dm-snapshot device
|
|
bool Snapuserd::ReadDmUserHeader() {
|
|
if (!android::base::ReadFully(ctrl_fd_, bufsink_.GetBufPtr(), sizeof(struct dm_user_header))) {
|
|
SNAP_PLOG(ERROR) << "Control-read failed";
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
// Send the payload/data back to dm-user misc device.
|
|
bool Snapuserd::WriteDmUserPayload(size_t size) {
|
|
if (!android::base::WriteFully(ctrl_fd_, bufsink_.GetBufPtr(),
|
|
sizeof(struct dm_user_header) + size)) {
|
|
SNAP_PLOG(ERROR) << "Write to dm-user failed";
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::ReadDmUserPayload(void* buffer, size_t size) {
|
|
if (!android::base::ReadFully(ctrl_fd_, buffer, size)) {
|
|
SNAP_PLOG(ERROR) << "ReadDmUserPayload failed";
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::InitCowDevice() {
|
|
cow_fd_.reset(open(cow_device_.c_str(), O_RDWR));
|
|
if (cow_fd_ < 0) {
|
|
SNAP_PLOG(ERROR) << "Open Failed: " << cow_device_;
|
|
return false;
|
|
}
|
|
|
|
// Allocate the buffer which is used to communicate between
|
|
// daemon and dm-user. The buffer comprises of header and a fixed payload.
|
|
// If the dm-user requests a big IO, the IO will be broken into chunks
|
|
// of PAYLOAD_SIZE.
|
|
size_t buf_size = sizeof(struct dm_user_header) + PAYLOAD_SIZE;
|
|
bufsink_.Initialize(buf_size);
|
|
|
|
return ReadMetadata();
|
|
}
|
|
|
|
bool Snapuserd::InitBackingAndControlDevice() {
|
|
backing_store_fd_.reset(open(backing_store_device_.c_str(), O_RDONLY));
|
|
if (backing_store_fd_ < 0) {
|
|
SNAP_PLOG(ERROR) << "Open Failed: " << backing_store_device_;
|
|
return false;
|
|
}
|
|
|
|
ctrl_fd_.reset(open(control_device_.c_str(), O_RDWR));
|
|
if (ctrl_fd_ < 0) {
|
|
SNAP_PLOG(ERROR) << "Unable to open " << control_device_;
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::DmuserWriteRequest() {
|
|
struct dm_user_header* header = bufsink_.GetHeaderPtr();
|
|
|
|
// device mapper has the capability to allow
|
|
// targets to flush the cache when writes are completed. This
|
|
// is controlled by each target by a flag "flush_supported".
|
|
// This flag is set by dm-user. When flush is supported,
|
|
// a number of zero-length bio's will be submitted to
|
|
// the target for the purpose of flushing cache. It is the
|
|
// responsibility of the target driver - which is dm-user in this
|
|
// case, to remap these bio's to the underlying device. Since,
|
|
// there is no underlying device for dm-user, this zero length
|
|
// bio's gets routed to daemon.
|
|
//
|
|
// Flush operations are generated post merge by dm-snap by having
|
|
// REQ_PREFLUSH flag set. Snapuser daemon doesn't have anything
|
|
// to flush per se; hence, just respond back with a success message.
|
|
if (header->sector == 0) {
|
|
CHECK(header->len == 0);
|
|
header->type = DM_USER_RESP_SUCCESS;
|
|
if (!WriteDmUserPayload(0)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
size_t remaining_size = header->len;
|
|
size_t read_size = std::min(PAYLOAD_SIZE, remaining_size);
|
|
CHECK(read_size == BLOCK_SIZE);
|
|
|
|
CHECK(header->sector > 0);
|
|
chunk_t chunk = SectorToChunk(header->sector);
|
|
CHECK(chunk_map_.find(header->sector) == chunk_map_.end());
|
|
|
|
void* buffer = bufsink_.GetPayloadBuffer(read_size);
|
|
CHECK(buffer != nullptr);
|
|
header->type = DM_USER_RESP_SUCCESS;
|
|
|
|
if (!ReadDmUserPayload(buffer, read_size)) {
|
|
SNAP_LOG(ERROR) << "ReadDmUserPayload failed for chunk id: " << chunk
|
|
<< "Sector: " << header->sector;
|
|
header->type = DM_USER_RESP_ERROR;
|
|
}
|
|
|
|
if (header->type == DM_USER_RESP_SUCCESS && !ProcessMergeComplete(chunk, buffer)) {
|
|
SNAP_LOG(ERROR) << "ProcessMergeComplete failed for chunk id: " << chunk
|
|
<< "Sector: " << header->sector;
|
|
header->type = DM_USER_RESP_ERROR;
|
|
} else {
|
|
SNAP_LOG(DEBUG) << "ProcessMergeComplete success for chunk id: " << chunk
|
|
<< "Sector: " << header->sector;
|
|
}
|
|
|
|
if (!WriteDmUserPayload(0)) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::DmuserReadRequest() {
|
|
struct dm_user_header* header = bufsink_.GetHeaderPtr();
|
|
size_t remaining_size = header->len;
|
|
loff_t offset = 0;
|
|
sector_t sector = header->sector;
|
|
do {
|
|
size_t read_size = std::min(PAYLOAD_SIZE, remaining_size);
|
|
|
|
int ret = read_size;
|
|
header->type = DM_USER_RESP_SUCCESS;
|
|
chunk_t chunk = SectorToChunk(header->sector);
|
|
|
|
// Request to sector 0 is always for kernel
|
|
// representation of COW header. This IO should be only
|
|
// once during dm-snapshot device creation. We should
|
|
// never see multiple IO requests. Additionally this IO
|
|
// will always be a single 4k.
|
|
if (header->sector == 0) {
|
|
CHECK(metadata_read_done_ == true);
|
|
CHECK(read_size == BLOCK_SIZE);
|
|
ConstructKernelCowHeader();
|
|
SNAP_LOG(DEBUG) << "Kernel header constructed";
|
|
} else {
|
|
if (!offset && (read_size == BLOCK_SIZE) &&
|
|
chunk_map_.find(header->sector) == chunk_map_.end()) {
|
|
if (!ReadDiskExceptions(chunk, read_size)) {
|
|
SNAP_LOG(ERROR) << "ReadDiskExceptions failed for chunk id: " << chunk
|
|
<< "Sector: " << header->sector;
|
|
header->type = DM_USER_RESP_ERROR;
|
|
} else {
|
|
SNAP_LOG(DEBUG) << "ReadDiskExceptions success for chunk id: " << chunk
|
|
<< "Sector: " << header->sector;
|
|
}
|
|
} else {
|
|
chunk_t num_sectors_read = (offset >> SECTOR_SHIFT);
|
|
ret = ReadData(sector + num_sectors_read, read_size);
|
|
if (ret < 0) {
|
|
SNAP_LOG(ERROR) << "ReadData failed for chunk id: " << chunk
|
|
<< "Sector: " << header->sector;
|
|
header->type = DM_USER_RESP_ERROR;
|
|
} else {
|
|
SNAP_LOG(DEBUG) << "ReadData success for chunk id: " << chunk
|
|
<< "Sector: " << header->sector;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Daemon will not be terminated if there is any error. We will
|
|
// just send the error back to dm-user.
|
|
if (!WriteDmUserPayload(ret)) {
|
|
return false;
|
|
}
|
|
|
|
remaining_size -= ret;
|
|
offset += ret;
|
|
} while (remaining_size > 0);
|
|
|
|
return true;
|
|
}
|
|
|
|
bool Snapuserd::Run() {
|
|
struct dm_user_header* header = bufsink_.GetHeaderPtr();
|
|
|
|
bufsink_.Clear();
|
|
|
|
if (!ReadDmUserHeader()) {
|
|
SNAP_LOG(ERROR) << "ReadDmUserHeader failed";
|
|
return false;
|
|
}
|
|
|
|
SNAP_LOG(DEBUG) << "msg->seq: " << std::hex << header->seq;
|
|
SNAP_LOG(DEBUG) << "msg->type: " << std::hex << header->type;
|
|
SNAP_LOG(DEBUG) << "msg->flags: " << std::hex << header->flags;
|
|
SNAP_LOG(DEBUG) << "msg->sector: " << std::hex << header->sector;
|
|
SNAP_LOG(DEBUG) << "msg->len: " << std::hex << header->len;
|
|
|
|
switch (header->type) {
|
|
case DM_USER_REQ_MAP_READ: {
|
|
if (!DmuserReadRequest()) {
|
|
return false;
|
|
}
|
|
break;
|
|
}
|
|
|
|
case DM_USER_REQ_MAP_WRITE: {
|
|
if (!DmuserWriteRequest()) {
|
|
return false;
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
} // namespace snapshot
|
|
} // namespace android
|