-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement Open/Write/Close APIs to write key-value pairs to import server. `Open` opens an engine identified by an UUID. `Write` creates a write stream to write key-value batch to the opened engine. Different clients can write to the same engine concurrently. `Close` closes the engine after all write batches are finished. An engine can only be closed when all write streams are closed. An engine can only be closed once, and it can not be opened again once it is closed. After these three steps, the data in the engine is ready to be imported to TiKV, but the `Import` API is not included in this PR.
- Loading branch information
1 parent
b660281
commit c1c8c82
Showing
17 changed files
with
840 additions
and
12 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| // Copyright 2018 PingCAP, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| use std::cmp; | ||
| use std::i32; | ||
| use std::fmt; | ||
| use std::ops::Deref; | ||
| use std::sync::Arc; | ||
| use std::path::Path; | ||
|
|
||
| use uuid::Uuid; | ||
|
|
||
| use rocksdb::{BlockBasedOptions, ColumnFamilyOptions, DBOptions, Writable, WriteBatch as RawBatch, | ||
| DB}; | ||
| use kvproto::importpb::*; | ||
|
|
||
| use config::DbConfig; | ||
| use storage::CF_DEFAULT; | ||
| use storage::types::Key; | ||
| use util::config::MB; | ||
| use util::rocksdb::{new_engine_opt, CFOptions}; | ||
| use util::rocksdb::properties::SizePropertiesCollectorFactory; | ||
|
|
||
| use super::Result; | ||
|
|
||
| pub struct Engine { | ||
| db: Arc<DB>, | ||
| uuid: Uuid, | ||
| } | ||
|
|
||
| impl Engine { | ||
| pub fn new<P: AsRef<Path>>(path: P, uuid: Uuid, opts: DbConfig) -> Result<Engine> { | ||
| let db = { | ||
| let (db_opts, cf_opts) = tune_dboptions_for_bulk_load(&opts); | ||
| new_engine_opt(path.as_ref().to_str().unwrap(), db_opts, vec![cf_opts])? | ||
| }; | ||
| Ok(Engine { | ||
| db: Arc::new(db), | ||
| uuid: uuid, | ||
| }) | ||
| } | ||
|
|
||
| pub fn uuid(&self) -> Uuid { | ||
| self.uuid | ||
| } | ||
|
|
||
| pub fn write(&self, mut batch: WriteBatch) -> Result<usize> { | ||
| // Just a guess. | ||
| let wb_cap = cmp::min(batch.get_mutations().len() * 128, MB as usize); | ||
| let wb = RawBatch::with_capacity(wb_cap); | ||
| let commit_ts = batch.get_commit_ts(); | ||
| for m in batch.take_mutations().iter_mut() { | ||
| let k = Key::from_raw(m.get_key()).append_ts(commit_ts); | ||
| wb.put(k.encoded(), m.get_value()).unwrap(); | ||
| } | ||
|
|
||
| let size = wb.data_size(); | ||
| self.write_without_wal(wb)?; | ||
|
|
||
| Ok(size) | ||
| } | ||
| } | ||
|
|
||
| impl Deref for Engine { | ||
| type Target = DB; | ||
|
|
||
| fn deref(&self) -> &Self::Target { | ||
| &self.db | ||
| } | ||
| } | ||
|
|
||
| impl fmt::Debug for Engine { | ||
| fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { | ||
| f.debug_struct("Engine") | ||
| .field("uuid", &self.uuid()) | ||
| .field("path", &self.path().to_owned()) | ||
| .finish() | ||
| } | ||
| } | ||
|
|
||
| fn tune_dboptions_for_bulk_load(opts: &DbConfig) -> (DBOptions, CFOptions) { | ||
| const DISABLED: i32 = i32::MAX; | ||
|
|
||
| let mut db_opts = DBOptions::new(); | ||
| db_opts.create_if_missing(true); | ||
| db_opts.enable_statistics(false); | ||
| // Vector memtable doesn't support concurrent write. | ||
| db_opts.allow_concurrent_memtable_write(false); | ||
| db_opts.set_use_direct_io_for_flush_and_compaction(true); | ||
| // RocksDB preserves `max_background_jobs/4` for flush. | ||
| db_opts.set_max_background_jobs(opts.max_background_jobs); | ||
|
|
||
| let mut block_base_opts = BlockBasedOptions::new(); | ||
| // Use a large block size for sequential access. | ||
| block_base_opts.set_block_size(MB as usize); | ||
| let mut cf_opts = ColumnFamilyOptions::new(); | ||
| cf_opts.set_block_based_table_factory(&block_base_opts); | ||
| cf_opts.compression_per_level(&opts.defaultcf.compression_per_level); | ||
| // Consider using a large write buffer but be careful about OOM. | ||
| cf_opts.set_write_buffer_size(opts.defaultcf.write_buffer_size.0); | ||
| cf_opts.set_target_file_size_base(opts.defaultcf.write_buffer_size.0); | ||
| cf_opts.set_vector_memtable_factory(opts.defaultcf.write_buffer_size.0); | ||
| cf_opts.set_max_write_buffer_number(opts.defaultcf.max_write_buffer_number); | ||
| // Disable compaction and rate limit. | ||
| cf_opts.set_disable_auto_compactions(true); | ||
| cf_opts.set_soft_pending_compaction_bytes_limit(0); | ||
| cf_opts.set_hard_pending_compaction_bytes_limit(0); | ||
| cf_opts.set_level_zero_stop_writes_trigger(DISABLED); | ||
| cf_opts.set_level_zero_slowdown_writes_trigger(DISABLED); | ||
| // Add size properties to get approximate ranges wihout scan. | ||
| let f = Box::new(SizePropertiesCollectorFactory::default()); | ||
| cf_opts.add_table_properties_collector_factory("tikv.size-properties-collector", f); | ||
|
|
||
| (db_opts, CFOptions::new(CF_DEFAULT, cf_opts)) | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| use tempdir::TempDir; | ||
|
|
||
| fn new_engine() -> (TempDir, Engine) { | ||
| let dir = TempDir::new("test_import_engine").unwrap(); | ||
| let uuid = Uuid::new_v4(); | ||
| let opts = DbConfig::default(); | ||
| let engine = Engine::new(dir.path(), uuid, opts).unwrap(); | ||
| (dir, engine) | ||
| } | ||
|
|
||
| fn new_write_batch(n: u8, ts: u64) -> WriteBatch { | ||
| let mut wb = WriteBatch::new(); | ||
| for i in 0..n { | ||
| let mut m = Mutation::new(); | ||
| m.set_op(Mutation_OP::Put); | ||
| m.set_key(vec![i]); | ||
| m.set_value(vec![i]); | ||
| wb.mut_mutations().push(m); | ||
| } | ||
| wb.set_commit_ts(ts); | ||
| wb | ||
| } | ||
|
|
||
| fn new_encoded_key(i: u8, ts: u64) -> Vec<u8> { | ||
| Key::from_raw(&[i]).append_ts(ts).encoded().to_owned() | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_write() { | ||
| let (_dir, engine) = new_engine(); | ||
|
|
||
| let n = 10; | ||
| let commit_ts = 10; | ||
| let wb = new_write_batch(n, commit_ts); | ||
| engine.write(wb).unwrap(); | ||
|
|
||
| for i in 0..n { | ||
| let key = new_encoded_key(i, commit_ts); | ||
| assert_eq!(engine.get(&key).unwrap().unwrap(), &[i]); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.