1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
use std::ops::Deref;
use crate::*;
/// The `sled` embedded database! Implements
/// `Deref<Target = sled::Tree>` to refer to
/// a default keyspace / namespace / bucket.
#[derive(Clone)]
pub struct Db {
#[doc(hidden)]
pub context: Context,
pub(crate) default: Tree,
tenants: Arc<RwLock<FastMap8<IVec, Tree>>>,
}
/// Opens a `Db` with a default configuration at the
/// specified path. This will create a new storage
/// directory at the specified path if it does
/// not already exist. You can use the `Db::was_recovered`
/// method to determine if your database was recovered
/// from a previous instance. You can use `Config::create_new`
/// if you want to increase the chances that the database
/// will be freshly created.
pub fn open<P: AsRef<std::path::Path>>(path: P) -> Result<Db> {
Config::new().path(path).open()
}
#[allow(unsafe_code)]
unsafe impl Send for Db {}
#[allow(unsafe_code)]
unsafe impl Sync for Db {}
impl Deref for Db {
type Target = Tree;
fn deref(&self) -> &Tree {
&self.default
}
}
impl Debug for Db {
fn fmt(
&self,
f: &mut fmt::Formatter<'_>,
) -> std::result::Result<(), fmt::Error> {
let tenants = self.tenants.read();
writeln!(f, "Db {{")?;
for (raw_name, tree) in tenants.iter() {
let name = std::str::from_utf8(raw_name)
.ok()
.map_or_else(|| format!("{:?}", raw_name), String::from);
write!(f, " Tree: {:?} contents: {:?}", name, tree)?;
}
write!(f, "}}")?;
Ok(())
}
}
impl Db {
#[doc(hidden)]
#[deprecated(since = "0.30.2", note = "replaced by `sled::open`")]
pub fn open<P: AsRef<std::path::Path>>(path: P) -> Result<Self> {
Config::new().path(path).open()
}
pub(crate) fn start_inner(config: RunningConfig) -> Result<Self> {
let _measure = Measure::new(&M.tree_start);
let context = Context::start(config)?;
#[cfg(all(
not(miri),
any(
windows,
target_os = "linux",
target_os = "macos",
target_os = "dragonfly",
target_os = "freebsd",
target_os = "openbsd",
target_os = "netbsd",
)
))]
{
let flusher_pagecache = context.pagecache.clone();
let flusher = context.flush_every_ms.map(move |fem| {
flusher::Flusher::new(
"log flusher".to_owned(),
flusher_pagecache,
fem,
)
});
*context.flusher.lock() = flusher;
}
// create or open the default tree
let guard = pin();
let default =
meta::open_tree(&context, DEFAULT_TREE_ID.to_vec(), &guard)?;
let ret = Self {
context: context.clone(),
default,
tenants: Arc::new(RwLock::new(FastMap8::default())),
};
let mut tenants = ret.tenants.write();
for (id, root) in context.pagecache.get_meta(&guard)?.tenants() {
let tree = Tree(Arc::new(TreeInner {
tree_id: id.clone(),
subscribers: Subscribers::default(),
context: context.clone(),
root: AtomicU64::new(root),
merge_operator: RwLock::new(None),
}));
assert!(tenants.insert(id, tree).is_none());
}
drop(tenants);
#[cfg(feature = "event_log")]
{
for (_name, tree) in ret.tenants.read().iter() {
tree.verify_integrity().unwrap();
}
ret.context.event_log.verify();
}
Ok(ret)
}
/// Open or create a new disk-backed Tree with its own keyspace,
/// accessible from the `Db` via the provided identifier.
pub fn open_tree<V: AsRef<[u8]>>(&self, name: V) -> Result<Tree> {
let name_ref = name.as_ref();
let tenants = self.tenants.read();
if let Some(tree) = tenants.get(name_ref) {
return Ok(tree.clone());
}
drop(tenants);
let guard = pin();
let mut tenants = self.tenants.write();
// we need to check this again in case another
// thread opened it concurrently.
if let Some(tree) = tenants.get(name_ref) {
return Ok(tree.clone());
}
let tree = meta::open_tree(&self.context, name_ref.to_vec(), &guard)?;
assert!(tenants.insert(name_ref.into(), tree.clone()).is_none());
Ok(tree)
}
/// Remove a disk-backed collection.
pub fn drop_tree<V: AsRef<[u8]>>(&self, name: V) -> Result<bool> {
let name_ref = name.as_ref();
if name_ref == DEFAULT_TREE_ID {
return Err(Error::Unsupported(
"cannot remove the core structures".into(),
));
}
trace!("dropping tree {:?}", name_ref,);
let mut tenants = self.tenants.write();
let tree = if let Some(tree) = tenants.remove(&*name_ref) {
tree
} else {
return Ok(false);
};
let guard = pin();
let mut root_id =
Some(self.context.pagecache.meta_pid_for_name(name_ref, &guard)?);
let mut leftmost_chain: Vec<PageId> = vec![root_id.unwrap()];
let mut cursor = root_id.unwrap();
while let Some(view) = self.view_for_pid(cursor, &guard)? {
if let Some(index) = view.data.index_ref() {
let leftmost_child = index.pointers[0];
leftmost_chain.push(leftmost_child);
cursor = leftmost_child;
} else {
break;
}
}
loop {
let res = self
.context
.pagecache
.cas_root_in_meta(name_ref, root_id, None, &guard)?;
if let Err(actual_root) = res {
root_id = actual_root;
} else {
break;
}
}
tree.root.store(u64::max_value(), SeqCst);
// drop writer lock
drop(tenants);
tree.gc_pages(leftmost_chain)?;
guard.flush();
Ok(true)
}
/// Returns the trees names saved in this Db.
pub fn tree_names(&self) -> Vec<IVec> {
let tenants = self.tenants.read();
tenants.iter().map(|(name, _)| name.clone()).collect()
}
/// Returns `true` if the database was
/// recovered from a previous process.
/// Note that database state is only
/// guaranteed to be present up to the
/// last call to `flush`! Otherwise state
/// is synced to disk periodically if the
/// `sync_every_ms` configuration option
/// is set to `Some(number_of_ms_between_syncs)`
/// or if the IO buffer gets filled to
/// capacity before being rotated.
pub fn was_recovered(&self) -> bool {
self.context.was_recovered()
}
/// Generate a monotonic ID. Not guaranteed to be
/// contiguous. Written to disk every `idgen_persist_interval`
/// operations, followed by a blocking flush. During recovery, we
/// take the last recovered generated ID and add 2x
/// the `idgen_persist_interval` to it. While persisting, if the
/// previous persisted counter wasn't synced to disk yet, we will do
/// a blocking flush to fsync the latest counter, ensuring
/// that we will never give out the same counter twice.
pub fn generate_id(&self) -> Result<u64> {
self.context.generate_id()
}
/// A database export method for all collections in the `Db`,
/// for use in sled version upgrades. Can be used in combination
/// with the `import` method below on a database running a later
/// version.
///
/// # Panics
///
/// Panics if any IO problems occur while trying
/// to perform the export.
///
/// # Examples
///
/// If you want to migrate from one version of sled
/// to another, you need to pull in both versions
/// by using version renaming:
///
/// `Cargo.toml`:
///
/// ```toml
/// [dependencies]
/// sled = "0.32"
/// old_sled = { version = "0.31", package = "sled" }
/// ```
///
/// and in your code, remember that old versions of
/// sled might have a different way to open them
/// than the current `sled::open` method:
///
/// ```
/// # use sled as old_sled;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let old = old_sled::open("my_old_db")?;
///
/// // may be a different version of sled,
/// // the export type is version agnostic.
/// let new = sled::open("my_new_db")?;
///
/// let export = old.export();
/// new.import(export);
///
/// assert_eq!(old.checksum()?, new.checksum()?);
/// # Ok(()) }
/// ```
pub fn export(
&self,
) -> Vec<(CollectionType, CollectionName, impl Iterator<Item = Vec<Vec<u8>>>)>
{
let tenants = self.tenants.read();
let mut ret = vec![];
for (name, tree) in tenants.iter() {
ret.push((
b"tree".to_vec(),
name.to_vec(),
tree.iter().map(|kv_opt| {
let kv = kv_opt.unwrap();
vec![kv.0.to_vec(), kv.1.to_vec()]
}),
));
}
ret
}
/// Imports the collections from a previous database.
///
/// # Panics
///
/// Panics if any IO problems occur while trying
/// to perform the import.
///
/// # Examples
///
/// If you want to migrate from one version of sled
/// to another, you need to pull in both versions
/// by using version renaming:
///
/// `Cargo.toml`:
///
/// ```toml
/// [dependencies]
/// sled = "0.32"
/// old_sled = { version = "0.31", package = "sled" }
/// ```
///
/// and in your code, remember that old versions of
/// sled might have a different way to open them
/// than the current `sled::open` method:
///
/// ```
/// # use sled as old_sled;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let old = old_sled::open("my_old_db")?;
///
/// // may be a different version of sled,
/// // the export type is version agnostic.
/// let new = sled::open("my_new_db")?;
///
/// let export = old.export();
/// new.import(export);
///
/// assert_eq!(old.checksum()?, new.checksum()?);
/// # Ok(()) }
/// ```
pub fn import(
&self,
export: Vec<(
CollectionType,
CollectionName,
impl Iterator<Item = Vec<Vec<u8>>>,
)>,
) {
for (collection_type, collection_name, collection_iter) in export {
match collection_type {
ref t if t == b"tree" => {
let tree = self
.open_tree(collection_name)
.expect("failed to open new tree during import");
for mut kv in collection_iter {
let v = kv
.pop()
.expect("failed to get value from tree export");
let k = kv
.pop()
.expect("failed to get key from tree export");
let old = tree.insert(k, v).expect(
"failed to insert value during tree import",
);
assert!(
old.is_none(),
"import is overwriting existing data"
);
}
}
other => panic!("unknown collection type {:?}", other),
}
}
}
/// Returns the CRC32 of all keys and values
/// in this Db.
///
/// This is O(N) and locks all underlying Trees
/// for the duration of the entire scan.
pub fn checksum(&self) -> Result<u32> {
let tenants_mu = self.tenants.write();
// we use a btreemap to ensure lexicographic
// iteration over tree names to have consistent
// checksums.
let tenants: BTreeMap<_, _> = tenants_mu.iter().collect();
let mut hasher = crc32fast::Hasher::new();
let mut locks = vec![];
locks.push(concurrency_control::write());
for (name, tree) in &tenants {
hasher.update(name);
let mut iter = tree.iter();
while let Some(kv_res) = iter.next_inner() {
let (k, v) = kv_res?;
hasher.update(&k);
hasher.update(&v);
}
}
Ok(hasher.finalize())
}
/// Returns the on-disk size of the storage files
/// for this database.
pub fn size_on_disk(&self) -> Result<u64> {
self.context.pagecache.size_on_disk()
}
/// Traverses all files and calculates their total physical
/// size, then traverses all pages and calculates their
/// total logical size, then divides the physical size
/// by the logical size.
#[doc(hidden)]
pub fn space_amplification(&self) -> Result<f64> {
self.context.pagecache.space_amplification()
}
}
/// These types provide the information that allows an entire
/// system to be exported and imported to facilitate
/// major upgrades. It is comprised entirely
/// of standard library types to be forward compatible.
/// NB this definitions are expensive to change, because
/// they impact the migration path.
type CollectionType = Vec<u8>;
type CollectionName = Vec<u8>;