// Copyright (c) Vitaliy Filippov, 2019+ // License: VNPL-1.1 (see README.md for details) #include "blockstore_impl.h" blockstore_init_meta::blockstore_init_meta(blockstore_impl_t *bs) { this->bs = bs; } void blockstore_init_meta::handle_event(ring_data_t *data) { if (data->res <= 0) { throw std::runtime_error( std::string("read metadata failed at offset ") + std::to_string(metadata_read) + std::string(": ") + strerror(-data->res) ); } prev_done = data->res > 0 ? submitted : 0; done_len = data->res; done_pos = metadata_read; metadata_read += data->res; submitted = 0; } int blockstore_init_meta::loop() { if (wait_state == 1) goto resume_1; printf("Reading blockstore metadata\n"); if (bs->inmemory_meta) metadata_buffer = bs->metadata_buffer; else metadata_buffer = memalign(MEM_ALIGNMENT, 2*bs->metadata_buf_size); if (!metadata_buffer) throw std::runtime_error("Failed to allocate metadata read buffer"); while (1) { resume_1: if (submitted) { wait_state = 1; return 1; } if (metadata_read < bs->meta_len) { sqe = bs->get_sqe(); if (!sqe) { throw std::runtime_error("io_uring is full while trying to read metadata"); } data = ((ring_data_t*)sqe->user_data); data->iov = { metadata_buffer + (bs->inmemory_meta ? metadata_read : (prev == 1 ? bs->metadata_buf_size : 0)), bs->meta_len - metadata_read > bs->metadata_buf_size ? bs->metadata_buf_size : bs->meta_len - metadata_read, }; data->callback = [this](ring_data_t *data) { handle_event(data); }; my_uring_prep_readv(sqe, bs->meta_fd, &data->iov, 1, bs->meta_offset + metadata_read); bs->ringloop->submit(); submitted = (prev == 1 ? 2 : 1); prev = submitted; } if (prev_done) { void *done_buf = bs->inmemory_meta ? (metadata_buffer + done_pos) : (metadata_buffer + (prev_done == 2 ? bs->metadata_buf_size : 0)); unsigned count = bs->meta_block_size / bs->clean_entry_size; for (int sector = 0; sector < done_len; sector += bs->meta_block_size) { // handle entries handle_entries(done_buf + sector, count, bs->block_order); done_cnt += count; } prev_done = 0; done_len = 0; } if (!submitted) { break; } } // metadata read finished printf("Metadata entries loaded: %lu, free blocks: %lu / %lu\n", entries_loaded, bs->data_alloc->get_free_count(), bs->block_count); if (!bs->inmemory_meta) { free(metadata_buffer); metadata_buffer = NULL; } return 0; } void blockstore_init_meta::handle_entries(void* entries, unsigned count, int block_order) { for (unsigned i = 0; i < count; i++) { clean_disk_entry *entry = (clean_disk_entry*)(entries + i*bs->clean_entry_size); if (!bs->inmemory_meta && bs->clean_entry_bitmap_size) { memcpy(bs->clean_bitmap + (done_cnt+i)*2*bs->clean_entry_bitmap_size, &entry->bitmap, 2*bs->clean_entry_bitmap_size); } if (entry->oid.inode > 0) { auto clean_it = bs->clean_db.find(entry->oid); if (clean_it == bs->clean_db.end() || clean_it->second.version < entry->version) { if (clean_it != bs->clean_db.end()) { // free the previous block #ifdef BLOCKSTORE_DEBUG printf("Free block %lu from %lx:%lx v%lu (new location is %lu)\n", clean_it->second.location >> block_order, clean_it->first.inode, clean_it->first.stripe, clean_it->second.version, done_cnt+i); #endif bs->data_alloc->set(clean_it->second.location >> block_order, false); } else { bs->inode_space_stats[entry->oid.inode] += bs->block_size; } entries_loaded++; #ifdef BLOCKSTORE_DEBUG printf("Allocate block (clean entry) %lu: %lx:%lx v%lu\n", done_cnt+i, entry->oid.inode, entry->oid.stripe, entry->version); #endif bs->data_alloc->set(done_cnt+i, true); bs->clean_db[entry->oid] = (struct clean_entry){ .version = entry->version, .location = (done_cnt+i) << block_order, }; } else { #ifdef BLOCKSTORE_DEBUG printf("Old clean entry %lu: %lx:%lx v%lu\n", done_cnt+i, entry->oid.inode, entry->oid.stripe, entry->version); #endif } } } } blockstore_init_journal::blockstore_init_journal(blockstore_impl_t *bs) { this->bs = bs; next_free = bs->journal.block_size; simple_callback = [this](ring_data_t *data1) { if (data1->res != data1->iov.iov_len) { throw std::runtime_error(std::string("I/O operation failed while reading journal: ") + strerror(-data1->res)); } wait_count--; }; } bool iszero(uint64_t *buf, int len) { for (int i = 0; i < len; i++) if (buf[i] != 0) return false; return true; } void blockstore_init_journal::handle_event(ring_data_t *data1) { if (data1->res <= 0) { throw std::runtime_error( std::string("read journal failed at offset ") + std::to_string(journal_pos) + std::string(": ") + strerror(-data1->res) ); } done.push_back({ .buf = submitted_buf, .pos = journal_pos, .len = (uint64_t)data1->res, }); journal_pos += data1->res; if (journal_pos >= bs->journal.len) { // Continue from the beginning journal_pos = bs->journal.block_size; wrapped = true; } submitted_buf = NULL; } #define GET_SQE() \ sqe = bs->get_sqe();\ if (!sqe)\ throw std::runtime_error("io_uring is full while trying to read journal");\ data = ((ring_data_t*)sqe->user_data) int blockstore_init_journal::loop() { if (wait_state == 1) goto resume_1; else if (wait_state == 2) goto resume_2; else if (wait_state == 3) goto resume_3; else if (wait_state == 4) goto resume_4; else if (wait_state == 5) goto resume_5; else if (wait_state == 6) goto resume_6; else if (wait_state == 7) goto resume_7; printf("Reading blockstore journal\n"); if (!bs->journal.inmemory) submitted_buf = memalign_or_die(MEM_ALIGNMENT, 2*bs->journal.block_size); else submitted_buf = bs->journal.buffer; // Read first block of the journal sqe = bs->get_sqe(); if (!sqe) throw std::runtime_error("io_uring is full while trying to read journal"); data = ((ring_data_t*)sqe->user_data); data->iov = { submitted_buf, bs->journal.block_size }; data->callback = simple_callback; my_uring_prep_readv(sqe, bs->journal.fd, &data->iov, 1, bs->journal.offset); bs->ringloop->submit(); wait_count = 1; resume_1: if (wait_count > 0) { wait_state = 1; return 1; } if (iszero((uint64_t*)submitted_buf, 3)) { // Journal is empty // FIXME handle this wrapping to journal_block_size better (maybe) bs->journal.used_start = bs->journal.block_size; bs->journal.next_free = bs->journal.block_size; // Initialize journal "superblock" and the first block memset(submitted_buf, 0, 2*bs->journal.block_size); *((journal_entry_start*)submitted_buf) = { .crc32 = 0, .magic = JOURNAL_MAGIC, .type = JE_START, .size = sizeof(journal_entry_start), .reserved = 0, .journal_start = bs->journal.block_size, }; ((journal_entry_start*)submitted_buf)->crc32 = je_crc32((journal_entry*)submitted_buf); if (bs->readonly) { printf("Skipping journal initialization because blockstore is readonly\n"); } else { // Cool effect. Same operations result in journal replay. // FIXME: Randomize initial crc32. Track crc32 when trimming. printf("Resetting journal\n"); GET_SQE(); data->iov = (struct iovec){ submitted_buf, 2*bs->journal.block_size }; data->callback = simple_callback; my_uring_prep_writev(sqe, bs->journal.fd, &data->iov, 1, bs->journal.offset); wait_count++; bs->ringloop->submit(); resume_6: if (wait_count > 0) { wait_state = 6; return 1; } if (!bs->disable_journal_fsync) { GET_SQE(); my_uring_prep_fsync(sqe, bs->journal.fd, IORING_FSYNC_DATASYNC); data->iov = { 0 }; data->callback = simple_callback; wait_count++; bs->ringloop->submit(); } resume_4: if (wait_count > 0) { wait_state = 4; return 1; } } if (!bs->journal.inmemory) { free(submitted_buf); } } else { // First block always contains a single JE_START entry je_start = (journal_entry_start*)submitted_buf; if (je_start->magic != JOURNAL_MAGIC || je_start->type != JE_START || je_start->size != sizeof(journal_entry_start) || je_crc32((journal_entry*)je_start) != je_start->crc32) { // Entry is corrupt throw std::runtime_error("first entry of the journal is corrupt"); } next_free = journal_pos = bs->journal.used_start = je_start->journal_start; if (!bs->journal.inmemory) free(submitted_buf); submitted_buf = NULL; crc32_last = 0; // Read journal while (1) { resume_2: if (submitted_buf) { wait_state = 2; return 1; } if (!wrapped || journal_pos < bs->journal.used_start) { GET_SQE(); uint64_t end = bs->journal.len; if (journal_pos < bs->journal.used_start) end = bs->journal.used_start; if (!bs->journal.inmemory) submitted_buf = memalign_or_die(MEM_ALIGNMENT, JOURNAL_BUFFER_SIZE); else submitted_buf = bs->journal.buffer + journal_pos; data->iov = { submitted_buf, end - journal_pos < JOURNAL_BUFFER_SIZE ? end - journal_pos : JOURNAL_BUFFER_SIZE, }; data->callback = [this](ring_data_t *data1) { handle_event(data1); }; my_uring_prep_readv(sqe, bs->journal.fd, &data->iov, 1, bs->journal.offset + journal_pos); bs->ringloop->submit(); } while (done.size() > 0) { handle_res = handle_journal_part(done[0].buf, done[0].pos, done[0].len); if (handle_res == 0) { // journal ended // zero out corrupted entry, if required if (init_write_buf && !bs->readonly) { GET_SQE(); data->iov = { init_write_buf, bs->journal.block_size }; data->callback = simple_callback; my_uring_prep_writev(sqe, bs->journal.fd, &data->iov, 1, bs->journal.offset + init_write_sector); wait_count++; bs->ringloop->submit(); resume_7: if (wait_count > 0) { wait_state = 7; return 1; } if (!bs->disable_journal_fsync) { GET_SQE(); data->iov = { 0 }; data->callback = simple_callback; my_uring_prep_fsync(sqe, bs->journal.fd, IORING_FSYNC_DATASYNC); wait_count++; bs->ringloop->submit(); } resume_5: if (wait_count > 0) { wait_state = 5; return 1; } } // wait for the next read to complete, then stop resume_3: if (submitted_buf) { wait_state = 3; return 1; } // free buffers if (!bs->journal.inmemory) for (auto & e: done) free(e.buf); done.clear(); break; } else if (handle_res == 1) { // OK, remove it if (!bs->journal.inmemory) { free(done[0].buf); } done.erase(done.begin()); } else if (handle_res == 2) { // Need to wait for more reads break; } } if (!submitted_buf) { break; } } } for (auto ov: double_allocs) { auto dirty_it = bs->dirty_db.find(ov); if (dirty_it != bs->dirty_db.end() && IS_BIG_WRITE(dirty_it->second.state) && dirty_it->second.location == UINT64_MAX) { printf("Fatal error (bug): %lx:%lx v%lu big_write journal_entry was allocated over another object\n", dirty_it->first.oid.inode, dirty_it->first.oid.stripe, dirty_it->first.version); exit(1); } } bs->flusher->mark_trim_possible(); bs->journal.dirty_start = bs->journal.next_free; printf( "Journal entries loaded: %lu, free journal space: %lu bytes (%08lx..%08lx is used), free blocks: %lu / %lu\n", entries_loaded, (bs->journal.next_free >= bs->journal.used_start ? bs->journal.len-bs->journal.block_size - (bs->journal.next_free-bs->journal.used_start) : bs->journal.used_start - bs->journal.next_free), bs->journal.used_start, bs->journal.next_free, bs->data_alloc->get_free_count(), bs->block_count ); bs->journal.crc32_last = crc32_last; return 0; } int blockstore_init_journal::handle_journal_part(void *buf, uint64_t done_pos, uint64_t len) { uint64_t proc_pos, pos; if (continue_pos != 0) { proc_pos = (continue_pos / bs->journal.block_size) * bs->journal.block_size; pos = continue_pos % bs->journal.block_size; continue_pos = 0; goto resume; } while (next_free >= done_pos && next_free < done_pos+len) { proc_pos = next_free; pos = 0; next_free += bs->journal.block_size; if (next_free >= bs->journal.len) { next_free = bs->journal.block_size; } resume: while (pos < bs->journal.block_size) { journal_entry *je = (journal_entry*)(buf + proc_pos - done_pos + pos); if (je->magic != JOURNAL_MAGIC || je_crc32(je) != je->crc32 || je->type < JE_MIN || je->type > JE_MAX || started && je->crc32_prev != crc32_last) { if (pos == 0) { // invalid entry in the beginning, this is definitely the end of the journal bs->journal.next_free = proc_pos; return 0; } else { // allow partially filled sectors break; } } if (je->type == JE_SMALL_WRITE || je->type == JE_SMALL_WRITE_INSTANT) { #ifdef BLOCKSTORE_DEBUG printf( "je_small_write%s oid=%lx:%lx ver=%lu offset=%u len=%u\n", je->type == JE_SMALL_WRITE_INSTANT ? "_instant" : "", je->small_write.oid.inode, je->small_write.oid.stripe, je->small_write.version, je->small_write.offset, je->small_write.len ); #endif // oid, version, offset, len uint64_t prev_free = next_free; if (next_free + je->small_write.len > bs->journal.len) { // data continues from the beginning of the journal next_free = bs->journal.block_size; } uint64_t location = next_free; next_free += je->small_write.len; if (next_free >= bs->journal.len) { next_free = bs->journal.block_size; } if (location != je->small_write.data_offset) { char err[1024]; snprintf(err, 1024, "BUG: calculated journal data offset (%08lx) != stored journal data offset (%08lx)", location, je->small_write.data_offset); throw std::runtime_error(err); } uint32_t data_crc32 = 0; if (location >= done_pos && location+je->small_write.len <= done_pos+len) { // data is within this buffer data_crc32 = crc32c(0, buf + location - done_pos, je->small_write.len); } else { // this case is even more interesting because we must carry data crc32 check to next buffer(s) uint64_t covered = 0; for (int i = 0; i < done.size(); i++) { if (location+je->small_write.len > done[i].pos && location < done[i].pos+done[i].len) { uint64_t part_end = (location+je->small_write.len < done[i].pos+done[i].len ? location+je->small_write.len : done[i].pos+done[i].len); uint64_t part_begin = (location < done[i].pos ? done[i].pos : location); covered += part_end - part_begin; data_crc32 = crc32c(data_crc32, done[i].buf + part_begin - done[i].pos, part_end - part_begin); } } if (covered < je->small_write.len) { continue_pos = proc_pos+pos; next_free = prev_free; return 2; } } if (data_crc32 != je->small_write.crc32_data) { // journal entry is corrupt, stop here // interesting thing is that we must clear the corrupt entry if we're not readonly, // because we don't write next entries in the same journal block printf("Journal entry data is corrupt (data crc32 %x != %x)\n", data_crc32, je->small_write.crc32_data); memset(buf + proc_pos - done_pos + pos, 0, bs->journal.block_size - pos); bs->journal.next_free = prev_free; init_write_buf = buf + proc_pos - done_pos; init_write_sector = proc_pos; return 0; } auto clean_it = bs->clean_db.find(je->small_write.oid); if (clean_it == bs->clean_db.end() || clean_it->second.version < je->small_write.version) { obj_ver_id ov = { .oid = je->small_write.oid, .version = je->small_write.version, }; void *bmp = (void*)je + sizeof(journal_entry_small_write); if (bs->clean_entry_bitmap_size <= sizeof(void*)) { memcpy(&bmp, bmp, bs->clean_entry_bitmap_size); } else if (!bs->journal.inmemory) { // FIXME Using large blockstore objects and not keeping journal in memory // will result in a lot of small allocations for entry bitmaps. This can // only be fixed by using a patched map with dynamic entry size, but not // the btree_map, because it doesn't keep iterators valid all the time. void *bmp_cp = malloc_or_die(bs->clean_entry_bitmap_size); memcpy(bmp_cp, bmp, bs->clean_entry_bitmap_size); bmp = bmp_cp; } bs->dirty_db.emplace(ov, (dirty_entry){ .state = (BS_ST_SMALL_WRITE | BS_ST_SYNCED), .flags = 0, .location = location, .offset = je->small_write.offset, .len = je->small_write.len, .journal_sector = proc_pos, .bitmap = bmp, }); bs->journal.used_sectors[proc_pos]++; #ifdef BLOCKSTORE_DEBUG printf( "journal offset %08lx is used by %lx:%lx v%lu (%lu refs)\n", proc_pos, ov.oid.inode, ov.oid.stripe, ov.version, bs->journal.used_sectors[proc_pos] ); #endif auto & unstab = bs->unstable_writes[ov.oid]; unstab = unstab < ov.version ? ov.version : unstab; if (je->type == JE_SMALL_WRITE_INSTANT) { bs->mark_stable(ov, true); } } } else if (je->type == JE_BIG_WRITE || je->type == JE_BIG_WRITE_INSTANT) { #ifdef BLOCKSTORE_DEBUG printf( "je_big_write%s oid=%lx:%lx ver=%lu loc=%lu\n", je->type == JE_BIG_WRITE_INSTANT ? "_instant" : "", je->big_write.oid.inode, je->big_write.oid.stripe, je->big_write.version, je->big_write.location >> bs->block_order ); #endif auto dirty_it = bs->dirty_db.upper_bound((obj_ver_id){ .oid = je->big_write.oid, .version = UINT64_MAX, }); if (dirty_it != bs->dirty_db.begin() && bs->dirty_db.size() > 0) { dirty_it--; if (dirty_it->first.oid == je->big_write.oid && dirty_it->first.version >= je->big_write.version && (dirty_it->second.state & BS_ST_TYPE_MASK) == BS_ST_DELETE) { // It is allowed to overwrite a deleted object with a // version number smaller than deletion version number, // because the presence of a BIG_WRITE entry means that // its data and metadata are already flushed. // We don't know if newer versions are flushed, but // the previous delete definitely is. // So we forget previous dirty entries, but retain the clean one. // This feature is required for writes happening shortly // after deletes. erase_dirty_object(dirty_it); } } auto clean_it = bs->clean_db.find(je->big_write.oid); if (clean_it == bs->clean_db.end() || clean_it->second.version < je->big_write.version) { // oid, version, block obj_ver_id ov = { .oid = je->big_write.oid, .version = je->big_write.version, }; void *bmp = (void*)je + sizeof(journal_entry_big_write); if (bs->clean_entry_bitmap_size <= sizeof(void*)) { memcpy(&bmp, bmp, bs->clean_entry_bitmap_size); } else if (!bs->journal.inmemory) { // FIXME Using large blockstore objects and not keeping journal in memory // will result in a lot of small allocations for entry bitmaps. This can // only be fixed by using a patched map with dynamic entry size, but not // the btree_map, because it doesn't keep iterators valid all the time. void *bmp_cp = malloc_or_die(bs->clean_entry_bitmap_size); memcpy(bmp_cp, bmp, bs->clean_entry_bitmap_size); bmp = bmp_cp; } auto dirty_it = bs->dirty_db.emplace(ov, (dirty_entry){ .state = (BS_ST_BIG_WRITE | BS_ST_SYNCED), .flags = 0, .location = je->big_write.location, .offset = je->big_write.offset, .len = je->big_write.len, .journal_sector = proc_pos, .bitmap = bmp, }).first; if (bs->data_alloc->get(je->big_write.location >> bs->block_order)) { // This is probably a big_write that's already flushed and freed, but it may // also indicate a bug. So we remember such entries and recheck them afterwards. // If it's not a bug they won't be present after reading the whole journal. dirty_it->second.location = UINT64_MAX; double_allocs.push_back(ov); } else { #ifdef BLOCKSTORE_DEBUG printf( "Allocate block (journal) %lu: %lx:%lx v%lu\n", je->big_write.location >> bs->block_order, ov.oid.inode, ov.oid.stripe, ov.version ); #endif bs->data_alloc->set(je->big_write.location >> bs->block_order, true); } bs->journal.used_sectors[proc_pos]++; #ifdef BLOCKSTORE_DEBUG printf( "journal offset %08lx is used by %lx:%lx v%lu (%lu refs)\n", proc_pos, ov.oid.inode, ov.oid.stripe, ov.version, bs->journal.used_sectors[proc_pos] ); #endif auto & unstab = bs->unstable_writes[ov.oid]; unstab = unstab < ov.version ? ov.version : unstab; if (je->type == JE_BIG_WRITE_INSTANT) { bs->mark_stable(ov, true); } } } else if (je->type == JE_STABLE) { #ifdef BLOCKSTORE_DEBUG printf("je_stable oid=%lx:%lx ver=%lu\n", je->stable.oid.inode, je->stable.oid.stripe, je->stable.version); #endif // oid, version obj_ver_id ov = { .oid = je->stable.oid, .version = je->stable.version, }; bs->mark_stable(ov, true); } else if (je->type == JE_ROLLBACK) { #ifdef BLOCKSTORE_DEBUG printf("je_rollback oid=%lx:%lx ver=%lu\n", je->rollback.oid.inode, je->rollback.oid.stripe, je->rollback.version); #endif // rollback dirty writes of up to obj_ver_id ov = { .oid = je->rollback.oid, .version = je->rollback.version, }; bs->mark_rolled_back(ov); } else if (je->type == JE_DELETE) { #ifdef BLOCKSTORE_DEBUG printf("je_delete oid=%lx:%lx ver=%lu\n", je->del.oid.inode, je->del.oid.stripe, je->del.version); #endif bool dirty_exists = false; auto dirty_it = bs->dirty_db.upper_bound((obj_ver_id){ .oid = je->del.oid, .version = UINT64_MAX, }); if (dirty_it != bs->dirty_db.begin()) { dirty_it--; dirty_exists = dirty_it->first.oid == je->del.oid; } auto clean_it = bs->clean_db.find(je->del.oid); bool clean_exists = (clean_it != bs->clean_db.end() && clean_it->second.version < je->del.version); if (!clean_exists && dirty_exists) { // Clean entry doesn't exist. This means that the delete is already flushed. // So we must not flush this object anymore. erase_dirty_object(dirty_it); } else if (clean_exists || dirty_exists) { // oid, version obj_ver_id ov = { .oid = je->del.oid, .version = je->del.version, }; bs->dirty_db.emplace(ov, (dirty_entry){ .state = (BS_ST_DELETE | BS_ST_SYNCED), .flags = 0, .location = 0, .offset = 0, .len = 0, .journal_sector = proc_pos, }); bs->journal.used_sectors[proc_pos]++; // Deletions are treated as immediately stable, because // "2-phase commit" (write->stabilize) isn't sufficient for them anyway bs->mark_stable(ov, true); } // Ignore delete if neither preceding dirty entries nor the clean one are present } started = true; pos += je->size; crc32_last = je->crc32; entries_loaded++; } } bs->journal.next_free = next_free; return 1; } void blockstore_init_journal::erase_dirty_object(blockstore_dirty_db_t::iterator dirty_it) { auto oid = dirty_it->first.oid; auto dirty_end = dirty_it; dirty_end++; while (1) { if (dirty_it == bs->dirty_db.begin()) { break; } dirty_it--; if (dirty_it->first.oid != oid) { dirty_it++; break; } } auto clean_it = bs->clean_db.find(oid); uint64_t clean_loc = clean_it != bs->clean_db.end() ? clean_it->second.location : UINT64_MAX; bs->erase_dirty(dirty_it, dirty_end, clean_loc); // Remove it from the flusher's queue, too // Otherwise it may end up referring to a small unstable write after reading the rest of the journal bs->flusher->remove_flush(oid); }