BlueStore原始碼分析之FreelistManager

virtual void allocate(
	uint64_t offset, uint64_t length,
	KeyValueDB::Transaction txn) = 0;
virtual void release(
    uint64_t offset, uint64_t length,
    KeyValueDB::Transaction txn) = 0;

class BitmapFreelistManager : public FreelistManager {
	// rocksdb key字首：meta_prefix為 B，bitmap_prefix為 b
	std::string meta_prefix, bitmap_prefix;
	
	// key-value DB的指標，封裝了rocksdb的操作
	KeyValueDB *kvdb;
	
	// rocksdb的merge操作：按位異或(xor)
	ceph::shared_ptr<KeyValueDB::MergeOperator> merge_op;
	
	// enumerate操作時加鎖
	std::mutex lock;
	// 裝置總大小
	uint64_t size;
	
	// 裝置總block數
	uint64_t blocks;
	// block大小：bdev_block_size，預設min_alloc_size
	uint64_t bytes_per_block;
	
	// 每個key包含多少個block， 預設128
	uint64_t blocks_per_key;
	
	// 每個key對應空間大小
	uint64_t bytes_per_key;
	// block掩碼
	uint64_t block_mask;
	
	// key掩碼
	uint64_t key_mask;
	bufferlist all_set_bl;
	// 遍歷rocksdb key相關的成員
	KeyValueDB::Iterator enumerate_p;
	uint64_t enumerate_offset;
	bufferlist enumerate_bl;
	int enumerate_bl_pos; 
};

int BlueStore::mkfs()
{
	......
	r = _open_fm(true);
	......
}
int BlueStore::_open_fm(bool create)
{
	......
	fm = FreelistManager::create(cct, freelist_type, db, PREFIX_ALLOC);
	// 第一次初始化，需要固化meta引數
	if (create) {
		fm->create(bdev->get_size(), min_alloc_size, t);
	}
	......
	int r = fm->init(bdev->get_size());
}
// create固化一些meta引數到kvdb中，init的時候，從kvdb讀取這些引數
int BitmapFreelistManager::create(uint64_t new_size, uint64_t min_alloc_size,
		KeyValueDB::Transaction txn)
{
	txn->set(meta_prefix, "bytes_per_block", bl); // min_alloc_size
	txn->set(meta_prefix, "blocks_per_key", bl); // 128
	txn->set(meta_prefix, "blocks", bl);
	txn->set(meta_prefix, "size", bl);
}
// create/init 均會呼叫下面這個函式，初始化block/key的掩碼
void BitmapFreelistManager::_init_misc()
{
	// 128 >> 3 = 16，每個block用1個bit表示。
	// 即一個key的value對應128個block，需要16位元組。
	bufferptr z(blocks_per_key >> 3); 
	memset(z.c_str(), 0xff, z.length());
	all_set_bl.clear();
	all_set_bl.append(z);
	
	// 0x FFFF FFFF FFFF F000
	block_mask = ~(bytes_per_block - 1); 
	bytes_per_key = bytes_per_block * blocks_per_key;
	
	// 0xFFFF FFFF FFF8 0000
	key_mask = ~(bytes_per_key - 1);
}

// 繼承rocksdb merge介面：異或操作(xor)
struct XorMergeOperator : public KeyValueDB::MergeOperator {
	 // old_value不存在，那麼new_value直接賦值為rdata。
    void merge_nonexistent(const char *rdata, size_t rlen,
                           std::string *new_value) override {
        *new_value = std::string(rdata, rlen);
    }
    
    // old_value存在，則與rdata逐位異或xor。
    void merge(const char *ldata, size_t llen, const char *rdata, size_t rlen,
               std::string *new_value) override {
        assert(llen == rlen);
        *new_value = std::string(ldata, llen);
        for (size_t i = 0; i < rlen; ++i) {
            (*new_value)[i] ^= rdata[i];
        }
    }
    // We use each operator name and each prefix to construct the
    // overall RocksDB operator name for consistency check at open time.
    string name() const override { return "bitwise_xor"; }
};

bool Merge(const rocksdb::Slice& key,
	     const rocksdb::Slice* existing_value,
	     const rocksdb::Slice& value,
	     std::string* new_value,
	     rocksdb::Logger* logger) const override 
{
	// for default column family
	// extract prefix from key and compare against each registered merge op;
	// even though merge operator for explicit CF is included in merge_ops,
	// it won't be picked up, since it won't match.
	for (auto& p : store.merge_ops) {
		if (p.first.compare(0, p.first.length(),
					  key.data(), p.first.length()) == 0 &&
			  key.data()[p.first.length()] == 0) {
			// 如果old_value存在，那麼直接merge，否則直接替換。
			if (existing_value) {
				p.second->merge(existing_value->data(), existing_value->size(),
							  value.data(), value.size(),
							  new_value);
			} else {
				p.second->merge_nonexistent(value.data(), value.size(), new_value);
			}
			break;
		}
	}
	return true;
}

void BitmapFreelistManager::allocate(uint64_t offset, uint64_t length, KeyValueDB::Transaction txn)
{
	_xor(offset, length, txn);
}
void BitmapFreelistManager::release(uint64_t offset, uint64_t length, KeyValueDB::Transaction txn)
{
	_xor(offset, length, txn);
}
void BitmapFreelistManager::_xor(uint64_t offset, uint64_t length, KeyValueDB::Transaction txn)
{
	// 注意offset和length都是以block邊界對齊
	uint64_t first_key = offset & key_mask;
	uint64_t last_key = (offset + length - 1) & key_mask;
	if (first_key == last_key) { // 最簡單的case，此次操作對應一個段
		bufferptr p(blocks_per_key >> 3); // 16位元組大小的buffer
		p.zero(); // 置為全0
		unsigned s = (offset & ~key_mask) / bytes_per_block; // 段內開始block的編號
		unsigned e = ((offset + length - 1) & ~key_mask) / bytes_per_block; // 段內結束block的編號
		for (unsigned i = s; i <= e; ++i) { // 生成此次操作的掩碼
			p[i >> 3] ^= 1ull << (i & 7); // i>>3定位block對應位的位元組， 1ull<<(i&7)定位bit，然後異或將位設定位1
		}
		string k;
		make_offset_key(first_key, &k); // 將記憶體內容轉換為16進位制的字元
		bufferlist bl;
		bl.append(p);
		bl.hexdump(*_dout, false);
		txn->merge(bitmap_prefix, k, bl); // 和目前的value進行異或操作
	} else { // 對應多個段，分別處理第一個段，中間段，和最後一個段，首尾兩個段和前面情況一樣
		// 第一個段
		{
			// 類似上面情況
			......
			// 增加key，定位下一個段
			first_key += bytes_per_key;
		}
		// 中間段，此時掩碼就是全1，所以用all_set_bl
		while (first_key < last_key) {
			string k;
			make_offset_key(first_key, &k);
			all_set_bl.hexdump(*_dout, false);
			txn->merge(bitmap_prefix, k, all_set_bl); // 和目前的value進行異或操作
			// 增加key，定位下一個段
			first_key += bytes_per_key;
		}
		// 最後一個段
		{
			// 和前面操作類似
		}
	}
}

void BitmapFreelistManager::release(uint64_t offset, uint64_t length, KeyValueDB::Transaction txn)
{
	_xor(offset, length, txn);
}