| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562 |
- // Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
- // This source code is licensed under both the GPLv2 (found in the
- // COPYING file in the root directory) and Apache 2.0 License
- // (found in the LICENSE.Apache file in the root directory).
- //
- // Copyright (c) 2011 The LevelDB Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file. See the AUTHORS file for names of contributors.
- #include "rocksdb/cache.h"
- #include "rocksdb/options.h"
- #include "rocksdb/utilities/backup_engine.h"
- #ifdef GFLAGS
- #include "db_stress_tool/db_stress_common.h"
- static bool ValidateUint32Range(const char* flagname, uint64_t value) {
- if (value > std::numeric_limits<uint32_t>::max()) {
- fprintf(stderr, "Invalid value for --%s: %lu, overflow\n", flagname,
- (unsigned long)value);
- return false;
- }
- return true;
- }
- DEFINE_uint64(seed, 2341234,
- "Seed for PRNG. When --nooverwritepercent is "
- "nonzero and --expected_values_dir is nonempty, this value "
- "must be fixed across invocations.");
- static const bool FLAGS_seed_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_seed, &ValidateUint32Range);
- DEFINE_bool(read_only, false, "True if open DB in read-only mode during tests");
- DEFINE_int64(max_key, 1 * KB * KB,
- "Max number of key/values to place in database");
- DEFINE_int32(max_key_len, 3, "Maximum length of a key in 8-byte units");
- DEFINE_uint64(max_sequential_skip_in_iterations,
- ROCKSDB_NAMESPACE::Options().max_sequential_skip_in_iterations,
- "Iterator will reseek after scanning this number of keys with"
- "the same user key during Next/Prev().");
- DEFINE_string(key_len_percent_dist, "",
- "Percentages of keys of various lengths. For example, 1,30,69 "
- "means 1% of keys are 8 bytes, 30% are 16 bytes, and 69% are "
- "24 bytes. If not specified, it will be evenly distributed");
- DEFINE_int32(key_window_scale_factor, 10,
- "This value will be multiplied by 100 to come up with a window "
- "size for varying the key length");
- DEFINE_int32(column_families, 10, "Number of column families");
- DEFINE_double(
- hot_key_alpha, 0,
- "Use Zipfian distribution to generate the key "
- "distribution. If it is not specified, write path will use random "
- "distribution to generate the keys. The parameter is [0, double_max]). "
- "However, the larger alpha is, the more shewed will be. If alpha is "
- "larger than 2, it is likely that only 1 key will be accessed. The "
- "Recommended value is [0.8-1.5]. The distribution is also related to "
- "max_key and total iterations of generating the hot key. ");
- DEFINE_string(
- options_file, "",
- "The path to a RocksDB options file. If specified, then db_stress will "
- "run with the RocksDB options in the default column family of the "
- "specified options file. Note that, when an options file is provided, "
- "db_stress will ignore the flag values for all options that may be passed "
- "via options file.");
- DEFINE_int64(
- active_width, 0,
- "Number of keys in active span of the key-range at any given time. The "
- "span begins with its left endpoint at key 0, gradually moves rightwards, "
- "and ends with its right endpoint at max_key. If set to 0, active_width "
- "will be sanitized to be equal to max_key.");
- // TODO(noetzli) Add support for single deletes
- DEFINE_bool(test_batches_snapshots, false,
- "If set, the test uses MultiGet(), MultiPut() and MultiDelete()"
- " which read/write/delete multiple keys in a batch. In this mode,"
- " we do not verify db content by comparing the content with the "
- "pre-allocated array. Instead, we do partial verification inside"
- " MultiGet() by checking various values in a batch. Benefit of"
- " this mode:\n"
- "\t(a) No need to acquire mutexes during writes (less cache "
- "flushes in multi-core leading to speed up)\n"
- "\t(b) No long validation at the end (more speed up)\n"
- "\t(c) Test snapshot and atomicity of batch writes");
- DEFINE_bool(atomic_flush, false,
- "If set, enables atomic flush in the options.\n");
- DEFINE_int32(
- manual_wal_flush_one_in, 0,
- "If non-zero, then `FlushWAL(bool sync)`, where `bool sync` is randomly "
- "decided, will be explictly called in db stress once for every N ops "
- "on average. Setting `manual_wal_flush_one_in` to be greater than 0 "
- "implies `Options::manual_wal_flush = true` is set.");
- DEFINE_int32(lock_wal_one_in, 1000000,
- "If non-zero, then `LockWAL()` + `UnlockWAL()` will be called in "
- "db_stress once for every N ops on average.");
- DEFINE_bool(test_cf_consistency, false,
- "If set, runs the stress test dedicated to verifying writes to "
- "multiple column families are consistent. Setting this implies "
- "`atomic_flush=true` is set true if `disable_wal=false`.\n");
- DEFINE_bool(test_multi_ops_txns, false,
- "If set, runs stress test dedicated to verifying multi-ops "
- "transactions on a simple relational table with primary and "
- "secondary index.");
- DEFINE_int32(threads, 32, "Number of concurrent threads to run.");
- DEFINE_int32(ttl, -1,
- "Opens the db with this ttl value if this is not -1. "
- "Carefully specify a large value such that verifications on "
- "deleted values don't fail");
- DEFINE_int32(value_size_mult, 8,
- "Size of value will be this number times rand_int(1,3) bytes");
- DEFINE_int32(compaction_readahead_size, 0, "Compaction readahead size");
- DEFINE_bool(enable_pipelined_write, false, "Pipeline WAL/memtable writes");
- DEFINE_bool(verify_before_write, false, "Verify before write");
- DEFINE_bool(histogram, false, "Print histogram of operation timings");
- DEFINE_bool(destroy_db_initially, true,
- "Destroys the database dir before start if this is true");
- DEFINE_bool(verbose, false, "Verbose");
- DEFINE_bool(progress_reports, true,
- "If true, db_stress will report number of finished operations");
- DEFINE_uint64(db_write_buffer_size,
- ROCKSDB_NAMESPACE::Options().db_write_buffer_size,
- "Number of bytes to buffer in all memtables before compacting");
- DEFINE_bool(use_write_buffer_manager, false,
- "Charge WriteBufferManager memory to the block cache");
- DEFINE_int32(
- write_buffer_size,
- static_cast<int32_t>(ROCKSDB_NAMESPACE::Options().write_buffer_size),
- "Number of bytes to buffer in memtable before compacting");
- DEFINE_int32(max_write_buffer_number,
- ROCKSDB_NAMESPACE::Options().max_write_buffer_number,
- "The number of in-memory memtables. "
- "Each memtable is of size FLAGS_write_buffer_size.");
- DEFINE_int32(min_write_buffer_number_to_merge,
- ROCKSDB_NAMESPACE::Options().min_write_buffer_number_to_merge,
- "The minimum number of write buffers that will be merged together "
- "before writing to storage. This is cheap because it is an "
- "in-memory merge. If this feature is not enabled, then all these "
- "write buffers are flushed to L0 as separate files and this "
- "increases read amplification because a get request has to check "
- "in all of these files. Also, an in-memory merge may result in "
- "writing less data to storage if there are duplicate records in"
- " each of these individual write buffers.");
- DEFINE_int64(max_write_buffer_size_to_maintain,
- ROCKSDB_NAMESPACE::Options().max_write_buffer_size_to_maintain,
- "The total maximum size of write buffers to maintain in memory "
- "including copies of buffers that have already been flushed. "
- "Unlike max_write_buffer_number, this parameter does not affect "
- "flushing. This controls the minimum amount of write history "
- "that will be available in memory for conflict checking when "
- "Transactions are used. If this value is too low, some "
- "transactions may fail at commit time due to not being able to "
- "determine whether there were any write conflicts. Setting this "
- "value to 0 will cause write buffers to be freed immediately "
- "after they are flushed. If this value is set to -1, "
- "'max_write_buffer_number' will be used.");
- DEFINE_double(memtable_prefix_bloom_size_ratio,
- ROCKSDB_NAMESPACE::Options().memtable_prefix_bloom_size_ratio,
- "creates prefix blooms for memtables, each with size "
- "`write_buffer_size * memtable_prefix_bloom_size_ratio`.");
- DEFINE_bool(memtable_whole_key_filtering,
- ROCKSDB_NAMESPACE::Options().memtable_whole_key_filtering,
- "Enable whole key filtering in memtables.");
- DEFINE_int32(open_files, ROCKSDB_NAMESPACE::Options().max_open_files,
- "Maximum number of files to keep open at the same time "
- "(use default if == 0)");
- DEFINE_uint64(compressed_secondary_cache_size, 0,
- "Number of bytes to use as a cache of compressed data."
- " 0 means use default settings.");
- DEFINE_int32(compressed_secondary_cache_numshardbits, -1,
- "Number of shards for the compressed secondary cache is 2 ** "
- "compressed_secondary_cache_numshardbits. "
- "Negative value means default settings. This is applied only "
- "if compressed_secondary_cache_size is greater than 0.");
- DEFINE_double(compressed_secondary_cache_ratio, 0.0,
- "Fraction of block cache memory budget to use for compressed "
- "secondary cache");
- DEFINE_int32(secondary_cache_update_interval, 30 * 1000 * 1000,
- "Interval between modification of secondary cache parameters, in "
- "microseconds");
- DEFINE_int32(compaction_style, ROCKSDB_NAMESPACE::Options().compaction_style,
- "");
- DEFINE_int32(compaction_pri, ROCKSDB_NAMESPACE::Options().compaction_pri,
- "Which file from a level should be picked to merge to the next "
- "level in level-based compaction");
- DEFINE_int32(num_levels, ROCKSDB_NAMESPACE::Options().num_levels,
- "Number of levels in the DB");
- DEFINE_int32(level0_file_num_compaction_trigger,
- ROCKSDB_NAMESPACE::Options().level0_file_num_compaction_trigger,
- "Level0 compaction start trigger");
- DEFINE_int32(level0_slowdown_writes_trigger,
- ROCKSDB_NAMESPACE::Options().level0_slowdown_writes_trigger,
- "Number of files in level-0 that will slow down writes");
- DEFINE_int32(level0_stop_writes_trigger,
- ROCKSDB_NAMESPACE::Options().level0_stop_writes_trigger,
- "Number of files in level-0 that will trigger put stop.");
- DEFINE_int32(block_size,
- static_cast<int32_t>(
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().block_size),
- "Number of bytes in a block.");
- DEFINE_int32(format_version,
- static_cast<int32_t>(
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().format_version),
- "Format version of SST files.");
- DEFINE_int32(
- index_block_restart_interval,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().index_block_restart_interval,
- "Number of keys between restart points "
- "for delta encoding of keys in index block.");
- DEFINE_bool(disable_auto_compactions,
- ROCKSDB_NAMESPACE::Options().disable_auto_compactions,
- "If true, RocksDB internally will not trigger compactions.");
- DEFINE_int32(max_background_compactions,
- ROCKSDB_NAMESPACE::Options().max_background_compactions,
- "The maximum number of concurrent background compactions "
- "that can occur in parallel.");
- DEFINE_int32(num_bottom_pri_threads, 0,
- "The number of threads in the bottom-priority thread pool (used "
- "by universal compaction only).");
- DEFINE_int32(compaction_thread_pool_adjust_interval, 0,
- "The interval (in milliseconds) to adjust compaction thread pool "
- "size. Don't change it periodically if the value is 0.");
- DEFINE_int32(compaction_thread_pool_variations, 2,
- "Range of background thread pool size variations when adjusted "
- "periodically.");
- DEFINE_int32(max_background_flushes,
- ROCKSDB_NAMESPACE::Options().max_background_flushes,
- "The maximum number of concurrent background flushes "
- "that can occur in parallel.");
- DEFINE_int32(universal_size_ratio, 0,
- "The ratio of file sizes that trigger"
- " compaction in universal style");
- DEFINE_int32(universal_min_merge_width, 0,
- "The minimum number of files to "
- "compact in universal style compaction");
- DEFINE_int32(universal_max_merge_width, 0,
- "The max number of files to compact"
- " in universal style compaction");
- DEFINE_int32(universal_max_size_amplification_percent, 0,
- "The max size amplification for universal style compaction");
- DEFINE_int32(universal_max_read_amp, -1,
- "The limit on the number of sorted runs");
- DEFINE_int32(clear_column_family_one_in, 1000000,
- "With a chance of 1/N, delete a column family and then recreate "
- "it again. If N == 0, never drop/create column families. "
- "When test_batches_snapshots is true, this flag has no effect");
- DEFINE_int32(
- get_live_files_apis_one_in, 1000000,
- "With a chance of 1/N, call GetLiveFiles(), GetLiveFilesMetaData() and "
- "GetLiveFilesChecksumInfo() to verify if it returns "
- "OK or violate any internal assertion. If N == 0, do not call the "
- "interface.");
- DEFINE_int32(
- get_all_column_family_metadata_one_in, 1000000,
- "With a chance of 1/N, call GetAllColumnFamilyMetaData to verify if it "
- "violates any internal assertion. If N == 0, do not call the interface.");
- DEFINE_int32(
- get_sorted_wal_files_one_in, 1000000,
- "With a chance of 1/N, call GetSortedWalFiles to verify if it returns "
- "correctly. (Note that this API may legitimately return an error.) If N == "
- "0, do not call the interface.");
- DEFINE_int32(
- get_current_wal_file_one_in, 1000000,
- "With a chance of 1/N, call GetCurrentWalFile to verify if it returns "
- "correctly. (Note that this API may legitimately return an error.) If N == "
- "0, do not call the interface.");
- DEFINE_int32(set_options_one_in, 0,
- "With a chance of 1/N, change some random options");
- DEFINE_int32(set_in_place_one_in, 0,
- "With a chance of 1/N, toggle in place support option");
- DEFINE_int64(cache_size, 2LL * KB * KB * KB,
- "Number of bytes to use as a cache of uncompressed data.");
- DEFINE_int32(cache_numshardbits, 6,
- "Number of shards for the block cache"
- " is 2 ** cache_numshardbits. Negative means use default settings."
- " This is applied only if FLAGS_cache_size is greater than 0.");
- DEFINE_bool(cache_index_and_filter_blocks, false,
- "True if indexes/filters should be cached in block cache.");
- DEFINE_bool(charge_compression_dictionary_building_buffer, false,
- "Setting for "
- "CacheEntryRoleOptions::charged of "
- "CacheEntryRole::kCompressionDictionaryBuildingBuffer");
- DEFINE_bool(charge_filter_construction, false,
- "Setting for "
- "CacheEntryRoleOptions::charged of "
- "CacheEntryRole::kFilterConstruction");
- DEFINE_bool(charge_table_reader, false,
- "Setting for "
- "CacheEntryRoleOptions::charged of "
- "CacheEntryRole::kBlockBasedTableReader");
- DEFINE_bool(charge_file_metadata, false,
- "Setting for "
- "CacheEntryRoleOptions::charged of "
- "kFileMetadata");
- DEFINE_bool(charge_blob_cache, false,
- "Setting for "
- "CacheEntryRoleOptions::charged of "
- "kBlobCache");
- DEFINE_bool(
- decouple_partitioned_filters,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().decouple_partitioned_filters,
- "Decouple filter partitioning from index partitioning.");
- DEFINE_int32(
- top_level_index_pinning,
- static_cast<int32_t>(ROCKSDB_NAMESPACE::PinningTier::kFallback),
- "Type of pinning for top-level indexes into metadata partitions (see "
- "`enum PinningTier` in table.h)");
- DEFINE_int32(
- partition_pinning,
- static_cast<int32_t>(ROCKSDB_NAMESPACE::PinningTier::kFallback),
- "Type of pinning for metadata partitions (see `enum PinningTier` in "
- "table.h)");
- DEFINE_int32(
- unpartitioned_pinning,
- static_cast<int32_t>(ROCKSDB_NAMESPACE::PinningTier::kFallback),
- "Type of pinning for unpartitioned metadata blocks (see `enum PinningTier` "
- "in table.h)");
- DEFINE_string(cache_type, "lru_cache", "Type of block cache.");
- DEFINE_uint64(subcompactions, 1,
- "Maximum number of subcompactions to divide L0-L1 compactions "
- "into.");
- DEFINE_uint64(periodic_compaction_seconds, 1000,
- "Files older than this value will be picked up for compaction.");
- DEFINE_string(daily_offpeak_time_utc, "",
- "If set, process periodic compactions during this period only");
- DEFINE_uint64(compaction_ttl, 1000,
- "Files older than TTL will be compacted to the next level.");
- DEFINE_bool(fifo_allow_compaction, false,
- "If true, set `Options::compaction_options_fifo.allow_compaction = "
- "true`. It only take effect when FIFO compaction is used.");
- DEFINE_bool(allow_concurrent_memtable_write, false,
- "Allow multi-writers to update mem tables in parallel.");
- DEFINE_double(experimental_mempurge_threshold, 0.0,
- "Maximum estimated useful payload that triggers a "
- "mempurge process to collect memtable garbage bytes.");
- DEFINE_bool(enable_write_thread_adaptive_yield,
- ROCKSDB_NAMESPACE::Options().enable_write_thread_adaptive_yield,
- "Use a yielding spin loop for brief writer thread waits.");
- // Options for StackableDB-based BlobDB
- DEFINE_bool(use_blob_db, false, "[Stacked BlobDB] Use BlobDB.");
- DEFINE_uint64(
- blob_db_min_blob_size,
- ROCKSDB_NAMESPACE::blob_db::BlobDBOptions().min_blob_size,
- "[Stacked BlobDB] Smallest blob to store in a file. Blobs "
- "smaller than this will be inlined with the key in the LSM tree.");
- DEFINE_uint64(
- blob_db_bytes_per_sync,
- ROCKSDB_NAMESPACE::blob_db::BlobDBOptions().bytes_per_sync,
- "[Stacked BlobDB] Sync blob files once per every N bytes written.");
- DEFINE_uint64(blob_db_file_size,
- ROCKSDB_NAMESPACE::blob_db::BlobDBOptions().blob_file_size,
- "[Stacked BlobDB] Target size of each blob file.");
- DEFINE_bool(
- blob_db_enable_gc,
- ROCKSDB_NAMESPACE::blob_db::BlobDBOptions().enable_garbage_collection,
- "[Stacked BlobDB] Enable BlobDB garbage collection.");
- DEFINE_double(
- blob_db_gc_cutoff,
- ROCKSDB_NAMESPACE::blob_db::BlobDBOptions().garbage_collection_cutoff,
- "[Stacked BlobDB] Cutoff ratio for BlobDB garbage collection.");
- // Options for integrated BlobDB
- DEFINE_bool(allow_setting_blob_options_dynamically, false,
- "[Integrated BlobDB] Allow setting blob options dynamically.");
- DEFINE_bool(
- enable_blob_files,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions().enable_blob_files,
- "[Integrated BlobDB] Enable writing large values to separate blob files.");
- DEFINE_uint64(min_blob_size,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions().min_blob_size,
- "[Integrated BlobDB] The size of the smallest value to be stored "
- "separately in a blob file.");
- DEFINE_uint64(blob_file_size,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions().blob_file_size,
- "[Integrated BlobDB] The size limit for blob files.");
- DEFINE_string(blob_compression_type, "none",
- "[Integrated BlobDB] The compression algorithm to use for large "
- "values stored in blob files.");
- DEFINE_string(compression_manager, "mixed",
- "Ability to change compression manager specified in "
- "simple_mixed_manager.h (mixed -> roundRobin)");
- DEFINE_bool(enable_blob_garbage_collection,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions()
- .enable_blob_garbage_collection,
- "[Integrated BlobDB] Enable blob garbage collection.");
- DEFINE_double(blob_garbage_collection_age_cutoff,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions()
- .blob_garbage_collection_age_cutoff,
- "[Integrated BlobDB] The cutoff in terms of blob file age for "
- "garbage collection.");
- DEFINE_double(blob_garbage_collection_force_threshold,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions()
- .blob_garbage_collection_force_threshold,
- "[Integrated BlobDB] The threshold for the ratio of garbage in "
- "the eligible blob files for forcing garbage collection.");
- DEFINE_uint64(blob_compaction_readahead_size,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions()
- .blob_compaction_readahead_size,
- "[Integrated BlobDB] Compaction readahead for blob files.");
- DEFINE_int32(
- blob_file_starting_level,
- ROCKSDB_NAMESPACE::AdvancedColumnFamilyOptions().blob_file_starting_level,
- "[Integrated BlobDB] Enable writing blob files during flushes and "
- "compactions starting from the specified level.");
- DEFINE_bool(use_blob_cache, false, "[Integrated BlobDB] Enable blob cache.");
- DEFINE_bool(
- use_shared_block_and_blob_cache, true,
- "[Integrated BlobDB] Use a shared backing cache for both block "
- "cache and blob cache. It only takes effect if use_blob_cache is enabled.");
- DEFINE_uint64(
- blob_cache_size, 2LL * KB * KB * KB,
- "[Integrated BlobDB] Number of bytes to use as a cache of blobs. It only "
- "takes effect if the block and blob caches are different "
- "(use_shared_block_and_blob_cache = false).");
- DEFINE_int32(blob_cache_numshardbits, 6,
- "[Integrated BlobDB] Number of shards for the blob cache is 2 ** "
- "blob_cache_numshardbits. Negative means use default settings. "
- "It only takes effect if blob_cache_size is greater than 0, and "
- "the block and blob caches are different "
- "(use_shared_block_and_blob_cache = false).");
- DEFINE_int32(prepopulate_blob_cache, 0,
- "[Integrated BlobDB] Pre-populate hot/warm blobs in blob cache. 0 "
- "to disable and 1 to insert during flush.");
- DEFINE_int64(preclude_last_level_data_seconds, 0,
- "Preclude data from the last level. Used with tiered storage "
- "feature to preclude new data from comacting to the last level.");
- DEFINE_int64(
- preserve_internal_time_seconds, 0,
- "Preserve internal time information which is attached to each SST.");
- DEFINE_uint32(use_timed_put_one_in, 0,
- "If greater than zero, TimedPut is used per every N write ops on "
- "on average.");
- DEFINE_string(file_temperature_age_thresholds, "",
- "See CompactionOptionsFIFO::file_temperature_age_thresholds. "
- "empty == unset");
- DEFINE_bool(allow_trivial_copy_when_change_temperature, true,
- "Allow kChangeTemperature to do trivial copy");
- static const bool FLAGS_subcompactions_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_subcompactions, &ValidateUint32Range);
- static bool ValidateInt32Positive(const char* flagname, int32_t value) {
- if (value < 0) {
- fprintf(stderr, "Invalid value for --%s: %d, must be >=0\n", flagname,
- value);
- return false;
- }
- return true;
- }
- DEFINE_int32(reopen, 10, "Number of times database reopens");
- static const bool FLAGS_reopen_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_reopen, &ValidateInt32Positive);
- DEFINE_double(bloom_bits, 10,
- "Bloom filter bits per key. "
- "Negative means use default settings.");
- DEFINE_int32(
- bloom_before_level, 999,
- "Use Bloom filter on levels below specified and Ribbon beginning on level "
- "specified. Flush is considered level -1. Setting -1 -> always Ribbon. "
- "0 -> Ribbon except Bloom for flush. INT_MAX (typically 2147483647) -> "
- "always Bloom.");
- DEFINE_bool(partition_filters, false,
- "use partitioned filters "
- "for block-based table");
- DEFINE_bool(
- optimize_filters_for_memory,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().optimize_filters_for_memory,
- "Minimize memory footprint of filters");
- DEFINE_bool(
- detect_filter_construct_corruption,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions()
- .detect_filter_construct_corruption,
- "Detect corruption during new Bloom Filter and Ribbon Filter construction");
- DEFINE_string(sqfc_name, "foo",
- "Config name to select from SstQueryFilterConfigsManager.");
- DEFINE_uint32(sqfc_version, 0,
- "User-defined filtering version to select from "
- "SstQueryFilterConfigsManager. 0 = disable writing filters");
- DEFINE_bool(use_sqfc_for_range_queries, true,
- "Apply SstQueryFilters to range queries");
- DEFINE_int32(
- index_type,
- static_cast<int32_t>(
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().index_type),
- "Type of block-based table index (see `enum IndexType` in table.h)");
- DEFINE_int32(
- data_block_index_type,
- static_cast<int32_t>(
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().data_block_index_type),
- "Index type for data blocks (see `enum DataBlockIndexType` in table.h)");
- DEFINE_string(db, "", "Use the db with the following name.");
- DEFINE_string(secondaries_base, "",
- "Use this path as the base path for secondary instances.");
- DEFINE_bool(test_secondary, false,
- "If true, start an additional secondary instance which can be used "
- "for verification.");
- DEFINE_string(
- expected_values_dir, "",
- "Dir where files containing info about the latest/historical values will "
- "be stored. If provided and non-empty, the DB state will be verified "
- "against values from these files after recovery. --max_key and "
- "--column_family must be kept the same across invocations of this program "
- "that use the same --expected_values_dir. Currently historical values are "
- "only tracked when --sync_fault_injection is set. See --seed and "
- "--nooverwritepercent for further requirements.");
- DEFINE_bool(verify_checksum, false,
- "Verify checksum for every block read from storage");
- DEFINE_bool(mmap_read, ROCKSDB_NAMESPACE::Options().allow_mmap_reads,
- "Allow reads to occur via mmap-ing files");
- DEFINE_bool(mmap_write, ROCKSDB_NAMESPACE::Options().allow_mmap_writes,
- "Allow writes to occur via mmap-ing files");
- DEFINE_bool(use_direct_reads, ROCKSDB_NAMESPACE::Options().use_direct_reads,
- "Use O_DIRECT for reading data");
- DEFINE_bool(use_direct_io_for_flush_and_compaction,
- ROCKSDB_NAMESPACE::Options().use_direct_io_for_flush_and_compaction,
- "Use O_DIRECT for writing data");
- DEFINE_bool(mock_direct_io, false,
- "Mock direct IO by not using O_DIRECT for direct IO read");
- DEFINE_bool(statistics, false, "Create database statistics");
- DEFINE_bool(sync, false, "Sync all writes to disk");
- DEFINE_bool(use_fsync, false, "If true, issue fsync instead of fdatasync");
- DEFINE_uint64(bytes_per_sync, ROCKSDB_NAMESPACE::Options().bytes_per_sync,
- "If nonzero, sync SST file data incrementally after every "
- "`bytes_per_sync` bytes are written");
- DEFINE_uint64(wal_bytes_per_sync,
- ROCKSDB_NAMESPACE::Options().wal_bytes_per_sync,
- "If nonzero, sync WAL file data incrementally after every "
- "`bytes_per_sync` bytes are written");
- DEFINE_int32(kill_random_test, 0,
- "If non-zero, kill at various points in source code with "
- "probability 1/this");
- static const bool FLAGS_kill_random_test_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_kill_random_test, &ValidateInt32Positive);
- DEFINE_string(kill_exclude_prefixes, "",
- "If non-empty, kill points with prefix in the list given will be"
- " skipped. Items are comma-separated.");
- extern std::vector<std::string> rocksdb_kill_exclude_prefixes;
- DEFINE_bool(disable_wal, false, "If true, do not write WAL for write.");
- DEFINE_uint64(recycle_log_file_num,
- ROCKSDB_NAMESPACE::Options().recycle_log_file_num,
- "Number of old WAL files to keep around for later recycling");
- DEFINE_int64(target_file_size_base,
- ROCKSDB_NAMESPACE::Options().target_file_size_base,
- "Target level-1 file size for compaction");
- DEFINE_int32(target_file_size_multiplier, 1,
- "A multiplier to compute target level-N file size (N >= 2)");
- DEFINE_uint64(max_bytes_for_level_base,
- ROCKSDB_NAMESPACE::Options().max_bytes_for_level_base,
- "Max bytes for level-1");
- DEFINE_double(max_bytes_for_level_multiplier, 2,
- "A multiplier to compute max bytes for level-N (N >= 2)");
- DEFINE_int32(range_deletion_width, 10,
- "The width of the range deletion intervals.");
- DEFINE_uint64(rate_limiter_bytes_per_sec, 0, "Set options.rate_limiter value.");
- DEFINE_bool(rate_limit_bg_reads, false,
- "Use options.rate_limiter on compaction reads");
- DEFINE_bool(rate_limit_user_ops, false,
- "When true use Env::IO_USER priority level to charge internal rate "
- "limiter for reads associated with user operations.");
- DEFINE_bool(rate_limit_auto_wal_flush, false,
- "When true use Env::IO_USER priority level to charge internal rate "
- "limiter for automatic WAL flush (`Options::manual_wal_flush` == "
- "false) after the user "
- "write operation.");
- DEFINE_uint64(sst_file_manager_bytes_per_sec, 0,
- "Set `Options::sst_file_manager` to delete at this rate. By "
- "default the deletion rate is unbounded.");
- DEFINE_uint64(sst_file_manager_bytes_per_truncate, 0,
- "Set `Options::sst_file_manager` to delete in chunks of this "
- "many bytes. By default whole files will be deleted.");
- DEFINE_bool(use_txn, false,
- "Use TransactionDB or OptimisticTransactionDB. When "
- "use_optimistic_txn == false (by default), "
- "it's (Pessimistic) TransactionDB");
- DEFINE_uint64(txn_write_policy, 0,
- "The transaction write policy. Default is "
- "TxnDBWritePolicy::WRITE_COMMITTED. Note that this should not be "
- "changed across crashes.");
- DEFINE_bool(use_per_key_point_lock_mgr, true,
- "Use PointLockManager(false) or PerKeyPointLockManager(true) in "
- "TransactionDB.");
- DEFINE_bool(use_optimistic_txn, false, "Use OptimisticTransactionDB.");
- DEFINE_uint64(occ_validation_policy, 1,
- "Optimistic Concurrency Control Validation Policy for "
- "OptimisticTransactionDB");
- DEFINE_bool(share_occ_lock_buckets, false,
- "Share a pool of locks across DB instances for buckets");
- DEFINE_uint32(
- occ_lock_bucket_count, 500,
- "Bucket Count for shared Optimistic Concurrency Control (OCC) locks");
- DEFINE_bool(unordered_write, false,
- "Turn on the unordered_write feature. This options is currently "
- "tested only in combination with use_txn=true and "
- "txn_write_policy=TxnDBWritePolicy::WRITE_PREPARED.");
- DEFINE_int32(backup_one_in, 0,
- "If non-zero, then CreateNewBackup() will be called once for "
- "every N operations on average. 0 indicates CreateNewBackup() "
- "is disabled.");
- DEFINE_uint64(backup_max_size, 100 * 1024 * 1024,
- "If non-zero, skip checking backup/restore when DB size in "
- "bytes exceeds this setting.");
- DEFINE_int32(checkpoint_one_in, 0,
- "If non-zero, then CreateCheckpoint() will be called once for "
- "every N operations on average. 0 indicates CreateCheckpoint() "
- "is disabled.");
- DEFINE_int32(ingest_external_file_one_in, 0,
- "If non-zero, then IngestExternalFile() will be called once for "
- "every N operations on average. 0 indicates IngestExternalFile() "
- "is disabled.");
- DEFINE_int32(ingest_external_file_width, 100,
- "The width of the ingested external files.");
- DEFINE_int32(compact_files_one_in, 0,
- "If non-zero, then CompactFiles() will be called once for every N "
- "operations on average. 0 indicates CompactFiles() is disabled.");
- DEFINE_int32(compact_range_one_in, 0,
- "If non-zero, then CompactRange() will be called once for every N "
- "operations on average. 0 indicates CompactRange() is disabled.");
- DEFINE_int32(promote_l0_one_in, 0,
- "If non-zero, then PromoteL0() will be called once for every N "
- "operations on average. 0 indicates PromoteL0() is disabled.");
- DEFINE_int32(mark_for_compaction_one_file_in, 0,
- "A `TablePropertiesCollectorFactory` will be registered, which "
- "creates a `TablePropertiesCollector` with `NeedCompact()` "
- "returning true once for every N files on average. 0 or negative "
- "mean `NeedCompact()` always returns false.");
- DEFINE_int32(flush_one_in, 0,
- "If non-zero, then Flush() will be called once for every N ops "
- "on average. 0 indicates calls to Flush() are disabled.");
- DEFINE_int32(key_may_exist_one_in, 0,
- "If non-zero, then KeyMayExist() will be called "
- "once for every N ops on average. 0 disables.");
- DEFINE_int32(reset_stats_one_in, 0,
- "If non-zero, then ResetStats() will be called "
- "once for every N ops on average. 0 disables.");
- DEFINE_int32(pause_background_one_in, 0,
- "If non-zero, then PauseBackgroundWork()+Continue will be called "
- "once for every N ops on average. 0 disables.");
- DEFINE_int32(disable_file_deletions_one_in, 0,
- "If non-zero, then DisableFileDeletions()+Enable will be called "
- "once for every N ops on average. 0 disables.");
- DEFINE_int32(
- disable_manual_compaction_one_in, 0,
- "If non-zero, then DisableManualCompaction()+Enable will be called "
- "once for every N ops on average. 0 disables.");
- DEFINE_int32(compact_range_width, 10000,
- "The width of the ranges passed to CompactRange().");
- DEFINE_int32(acquire_snapshot_one_in, 0,
- "If non-zero, then acquires a snapshot once every N operations on "
- "average.");
- DEFINE_bool(compare_full_db_state_snapshot, false,
- "If set we compare state of entire db (in one of the threads) with"
- "each snapshot.");
- DEFINE_uint64(snapshot_hold_ops, 0,
- "If non-zero, then releases snapshots N operations after they're "
- "acquired.");
- DEFINE_bool(long_running_snapshots, false,
- "If set, hold on some some snapshots for much longer time.");
- // The following three options affect both regular read operations during the
- // test and initial/final database verification through VerifyDB.
- DEFINE_bool(use_multiget, false,
- "If set, use the batched MultiGet API for reads.");
- DEFINE_bool(use_get_entity, false, "If set, use the GetEntity API for reads.");
- DEFINE_bool(use_multi_get_entity, false,
- "If set, use the MultiGetEntity API for reads.");
- DEFINE_int32(test_ingest_standalone_range_deletion_one_in, 0,
- "If non-zero, file ingestion flow will test standalone range "
- "deletion file once every N file ingestion operations.");
- DEFINE_bool(allow_unprepared_value,
- ROCKSDB_NAMESPACE::ReadOptions().allow_unprepared_value,
- "Allow lazy loading of values for range scans");
- DEFINE_bool(track_and_verify_wals,
- ROCKSDB_NAMESPACE::Options().track_and_verify_wals,
- "See Options::track_and_verify_wals");
- DEFINE_int32(
- remote_compaction_worker_threads, 2,
- "Remote Compaction Worker Thread count. If 0, remote compaction is "
- "disabled");
- DEFINE_int32(remote_compaction_worker_interval, 10,
- "Remote Compaction Worker Thread dequeue tasks every N "
- "milliseconds. (Default: 10ms)");
- DEFINE_bool(remote_compaction_failure_fall_back_to_local, true,
- "If true, remote compaction failures will be ignored and "
- "compactions will fall back to local and retried");
- DEFINE_int32(allow_resumption_one_in, 0,
- "If non-zero, enable resumable compaction with 1/N probability "
- "for each OpenAndCompact call.Requires "
- "remote_compaction_worker_threads > 0");
- DEFINE_uint32(ingest_wbwi_one_in, 0,
- "If set, will call"
- "IngestWriteBatchWithIndex() instead of regular write operations "
- "once every N writes.");
- static bool ValidateInt32Percent(const char* flagname, int32_t value) {
- if (value < 0 || value > 100) {
- fprintf(stderr, "Invalid value for --%s: %d, 0<= pct <=100 \n", flagname,
- value);
- return false;
- }
- return true;
- }
- DEFINE_int32(readpercent, 10,
- "Ratio of reads to total workload (expressed as a percentage)");
- static const bool FLAGS_readpercent_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_readpercent, &ValidateInt32Percent);
- DEFINE_int32(prefixpercent, 20,
- "Ratio of prefix iterators to total workload (expressed as a"
- " percentage)");
- static const bool FLAGS_prefixpercent_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_prefixpercent, &ValidateInt32Percent);
- DEFINE_int32(writepercent, 45,
- "Ratio of writes to total workload (expressed as a percentage)");
- static const bool FLAGS_writepercent_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_writepercent, &ValidateInt32Percent);
- DEFINE_int32(delpercent, 15,
- "Ratio of deletes to total workload (expressed as a percentage)");
- static const bool FLAGS_delpercent_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_delpercent, &ValidateInt32Percent);
- DEFINE_int32(delrangepercent, 0,
- "Ratio of range deletions to total workload (expressed as a "
- "percentage). Cannot be used with test_batches_snapshots");
- static const bool FLAGS_delrangepercent_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_delrangepercent, &ValidateInt32Percent);
- DEFINE_int32(nooverwritepercent, 60,
- "Ratio of keys without overwrite to total workload (expressed as "
- "a percentage). When --expected_values_dir is nonempty, must "
- "keep this value constant across invocations.");
- static const bool FLAGS_nooverwritepercent_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_nooverwritepercent, &ValidateInt32Percent);
- DEFINE_int32(iterpercent, 10,
- "Ratio of iterations to total workload"
- " (expressed as a percentage)");
- static const bool FLAGS_iterpercent_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_iterpercent, &ValidateInt32Percent);
- DEFINE_uint64(num_iterations, 10, "Number of iterations per MultiIterate run");
- static const bool FLAGS_num_iterations_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_num_iterations, &ValidateUint32Range);
- DEFINE_int32(
- customopspercent, 0,
- "Ratio of custom operations to total workload (expressed as a percentage)");
- DEFINE_string(compression_type, "snappy",
- "Algorithm to use to compress the database");
- DEFINE_int32(compression_max_dict_bytes, 0,
- "Maximum size of dictionary used to prime the compression "
- "library.");
- DEFINE_int32(compression_zstd_max_train_bytes, 0,
- "Maximum size of training data passed to zstd's dictionary "
- "trainer.");
- DEFINE_int32(compression_parallel_threads, 1,
- "Number of threads for parallel compression.");
- DEFINE_uint64(compression_max_dict_buffer_bytes, 0,
- "Buffering limit for SST file data to sample for dictionary "
- "compression.");
- DEFINE_bool(
- compression_use_zstd_dict_trainer, true,
- "Use zstd's trainer to generate dictionary. If the options is false, "
- "zstd's finalizeDictionary() API is used to generate dictionary. "
- "ZSTD 1.4.5+ is required. If ZSTD 1.4.5+ is not linked with the binary, "
- "this flag will have the default value true.");
- DEFINE_bool(compression_checksum, false,
- "Turn on zstd's checksum feature for detecting corruption.");
- DEFINE_string(bottommost_compression_type, "disable",
- "Algorithm to use to compress bottommost level of the database. "
- "\"disable\" means disabling the feature");
- DEFINE_string(checksum_type, "kCRC32c", "Algorithm to use to checksum blocks");
- DEFINE_string(env_uri, "",
- "URI for env lookup. Mutually exclusive with --fs_uri");
- DEFINE_string(fs_uri, "",
- "URI for registry Filesystem lookup. Mutually exclusive"
- " with --env_uri."
- " Creates a default environment with the specified filesystem.");
- DEFINE_uint64(ops_per_thread, 1200000, "Number of operations per thread.");
- static const bool FLAGS_ops_per_thread_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_ops_per_thread, &ValidateUint32Range);
- DEFINE_uint64(log2_keys_per_lock, 2, "Log2 of number of keys per lock");
- static const bool FLAGS_log2_keys_per_lock_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_log2_keys_per_lock, &ValidateUint32Range);
- DEFINE_uint64(max_manifest_file_size, 16384, "Maximum size of a MANIFEST file");
- DEFINE_bool(in_place_update, false, "On true, does inplace update in memtable");
- DEFINE_string(memtablerep, "skip_list", "");
- inline static bool ValidatePrefixSize(const char* flagname, int32_t value) {
- if (value < -1 || value > 8) {
- fprintf(stderr, "Invalid value for --%s: %d. -1 <= PrefixSize <= 8\n",
- flagname, value);
- return false;
- }
- return true;
- }
- DEFINE_int32(prefix_size, 7,
- "Control the prefix size for HashSkipListRep. "
- "-1 is disabled.");
- static const bool FLAGS_prefix_size_dummy __attribute__((__unused__)) =
- RegisterFlagValidator(&FLAGS_prefix_size, &ValidatePrefixSize);
- DEFINE_bool(use_merge, false,
- "On true, replaces all writes with a Merge "
- "that behaves like a Put");
- DEFINE_uint32(use_put_entity_one_in, 0,
- "If greater than zero, PutEntity will be used once per every N "
- "write ops on average.");
- DEFINE_bool(use_attribute_group, false,
- "If set, use the attribute_group API to put/get entities");
- DEFINE_bool(use_multi_cf_iterator, false,
- "If set, use the multi_cf_iterator for TestIterate");
- DEFINE_bool(use_full_merge_v1, false,
- "On true, use a merge operator that implement the deprecated "
- "version of FullMerge");
- DEFINE_int32(sync_wal_one_in, 0,
- "If non-zero, then SyncWAL() will be called once for every N ops "
- "on average. 0 indicates that calls to SyncWAL() are disabled.");
- DEFINE_bool(avoid_unnecessary_blocking_io,
- ROCKSDB_NAMESPACE::Options().avoid_unnecessary_blocking_io,
- "If true, some expensive cleaning up operations will be moved from "
- "user reads to high-pri background threads.");
- DEFINE_bool(write_dbid_to_manifest,
- ROCKSDB_NAMESPACE::Options().write_dbid_to_manifest,
- "Write DB_ID to manifest");
- DEFINE_bool(write_identity_file,
- ROCKSDB_NAMESPACE::Options().write_identity_file,
- "Write DB_ID to IDENTITY file");
- DEFINE_bool(avoid_flush_during_recovery,
- ROCKSDB_NAMESPACE::Options().avoid_flush_during_recovery,
- "Avoid flush during recovery");
- DEFINE_uint64(max_write_batch_group_size_bytes,
- ROCKSDB_NAMESPACE::Options().max_write_batch_group_size_bytes,
- "Max write batch group size");
- DEFINE_bool(level_compaction_dynamic_level_bytes,
- ROCKSDB_NAMESPACE::Options().level_compaction_dynamic_level_bytes,
- "Use dynamic level");
- DEFINE_int32(verify_checksum_one_in, 0,
- "If non-zero, then DB::VerifyChecksum() will be called to do"
- " checksum verification of all the files in the database once for"
- " every N ops on average. 0 indicates that calls to"
- " VerifyChecksum() are disabled.");
- DEFINE_int32(verify_file_checksums_one_in, 0,
- "If non-zero, then DB::VerifyFileChecksums() will be called to do"
- " checksum verification of all the files in the database once for"
- " every N ops on average. 0 indicates that calls to"
- " VerifyFileChecksums() are disabled.");
- DEFINE_int32(verify_db_one_in, 0,
- "If non-zero, call VerifyDb() once for every N ops. 0 indicates "
- "that VerifyDb() will not be called in OperateDb(). Note that "
- "enabling this can slow down tests.");
- DEFINE_int32(continuous_verification_interval, 1000,
- "While test is running, verify db every N milliseconds. 0 "
- "disables continuous verification.");
- DEFINE_int32(approximate_size_one_in, 64,
- "If non-zero, DB::GetApproximateSizes() and "
- "DB::GetApproximateMemTableStats() will be called against "
- "random key ranges.");
- DEFINE_int32(read_fault_one_in, 1000,
- "On non-zero, enables fault injection on read");
- DEFINE_bool(error_recovery_with_no_fault_injection, false,
- "If true, error recovery will be done without fault injection if "
- "fault injection is enabled");
- DEFINE_int32(metadata_read_fault_one_in, 1000,
- "On non-zero, enables fault injection on metadata read (i.e, "
- "directory and file metadata read)");
- DEFINE_int32(get_property_one_in, 1000,
- "If non-zero, then DB::GetProperty() will be called to get various"
- " properties for every N ops on average. 0 indicates that"
- " GetProperty() will be not be called.");
- DEFINE_int32(get_properties_of_all_tables_one_in, 1000,
- "If non-zero, then DB::GetPropertiesOfAllTables() will be called "
- "for every N ops on average. 0 indicates that"
- " it will be not be called.");
- DEFINE_bool(sync_fault_injection, false,
- "If true, FaultInjectionTestFS will be used for write operations, "
- "and unsynced data in DB will lost after crash. In such a case we "
- "track DB changes in a trace file (\"*.trace\") in "
- "--expected_values_dir for verifying there are no holes in the "
- "recovered data.");
- DEFINE_bool(best_efforts_recovery, false,
- "If true, use best efforts recovery.");
- DEFINE_bool(skip_verifydb, false,
- "If true, skip VerifyDb() calls and Get()/Iterator verifications"
- "against expected state.");
- DEFINE_bool(enable_compaction_filter, false,
- "If true, configures a compaction filter that returns a kRemove "
- "decision for deleted keys.");
- DEFINE_bool(paranoid_file_checks, true,
- "After writing every SST file, reopen it and read all the keys "
- "and validate checksums");
- DEFINE_uint64(batch_protection_bytes_per_key, 0,
- "If nonzero, enables integrity protection in `WriteBatch` at the "
- "specified number of bytes per key. Currently the only supported "
- "nonzero value is eight.");
- DEFINE_uint32(
- memtable_protection_bytes_per_key, 0,
- "If nonzero, enables integrity protection in memtable entries at the "
- "specified number of bytes per key. Currently the supported "
- "nonzero values are 1, 2, 4 and 8.");
- DEFINE_uint32(block_protection_bytes_per_key, 0,
- "If nonzero, enables integrity protection in blocks at the "
- "specified number of bytes per key. Currently the supported "
- "nonzero values are 1, 2, 4 and 8.");
- DEFINE_string(file_checksum_impl, "none",
- "Name of an implementation for file_checksum_gen_factory, or "
- "\"none\" for null.");
- DEFINE_int32(write_fault_one_in, 0,
- "On non-zero, enables fault injection on write. Currently only"
- "injects write error when writing to SST files.");
- DEFINE_bool(exclude_wal_from_write_fault_injection, false,
- "If true, we won't inject write fault when writing to WAL file");
- DEFINE_int32(metadata_write_fault_one_in, 1000,
- "On non-zero, enables fault injection on metadata write (i.e, "
- "directory and file metadata write)");
- DEFINE_uint64(user_timestamp_size, 0,
- "Number of bytes for a user-defined timestamp. Currently, only "
- "8-byte is supported");
- DEFINE_bool(persist_user_defined_timestamps, true,
- "Flag to indicate whether user-defined timestamps will be persisted"
- " during Flush");
- DEFINE_int32(open_metadata_read_fault_one_in, 0,
- "On non-zero, enables fault injection on file metadata read (i.e, "
- "directory and file metadata read)"
- "during DB reopen.");
- DEFINE_int32(open_metadata_write_fault_one_in, 0,
- "On non-zero, enables fault injection on file metadata write "
- "during DB reopen.");
- DEFINE_string(secondary_cache_uri, "",
- "Full URI for creating a customized secondary cache object");
- DEFINE_int32(secondary_cache_fault_one_in, 0,
- "On non-zero, enables fault injection in secondary cache inserts"
- " and lookups");
- DEFINE_double(tiered_cache_percent_compressed, 0.0,
- "Percentage of total block cache budget to allocate to the "
- "compressed cache");
- DEFINE_int32(open_write_fault_one_in, 0,
- "On non-zero, enables fault injection on file writes "
- "during DB reopen.");
- DEFINE_int32(open_read_fault_one_in, 0,
- "On non-zero, enables fault injection on file reads "
- "during DB reopen.");
- DEFINE_int32(inject_error_severity, 1,
- "The severity of the injected IO Error. 1 is soft error (e.g. "
- "retryable error), 2 is fatal error, and the default is "
- "retryable error.");
- DEFINE_int32(prepopulate_block_cache,
- static_cast<int32_t>(ROCKSDB_NAMESPACE::BlockBasedTableOptions::
- PrepopulateBlockCache::kDisable),
- "Options related to cache warming (see `enum "
- "PrepopulateBlockCache` in table.h)");
- DEFINE_bool(two_write_queues, false,
- "Set to true to enable two write queues. Default: false");
- DEFINE_bool(use_only_the_last_commit_time_batch_for_recovery, false,
- "If true, the commit-time write batch will not be immediately "
- "inserted into the memtables. Default: false");
- DEFINE_uint64(
- wp_snapshot_cache_bits, 7ull,
- "Number of bits to represent write-prepared transaction db's snapshot "
- "cache. Default: 7 (128 entries)");
- DEFINE_uint64(wp_commit_cache_bits, 23ull,
- "Number of bits to represent write-prepared transaction db's "
- "commit cache. Default: 23 (8M entries)");
- DEFINE_bool(adaptive_readahead, false,
- "Carry forward internal auto readahead size from one file to next "
- "file at each level during iteration");
- DEFINE_bool(
- async_io, false,
- "Does asynchronous prefetching when internal auto readahead is enabled");
- DEFINE_string(wal_compression, "none",
- "Algorithm to use for WAL compression. none to disable.");
- DEFINE_bool(
- verify_sst_unique_id_in_manifest, false,
- "Enable DB options `verify_sst_unique_id_in_manifest`, if true, during "
- "DB-open try verifying the SST unique id between MANIFEST and SST "
- "properties.");
- DEFINE_int32(
- create_timestamped_snapshot_one_in, 0,
- "On non-zero, create timestamped snapshots upon transaction commits.");
- DEFINE_bool(allow_data_in_errors,
- ROCKSDB_NAMESPACE::Options().allow_data_in_errors,
- "If true, allow logging data, e.g. key, value in LOG files.");
- DEFINE_bool(enable_thread_tracking,
- ROCKSDB_NAMESPACE::Options().enable_thread_tracking,
- "If true, the status of the threads involved in this DB will be "
- "tracked and available via GetThreadList() API.");
- DEFINE_int32(verify_iterator_with_expected_state_one_in, 0,
- "If non-zero, when TestIterate() is to be called, there is a "
- "1/verify_iterator_with_expected_state_one_in "
- "chance that the iterator is verified against the expected state "
- "file, instead of comparing keys between two iterators.");
- DEFINE_uint64(readahead_size, 0, "Iterator readahead size");
- DEFINE_uint64(initial_auto_readahead_size, 0,
- "Initial auto readahead size for prefetching during Iteration");
- DEFINE_uint64(max_auto_readahead_size, 0,
- "Max auto readahead size for prefetching during Iteration");
- DEFINE_uint64(
- num_file_reads_for_auto_readahead, 0,
- "Num of sequential reads to enable auto prefetching during Iteration");
- DEFINE_bool(
- preserve_unverified_changes, false,
- "DB files of the current run will all be preserved in `FLAGS_db`. DB files "
- "from the last run will be preserved in `FLAGS_db/unverified` until the "
- "first verification succeeds. Expected state files from the last run will "
- "be preserved similarly under `FLAGS_expected_values_dir/unverified` when "
- "`--expected_values_dir` is nonempty.");
- DEFINE_uint64(stats_dump_period_sec,
- ROCKSDB_NAMESPACE::Options().stats_dump_period_sec,
- "Gap between printing stats to log in seconds");
- DEFINE_bool(verification_only, false,
- "If true, tests will only execute verification step");
- extern "C" bool RocksDbIOUringEnable() { return true; }
- DEFINE_uint32(memtable_max_range_deletions, 0,
- "If nonzero, RocksDB will try to flush the current memtable"
- "after the number of range deletions is >= this limit");
- DEFINE_uint32(bottommost_file_compaction_delay, 0,
- "Delay kBottommostFiles compaction by this amount of seconds."
- "See more in option comment.");
- DEFINE_bool(auto_readahead_size, false,
- "Does auto tuning of readahead_size when enabled during scans.");
- DEFINE_bool(allow_fallocate, ROCKSDB_NAMESPACE::Options().allow_fallocate,
- "Options.allow_fallocate");
- DEFINE_int32(table_cache_numshardbits,
- ROCKSDB_NAMESPACE::Options().table_cache_numshardbits,
- "Options.table_cache_numshardbits");
- DEFINE_uint64(log_readahead_size,
- ROCKSDB_NAMESPACE::Options().log_readahead_size,
- "Options.log_readahead_size");
- DEFINE_uint64(bgerror_resume_retry_interval,
- ROCKSDB_NAMESPACE::Options().bgerror_resume_retry_interval,
- "Options.bgerror_resume_retry_interval");
- DEFINE_uint64(delete_obsolete_files_period_micros,
- ROCKSDB_NAMESPACE::Options().delete_obsolete_files_period_micros,
- "Options.delete_obsolete_files_period_micros");
- DEFINE_uint64(max_log_file_size, ROCKSDB_NAMESPACE::Options().max_log_file_size,
- "Options.max_log_file_sizes");
- DEFINE_uint64(log_file_time_to_roll,
- ROCKSDB_NAMESPACE::Options().log_file_time_to_roll,
- "Options.log_file_time_to_roll");
- DEFINE_bool(use_adaptive_mutex, ROCKSDB_NAMESPACE::Options().use_adaptive_mutex,
- "Options.use_adaptive_mutex");
- DEFINE_bool(advise_random_on_open,
- ROCKSDB_NAMESPACE::Options().advise_random_on_open,
- "Options.advise_random_on_open");
- DEFINE_uint64(WAL_ttl_seconds, ROCKSDB_NAMESPACE::Options().WAL_ttl_seconds,
- "Options.WAL_ttl_seconds");
- DEFINE_uint64(WAL_size_limit_MB, ROCKSDB_NAMESPACE::Options().WAL_size_limit_MB,
- "Options.WAL_size_limit_MB");
- DEFINE_bool(strict_bytes_per_sync,
- ROCKSDB_NAMESPACE::Options().strict_bytes_per_sync,
- "Options.strict_bytes_per_sync");
- DEFINE_bool(avoid_flush_during_shutdown,
- ROCKSDB_NAMESPACE::Options().avoid_flush_during_shutdown,
- "Options.avoid_flush_during_shutdown");
- DEFINE_bool(fill_cache, ROCKSDB_NAMESPACE::ReadOptions().fill_cache,
- "ReadOptions.fill_cache");
- DEFINE_bool(optimize_multiget_for_io,
- ROCKSDB_NAMESPACE::ReadOptions().optimize_multiget_for_io,
- "ReadOptions.optimize_multiget_for_io");
- DEFINE_bool(memtable_insert_hint_per_batch,
- ROCKSDB_NAMESPACE::WriteOptions().memtable_insert_hint_per_batch,
- "WriteOptions.memtable_insert_hint_per_batch");
- DEFINE_bool(dump_malloc_stats, ROCKSDB_NAMESPACE::Options().dump_malloc_stats,
- "Options.dump_malloc_stats");
- DEFINE_uint64(stats_history_buffer_size,
- ROCKSDB_NAMESPACE::Options().stats_history_buffer_size,
- "Options.stats_history_buffer_size");
- DEFINE_bool(skip_stats_update_on_db_open,
- ROCKSDB_NAMESPACE::Options().skip_stats_update_on_db_open,
- "Options.skip_stats_update_on_db_open");
- DEFINE_bool(optimize_filters_for_hits,
- ROCKSDB_NAMESPACE::Options().optimize_filters_for_hits,
- "Options.optimize_filters_for_hits");
- DEFINE_uint64(sample_for_compression,
- ROCKSDB_NAMESPACE::Options().sample_for_compression,
- "Options.sample_for_compression");
- DEFINE_bool(report_bg_io_stats, ROCKSDB_NAMESPACE::Options().report_bg_io_stats,
- "Options.report_bg_io_stats");
- DEFINE_bool(
- cache_index_and_filter_blocks_with_high_priority,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions()
- .cache_index_and_filter_blocks_with_high_priority,
- "BlockBasedTableOptions.cache_index_and_filter_blocks_with_high_priority");
- DEFINE_bool(use_delta_encoding,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().use_delta_encoding,
- "BlockBasedTableOptions.use_delta_encoding");
- DEFINE_bool(verify_compression,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().verify_compression,
- "BlockBasedTableOptions.verify_compression");
- DEFINE_uint32(
- read_amp_bytes_per_bit,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().read_amp_bytes_per_bit,
- "Options.read_amp_bytes_per_bit");
- DEFINE_bool(
- enable_index_compression,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().enable_index_compression,
- "BlockBasedTableOptions.enable_index_compression");
- DEFINE_uint32(index_shortening,
- static_cast<uint32_t>(
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().index_shortening),
- "BlockBasedTableOptions.index_shortening");
- DEFINE_uint32(metadata_charge_policy,
- static_cast<uint32_t>(ROCKSDB_NAMESPACE::ShardedCacheOptions()
- .metadata_charge_policy),
- "ShardedCacheOptions.metadata_charge_policy");
- DEFINE_bool(use_adaptive_mutex_lru,
- ROCKSDB_NAMESPACE::LRUCacheOptions().use_adaptive_mutex,
- "LRUCacheOptions.use_adaptive_mutex");
- DEFINE_uint32(
- compress_format_version,
- static_cast<uint32_t>(ROCKSDB_NAMESPACE::CompressedSecondaryCacheOptions()
- .compress_format_version),
- "CompressedSecondaryCacheOptions.compress_format_version");
- DEFINE_uint64(manifest_preallocation_size,
- ROCKSDB_NAMESPACE::Options().manifest_preallocation_size,
- "Options.manifest_preallocation_size");
- DEFINE_uint64(max_total_wal_size,
- ROCKSDB_NAMESPACE::Options().max_total_wal_size,
- "Options.max_total_wal_size");
- DEFINE_bool(enable_checksum_handoff, false,
- "If true, include all the supported files in "
- "Options.checksum_handoff_file. Otherwise include no files.");
- DEFINE_double(high_pri_pool_ratio,
- ROCKSDB_NAMESPACE::LRUCacheOptions().high_pri_pool_ratio,
- "LRUCacheOptions.high_pri_pool_ratio");
- DEFINE_double(low_pri_pool_ratio,
- ROCKSDB_NAMESPACE::LRUCacheOptions().low_pri_pool_ratio,
- "LRUCacheOptions.low_pri_pool_ratio");
- DEFINE_uint64(soft_pending_compaction_bytes_limit,
- ROCKSDB_NAMESPACE::Options().soft_pending_compaction_bytes_limit,
- "Options.soft_pending_compaction_bytes_limit");
- DEFINE_uint64(hard_pending_compaction_bytes_limit,
- ROCKSDB_NAMESPACE::Options().hard_pending_compaction_bytes_limit,
- "Options.hard_pending_compaction_bytes_limit");
- DEFINE_bool(enable_sst_partitioner_factory, false,
- "If true, set Options.sst_partitioner_factory to "
- "SstPartitionerFixedPrefixFactory with prefix length equal to 1");
- DEFINE_bool(
- enable_do_not_compress_roles, false,
- "If true, set CompressedSecondaryCacheOptions.do_not_compress_roles to "
- "include all cache roles");
- DEFINE_bool(block_align,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().block_align,
- "BlockBasedTableOptions.block_align");
- DEFINE_uint64(
- super_block_alignment_size,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions().super_block_alignment_size,
- "BlockBasedTableOptions.super_block_alignment_size");
- DEFINE_uint64(
- super_block_alignment_space_overhead_ratio,
- ROCKSDB_NAMESPACE::BlockBasedTableOptions()
- .super_block_alignment_space_overhead_ratio,
- "BlockBasedTableOptions.super_block_alignment_space_overhead_ratio");
- DEFINE_uint32(
- lowest_used_cache_tier,
- static_cast<uint32_t>(ROCKSDB_NAMESPACE::Options().lowest_used_cache_tier),
- "Options.lowest_used_cache_tier");
- DEFINE_bool(enable_custom_split_merge,
- ROCKSDB_NAMESPACE::CompressedSecondaryCacheOptions()
- .enable_custom_split_merge,
- "CompressedSecondaryCacheOptions.enable_custom_split_merge");
- DEFINE_uint32(
- adm_policy,
- static_cast<uint32_t>(ROCKSDB_NAMESPACE::TieredCacheOptions().adm_policy),
- "TieredCacheOptions.adm_policy");
- DEFINE_string(last_level_temperature, "kUnknown",
- "Options.last_level_temperature");
- DEFINE_string(default_write_temperature, "kUnknown",
- "Options.default_write_temperature");
- DEFINE_string(default_temperature, "kUnknown", "Options.default_temperature");
- DEFINE_bool(enable_memtable_insert_with_hint_prefix_extractor,
- ROCKSDB_NAMESPACE::Options()
- .memtable_insert_with_hint_prefix_extractor != nullptr,
- "If true and FLAGS_prefix_size > 0, set "
- "Options.memtable_insert_with_hint_prefix_extractor to "
- "be Options.prefix_extractor");
- DEFINE_bool(check_multiget_consistency, true,
- "If true, check consistency of MultiGet result by comparing it "
- "with Get's under a snapshot");
- DEFINE_bool(check_multiget_entity_consistency, true,
- "If true, check consistency of MultiGetEntity result by comparing "
- "it GetEntity's under a snapshot");
- DEFINE_bool(inplace_update_support,
- ROCKSDB_NAMESPACE::Options().inplace_update_support,
- "Options.inplace_update_support");
- DEFINE_uint32(uncache_aggressiveness,
- ROCKSDB_NAMESPACE::ColumnFamilyOptions().uncache_aggressiveness,
- "Aggressiveness of erasing cache entries that are likely "
- "obsolete. 0 = disabled, 1 = minimum, 100 = moderate, 10000 = "
- "normal max");
- DEFINE_bool(paranoid_memory_checks,
- ROCKSDB_NAMESPACE::Options().paranoid_memory_checks,
- "Sets CF option paranoid_memory_checks.");
- DEFINE_bool(
- memtable_veirfy_per_key_checksum_on_seek,
- ROCKSDB_NAMESPACE::Options().memtable_veirfy_per_key_checksum_on_seek,
- "Sets CF option memtable_veirfy_per_key_checksum_on_seek.");
- DEFINE_uint32(commit_bypass_memtable_one_in, 0,
- "If greater than zero, transaction option will set "
- "commit_bypass_memtable to per every N transactions on average.");
- // Compaction on deletion trigger flags
- DEFINE_bool(enable_compaction_on_deletion_trigger, false,
- "Enable CompactOnDeletionCollectorFactory for stress testing "
- "deletion-triggered compaction scenarios.");
- DEFINE_uint64(compaction_on_deletion_min_file_size, 32 * 1024,
- "Minimum file size (in bytes) for deletion-triggered compaction. "
- "Files smaller than this will not trigger compaction even if "
- "deletion ratio is exceeded. Default: 32KB");
- DEFINE_int32(compaction_on_deletion_trigger_count, 50,
- "Number of deletions that triggers compaction when deletion "
- "ratio is exceeded. Default: 50");
- DEFINE_int32(compaction_on_deletion_window_size, 100,
- "Size of the sliding window for tracking deletions. "
- "Default: 100");
- DEFINE_double(compaction_on_deletion_ratio, 0.5,
- "Deletion ratio threshold for triggering compaction. "
- "Default: 0.5 (50%)");
- DEFINE_bool(
- auto_refresh_iterator_with_snapshot,
- ROCKSDB_NAMESPACE::ReadOptions().auto_refresh_iterator_with_snapshot,
- "ReadOptions.auto_refresh_iterator_with_snapshot");
- DEFINE_uint32(
- memtable_op_scan_flush_trigger,
- ROCKSDB_NAMESPACE::ColumnFamilyOptions().memtable_op_scan_flush_trigger,
- "Sets CF option memtable_op_scan_flush_trigger.");
- DEFINE_uint32(
- memtable_avg_op_scan_flush_trigger,
- ROCKSDB_NAMESPACE::ColumnFamilyOptions().memtable_avg_op_scan_flush_trigger,
- "Sets CF option memtable_avg_op_scan_flush_trigger.");
- DEFINE_bool(
- universal_reduce_file_locking,
- ROCKSDB_NAMESPACE::ColumnFamilyOptions()
- .compaction_options_universal.reduce_file_locking,
- "Sets "
- "ColumnFamilyOptions().compaciton_options_universal.reduce_file_locking.");
- DEFINE_bool(use_multiscan, false,
- "If set, use the batched MultiScan API for scans.");
- DEFINE_bool(multiscan_use_async_io, false,
- "If set, enable async_io for MultiScan operations.");
- #endif // GFLAGS
|