@ -5,11 +5,17 @@
# include "table/block_based/block_based_table_reader.h"
# include <memory>
# include <string>
# include "cache/cache_reservation_manager.h"
# include "db/db_test_util.h"
# include "db/table_properties_collector.h"
# include "file/file_util.h"
# include "options/options_helper.h"
# include "port/port.h"
# include "port/stack_trace.h"
# include "rocksdb/compression_type.h"
# include "rocksdb/db.h"
# include "rocksdb/file_system.h"
# include "table/block_based/block_based_table_builder.h"
@ -22,33 +28,53 @@
namespace ROCKSDB_NAMESPACE {
class BlockBasedTableReaderTest
: public testing : : Test ,
public testing : : WithParamInterface < std : : tuple <
CompressionType , bool , BlockBasedTableOptions : : IndexType , bool > > {
class BlockBasedTableReaderBaseTest : public testing : : Test {
protected :
CompressionType compression_type_ ;
bool use_direct_reads_ ;
// Prepare key-value pairs to occupy multiple blocks.
// Each value is 256B, every 16 pairs constitute 1 block.
// If mixed_with_human_readable_string_value == true,
// then adjacent blocks contain values with different compression
// complexity: human readable strings are easier to compress than random
// strings.
static std : : map < std : : string , std : : string > GenerateKVMap (
int num_block = 100 ,
bool mixed_with_human_readable_string_value = false ) {
std : : map < std : : string , std : : string > kv ;
void SetUp ( ) override {
BlockBasedTableOptions : : IndexType index_type ;
bool no_block_cache ;
std : : tie ( compression_type_ , use_direct_reads_ , index_type , no_block_cache ) =
GetParam ( ) ;
Random rnd ( 101 ) ;
uint32_t key = 0 ;
for ( int block = 0 ; block < num_block ; block + + ) {
for ( int i = 0 ; i < 16 ; i + + ) {
char k [ 9 ] = { 0 } ;
// Internal key is constructed directly from this key,
// and internal key size is required to be >= 8 bytes,
// so use %08u as the format string.
sprintf ( k , " %08u " , key ) ;
std : : string v ;
if ( mixed_with_human_readable_string_value ) {
v = ( block % 2 ) ? rnd . HumanReadableString ( 256 )
: rnd . RandomString ( 256 ) ;
} else {
v = rnd . RandomString ( 256 ) ;
}
kv [ std : : string ( k ) ] = v ;
key + + ;
}
}
return kv ;
}
void SetUp ( ) override {
SetupSyncPointsToMockDirectIO ( ) ;
test_dir_ = test : : PerThreadDBPath ( " block_based_table_reader_test " ) ;
env_ = Env : : Default ( ) ;
fs_ = FileSystem : : Default ( ) ;
ASSERT_OK ( fs_ - > CreateDir ( test_dir_ , IOOptions ( ) , nullptr ) ) ;
BlockBasedTableOptions opts ;
opts . index_type = index_type ;
opts . no_block_cache = no_block_cache ;
table_factory_ . reset (
static_cast < BlockBasedTableFactory * > ( NewBlockBasedTableFactory ( opts ) ) ) ;
ConfigureTableFactory ( ) ;
}
virtual void ConfigureTableFactory ( ) = 0 ;
void TearDown ( ) override { EXPECT_OK ( DestroyDir ( env_ , test_dir_ ) ) ; }
// Creates a table with the specificied key value pairs (kv).
@ -59,18 +85,18 @@ class BlockBasedTableReaderTest
NewFileWriter ( table_name , & writer ) ;
// Create table builder.
Options options ;
ImmutableOptions ioptions ( options ) ;
InternalKeyComparator comparator ( options . comparator ) ;
ImmutableOptions ioptions ( options_ ) ;
InternalKeyComparator comparator ( options_ . comparator ) ;
ColumnFamilyOptions cf_options ;
MutableCFOptions moptions ( cf_options ) ;
IntTblPropCollectorFactories factories ;
std : : unique_ptr < TableBuilder > table_builder ( table_factory_ - > NewTableBuilder (
TableBuilderOptions ( ioptions , moptions , comparator , & factories ,
compression_type , CompressionOptions ( ) ,
0 /* column_family_id */ , kDefaultColumnFamilyName ,
- 1 /* level */ ) ,
writer . get ( ) ) ) ;
std : : unique_ptr < TableBuilder > table_builder (
options_ . table_factory - > NewTableBuilder (
TableBuilderOptions ( ioptions , moptions , comparator , & factories ,
compression_type , CompressionOptions ( ) ,
0 /* column_family_id */ ,
kDefaultColumnFamilyName , - 1 /* level */ ) ,
writer . get ( ) ) ) ;
// Build table.
for ( auto it = kv . begin ( ) ; it ! = kv . end ( ) ; it + + ) {
@ -85,35 +111,41 @@ class BlockBasedTableReaderTest
const ImmutableOptions & ioptions ,
const InternalKeyComparator & comparator ,
const std : : string & table_name ,
std : : unique_ptr < BlockBasedTable > * table ) {
std : : unique_ptr < BlockBasedTable > * table ,
bool prefetch_index_and_filter_in_cache = true ,
Status * status = nullptr ) {
const MutableCFOptions moptions ( options_ ) ;
TableReaderOptions table_reader_options = TableReaderOptions (
ioptions , moptions . prefix_extractor , EnvOptions ( ) , comparator ) ;
std : : unique_ptr < RandomAccessFileReader > file ;
NewFileReader ( table_name , foptions , & file ) ;
uint64_t file_size = 0 ;
ASSERT_OK ( env_ - > GetFileSize ( Path ( table_name ) , & file_size ) ) ;
std : : unique_ptr < TableReader > table_reader ;
ReadOptions ro ;
const auto * table_options =
table_factory_ - > GetOptions < BlockBasedTableOptions > ( ) ;
ASSERT_NE ( table_options , nullptr ) ;
ASSERT_OK ( BlockBasedTable : : Open ( ro , ioptions , EnvOptions ( ) , * table_options ,
comparator , std : : move ( file ) , file_size ,
& table_reader ) ) ;
std : : unique_ptr < TableReader > general_ table;
Status s = options_ . table_factory - > NewTableReader (
ReadOptions ( ) , table_reader_options , std : : move ( file ) , file_size ,
& general_table , prefetch_index_and_filter_in_cache ) ;
if ( s . ok ( ) ) {
table - > reset ( reinterpret_cast < BlockBasedTable * > ( general_table . release ( ) ) ) ;
}
table - > reset ( reinterpret_cast < BlockBasedTable * > ( table_reader . release ( ) ) ) ;
if ( status ) {
* status = s ;
}
}
std : : string Path ( const std : : string & fname ) { return test_dir_ + " / " + fname ; }
const std : : shared_ptr < FileSystem > & fs ( ) const { return fs_ ; }
private :
std : : string test_dir_ ;
Env * env_ ;
std : : shared_ptr < FileSystem > fs_ ;
std : : unique_ptr < BlockBasedTableFactory > table_factory _;
Options options _;
private :
void WriteToFile ( const std : : string & content , const std : : string & filename ) {
std : : unique_ptr < FSWritableFile > f ;
ASSERT_OK ( fs_ - > NewWritableFile ( Path ( filename ) , FileOptions ( ) , & f , nullptr ) ) ;
@ -146,35 +178,36 @@ class BlockBasedTableReaderTest
}
} ;
class BlockBasedTableReaderTest
: public BlockBasedTableReaderBaseTest ,
public testing : : WithParamInterface < std : : tuple <
CompressionType , bool , BlockBasedTableOptions : : IndexType , bool > > {
protected :
void SetUp ( ) override {
compression_type_ = std : : get < 0 > ( GetParam ( ) ) ;
use_direct_reads_ = std : : get < 1 > ( GetParam ( ) ) ;
BlockBasedTableReaderBaseTest : : SetUp ( ) ;
}
void ConfigureTableFactory ( ) override {
BlockBasedTableOptions opts ;
opts . index_type = std : : get < 2 > ( GetParam ( ) ) ;
opts . no_block_cache = std : : get < 3 > ( GetParam ( ) ) ;
options_ . table_factory . reset (
static_cast < BlockBasedTableFactory * > ( NewBlockBasedTableFactory ( opts ) ) ) ;
}
CompressionType compression_type_ ;
bool use_direct_reads_ ;
} ;
// Tests MultiGet in both direct IO and non-direct IO mode.
// The keys should be in cache after MultiGet.
TEST_P ( BlockBasedTableReaderTest , MultiGet ) {
// Prepare key-value pairs to occupy multiple blocks.
// Each value is 256B, every 16 pairs constitute 1 block.
// Adjacent blocks contain values with different compression complexity:
// human readable strings are easier to compress than random strings.
std : : map < std : : string , std : : string > kv ;
{
Random rnd ( 101 ) ;
uint32_t key = 0 ;
for ( int block = 0 ; block < 100 ; block + + ) {
for ( int i = 0 ; i < 16 ; i + + ) {
char k [ 9 ] = { 0 } ;
// Internal key is constructed directly from this key,
// and internal key size is required to be >= 8 bytes,
// so use %08u as the format string.
sprintf ( k , " %08u " , key ) ;
std : : string v ;
if ( block % 2 ) {
v = rnd . HumanReadableString ( 256 ) ;
} else {
v = rnd . RandomString ( 256 ) ;
}
kv [ std : : string ( k ) ] = v ;
key + + ;
}
}
}
std : : map < std : : string , std : : string > kv =
BlockBasedTableReaderBaseTest : : GenerateKVMap (
100 /* num_block */ ,
true /* mixed_with_human_readable_string_value */ ) ;
// Prepare keys, values, and statuses for MultiGet.
autovector < Slice , MultiGetContext : : MAX_BATCH_SIZE > keys ;
@ -249,6 +282,220 @@ TEST_P(BlockBasedTableReaderTest, MultiGet) {
}
}
class BlockBasedTableReaderResOnlyCache : public CacheWrapper {
public :
explicit BlockBasedTableReaderResOnlyCache ( std : : shared_ptr < Cache > target )
: CacheWrapper ( std : : move ( target ) ) { }
using Cache : : Insert ;
Status Insert ( const Slice & key , void * value , size_t charge ,
void ( * deleter ) ( const Slice & key , void * value ) ,
Handle * * handle = nullptr ,
Priority priority = Priority : : LOW ) override {
if ( deleter = = kNoopDeleterForBlockBasedTableReader ) {
return target_ - > Insert ( key , value , charge , deleter , handle , priority ) ;
} else {
return Status : : OK ( ) ;
}
}
using Cache : : Release ;
bool Release ( Handle * handle , bool force_erase = false ) override {
auto deleter = GetDeleter ( handle ) ;
if ( deleter = = kNoopDeleterForBlockBasedTableReader ) {
return target_ - > Release ( handle , force_erase ) ;
} else {
return true ;
}
}
private :
static const Cache : : DeleterFn kNoopDeleterForBlockBasedTableReader ;
} ;
const Cache : : DeleterFn
BlockBasedTableReaderResOnlyCache : : kNoopDeleterForBlockBasedTableReader =
CacheReservationManagerImpl < CacheEntryRole : : kBlockBasedTableReader > : :
TEST_GetNoopDeleterForRole ( ) ;
class BlockBasedTableReaderCapMemoryTest
: public BlockBasedTableReaderBaseTest ,
public testing : : WithParamInterface <
bool /* reserve_table_builder_memory */ > {
protected :
static std : : size_t CalculateMaxTableReaderNumBeforeCacheFull (
std : : size_t cache_capacity , std : : size_t approx_table_reader_mem ) {
// To make calculation easier for testing
assert ( cache_capacity % CacheReservationManagerImpl <
CacheEntryRole : : kBlockBasedTableReader > : :
GetDummyEntrySize ( ) = =
0 & &
cache_capacity > 2 * CacheReservationManagerImpl <
CacheEntryRole : : kBlockBasedTableReader > : :
GetDummyEntrySize ( ) ) ;
// We need to subtract 1 for max_num_dummy_entry to account for dummy
// entries' overhead, assumed the overhead is no greater than 1 dummy entry
// size
std : : size_t max_num_dummy_entry =
( size_t ) std : : floor ( (
1.0 * cache_capacity /
CacheReservationManagerImpl <
CacheEntryRole : : kBlockBasedTableReader > : : GetDummyEntrySize ( ) ) ) -
1 ;
std : : size_t cache_capacity_rounded_to_dummy_entry_multiples =
max_num_dummy_entry *
CacheReservationManagerImpl <
CacheEntryRole : : kBlockBasedTableReader > : : GetDummyEntrySize ( ) ;
std : : size_t max_table_reader_num = static_cast < std : : size_t > (
std : : floor ( 1.0 * cache_capacity_rounded_to_dummy_entry_multiples /
approx_table_reader_mem ) ) ;
return max_table_reader_num ;
}
void SetUp ( ) override {
// To cache and re-use the same kv map and compression type in the test
// suite for elimiating variance caused by these two factors
kv_ = BlockBasedTableReaderBaseTest : : GenerateKVMap ( ) ;
compression_type_ = CompressionType : : kNoCompression ;
table_reader_res_only_cache_ . reset ( new BlockBasedTableReaderResOnlyCache (
NewLRUCache ( 6 * CacheReservationManagerImpl <
CacheEntryRole : : kBlockBasedTableReader > : :
GetDummyEntrySize ( ) ,
0 /* num_shard_bits */ , true /* strict_capacity_limit */ ) ) ) ;
// To ApproximateTableReaderMem() without encountering any potential errors
// caused by BlocBasedTableReader::reserve_table_reader_memory == true, we
// first turn off the feature to test
reserve_table_reader_memory_ = false ;
BlockBasedTableReaderBaseTest : : SetUp ( ) ;
approx_table_reader_mem_ = ApproximateTableReaderMem ( ) ;
// Now we condtionally turn on the feature to test
reserve_table_reader_memory_ = GetParam ( ) ;
ConfigureTableFactory ( ) ;
}
void ConfigureTableFactory ( ) override {
BlockBasedTableOptions table_options ;
table_options . reserve_table_reader_memory = reserve_table_reader_memory_ ;
table_options . block_cache = table_reader_res_only_cache_ ;
table_options . cache_index_and_filter_blocks = false ;
table_options . filter_policy . reset ( NewBloomFilterPolicy ( 10 , false ) ) ;
table_options . partition_filters = true ;
table_options . index_type = BlockBasedTableOptions : : kTwoLevelIndexSearch ;
options_ . table_factory . reset ( NewBlockBasedTableFactory ( table_options ) ) ;
}
bool reserve_table_reader_memory_ ;
std : : shared_ptr < BlockBasedTableReaderResOnlyCache >
table_reader_res_only_cache_ ;
std : : size_t approx_table_reader_mem_ ;
std : : map < std : : string , std : : string > kv_ ;
CompressionType compression_type_ ;
private :
std : : size_t ApproximateTableReaderMem ( ) {
std : : size_t approx_table_reader_mem = 0 ;
std : : string table_name = " table_for_approx_table_reader_mem " ;
CreateTable ( table_name , compression_type_ , kv_ ) ;
std : : unique_ptr < BlockBasedTable > table ;
Status s ;
NewBlockBasedTableReader (
FileOptions ( ) , ImmutableOptions ( options_ ) ,
InternalKeyComparator ( options_ . comparator ) , table_name , & table ,
false /* prefetch_index_and_filter_in_cache */ , & s ) ;
assert ( s . ok ( ) ) ;
approx_table_reader_mem = table - > ApproximateMemoryUsage ( ) ;
assert ( approx_table_reader_mem > 0 ) ;
return approx_table_reader_mem ;
}
} ;
INSTANTIATE_TEST_CASE_P ( CapMemoryUsageUnderCacheCapacity ,
BlockBasedTableReaderCapMemoryTest , : : testing : : Bool ( ) ) ;
TEST_P ( BlockBasedTableReaderCapMemoryTest , CapMemoryUsageUnderCacheCapacity ) {
const std : : size_t max_table_reader_num = BlockBasedTableReaderCapMemoryTest : :
CalculateMaxTableReaderNumBeforeCacheFull (
table_reader_res_only_cache_ - > GetCapacity ( ) ,
approx_table_reader_mem_ ) ;
Status s = Status : : OK ( ) ;
std : : size_t opened_table_reader_num = 0 ;
std : : string table_name ;
std : : vector < std : : unique_ptr < BlockBasedTable > > tables ;
// Keep creating BlockBasedTableReader till hiting the memory limit based on
// cache capacity and creation fails or reaching a big number of table readers
while ( s . ok ( ) & & opened_table_reader_num < 2 * max_table_reader_num ) {
table_name = " table_ " + std : : to_string ( opened_table_reader_num ) ;
CreateTable ( table_name , compression_type_ , kv_ ) ;
tables . push_back ( std : : unique_ptr < BlockBasedTable > ( ) ) ;
NewBlockBasedTableReader (
FileOptions ( ) , ImmutableOptions ( options_ ) ,
InternalKeyComparator ( options_ . comparator ) , table_name , & tables . back ( ) ,
false /* prefetch_index_and_filter_in_cache */ , & s ) ;
if ( s . ok ( ) ) {
+ + opened_table_reader_num ;
}
}
if ( reserve_table_reader_memory_ ) {
EXPECT_TRUE ( s . IsMemoryLimit ( ) & &
opened_table_reader_num < 2 * max_table_reader_num )
< < " s: " < < s . ToString ( ) < < " opened_table_reader_num: "
< < std : : to_string ( opened_table_reader_num ) ;
EXPECT_TRUE ( s . ToString ( ) . find ( " memory limit based on cache capacity " ) ! =
std : : string : : npos ) ;
// Acceptable estimtation errors coming from
// 1. overstimate max_table_reader_num due to # dummy entries is high and
// results in metadata charge overhead greater than 1 dummy entry size
// (violating our assumption in calculating max_table_reader_nums)
// 2. overestimate/underestimate max_table_reader_num due to the gap between
// ApproximateTableReaderMem() and actual table reader mem
EXPECT_GE ( opened_table_reader_num , max_table_reader_num * 0.99 ) ;
EXPECT_LE ( opened_table_reader_num , max_table_reader_num * 1.01 ) ;
std : : size_t updated_max_table_reader_num =
BlockBasedTableReaderCapMemoryTest : :
CalculateMaxTableReaderNumBeforeCacheFull (
table_reader_res_only_cache_ - > GetCapacity ( ) / 2 ,
approx_table_reader_mem_ ) ;
// Keep deleting BlockBasedTableReader to lower down memory usage from the
// memory limit to make the next creation succeeds
while ( opened_table_reader_num > = updated_max_table_reader_num ) {
tables . pop_back ( ) ;
- - opened_table_reader_num ;
}
table_name = " table_for_successful_table_reader_open " ;
CreateTable ( table_name , compression_type_ , kv_ ) ;
tables . push_back ( std : : unique_ptr < BlockBasedTable > ( ) ) ;
NewBlockBasedTableReader (
FileOptions ( ) , ImmutableOptions ( options_ ) ,
InternalKeyComparator ( options_ . comparator ) , table_name , & tables . back ( ) ,
false /* prefetch_index_and_filter_in_cache */ , & s ) ;
EXPECT_TRUE ( s . ok ( ) ) < < s . ToString ( ) ;
tables . clear ( ) ;
EXPECT_EQ ( table_reader_res_only_cache_ - > GetPinnedUsage ( ) , 0 ) ;
} else {
EXPECT_TRUE ( s . ok ( ) & & opened_table_reader_num = = 2 * max_table_reader_num )
< < " s: " < < s . ToString ( ) < < " opened_table_reader_num: "
< < std : : to_string ( opened_table_reader_num ) ;
EXPECT_EQ ( table_reader_res_only_cache_ - > GetPinnedUsage ( ) , 0 ) ;
}
}
class BlockBasedTableReaderTestVerifyChecksum
: public BlockBasedTableReaderTest {
public :
@ -256,27 +503,8 @@ class BlockBasedTableReaderTestVerifyChecksum
} ;
TEST_P ( BlockBasedTableReaderTestVerifyChecksum , ChecksumMismatch ) {
// Prepare key-value pairs to occupy multiple blocks.
// Each value is 256B, every 16 pairs constitute 1 block.
// Adjacent blocks contain values with different compression complexity:
// human readable strings are easier to compress than random strings.
Random rnd ( 101 ) ;
std : : map < std : : string , std : : string > kv ;
{
uint32_t key = 0 ;
for ( int block = 0 ; block < 800 ; block + + ) {
for ( int i = 0 ; i < 16 ; i + + ) {
char k [ 9 ] = { 0 } ;
// Internal key is constructed directly from this key,
// and internal key size is required to be >= 8 bytes,
// so use %08u as the format string.
sprintf ( k , " %08u " , key ) ;
std : : string v = rnd . RandomString ( 256 ) ;
kv [ std : : string ( k ) ] = v ;
key + + ;
}
}
}
std : : map < std : : string , std : : string > kv =
BlockBasedTableReaderBaseTest : : GenerateKVMap ( 800 /* num_block */ ) ;
std : : string table_name =
" BlockBasedTableReaderTest " + CompressionTypeToString ( compression_type_ ) ;
Hui Xiao
2 years ago
committed by