garage/src/model/object_table.rs

257 lines
6.4 KiB
Rust
Raw Normal View History

use serde::{Deserialize, Serialize};
2020-07-08 15:33:14 +00:00
use std::collections::BTreeMap;
2020-07-08 15:34:37 +00:00
use std::sync::Arc;
2020-04-09 15:32:28 +00:00
2020-04-24 10:10:01 +00:00
use garage_util::background::BackgroundRunner;
use garage_util::data::*;
2020-04-23 17:05:46 +00:00
use garage_table::crdt::*;
2021-03-26 18:41:46 +00:00
use garage_table::replication::TableShardedReplication;
2020-04-24 10:10:01 +00:00
use garage_table::*;
2020-04-24 10:10:01 +00:00
use crate::version_table::*;
2020-04-09 15:32:28 +00:00
2021-03-26 20:53:28 +00:00
/// An object
2020-04-09 21:45:07 +00:00
#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
2020-04-09 15:32:28 +00:00
pub struct Object {
2021-04-06 03:25:28 +00:00
/// The bucket in which the object is stored, used as partition key
2020-04-09 15:32:28 +00:00
pub bucket: String,
2020-04-09 21:45:07 +00:00
2021-04-06 03:25:28 +00:00
/// The key at which the object is stored in its bucket, used as sorting key
2020-04-09 15:32:28 +00:00
pub key: String,
2021-04-06 03:25:28 +00:00
/// The list of currenty stored versions of the object
versions: Vec<ObjectVersion>,
}
impl Object {
2021-04-08 13:13:02 +00:00
/// Initialize an Object struct from parts
pub fn new(bucket: String, key: String, versions: Vec<ObjectVersion>) -> Self {
let mut ret = Self {
bucket,
key,
versions: vec![],
};
for v in versions {
ret.add_version(v)
.expect("Twice the same ObjectVersion in Object constructor");
}
ret
}
2021-03-26 20:53:28 +00:00
/// Adds a version if it wasn't already present
2021-04-23 19:57:32 +00:00
#[allow(clippy::result_unit_err)]
pub fn add_version(&mut self, new: ObjectVersion) -> Result<(), ()> {
match self
.versions
.binary_search_by(|v| v.cmp_key().cmp(&new.cmp_key()))
{
Err(i) => {
self.versions.insert(i, new);
Ok(())
}
Ok(_) => Err(()),
}
}
2021-03-26 20:53:28 +00:00
2021-04-06 03:25:28 +00:00
/// Get a list of currently stored versions of `Object`
pub fn versions(&self) -> &[ObjectVersion] {
&self.versions[..]
}
2020-04-09 15:32:28 +00:00
}
2021-03-26 20:53:28 +00:00
/// Informations about a version of an object
2020-04-09 21:45:07 +00:00
#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
pub struct ObjectVersion {
2021-03-26 20:53:28 +00:00
/// Id of the version
2020-04-09 15:32:28 +00:00
pub uuid: UUID,
2021-03-26 20:53:28 +00:00
/// Timestamp of when the object was created
2020-04-09 15:32:28 +00:00
pub timestamp: u64,
2021-03-26 20:53:28 +00:00
/// State of the version
2020-04-26 18:55:13 +00:00
pub state: ObjectVersionState,
2020-04-09 15:32:28 +00:00
}
2021-03-26 20:53:28 +00:00
/// State of an object version
#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)]
2020-04-26 18:55:13 +00:00
pub enum ObjectVersionState {
2021-03-26 20:53:28 +00:00
/// The version is being received
2020-07-08 15:33:14 +00:00
Uploading(ObjectVersionHeaders),
2021-03-26 20:53:28 +00:00
/// The version is fully received
Complete(ObjectVersionData),
2021-04-06 03:25:28 +00:00
/// The version uploaded containded errors or the upload was explicitly aborted
2020-04-26 18:55:13 +00:00
Aborted,
}
impl CRDT for ObjectVersionState {
fn merge(&mut self, other: &Self) {
2020-04-26 18:55:13 +00:00
use ObjectVersionState::*;
2020-07-08 15:34:37 +00:00
match other {
Aborted => {
*self = Aborted;
}
Complete(b) => match self {
Aborted => {}
Complete(a) => {
a.merge(b);
}
Uploading(_) => {
*self = Complete(b.clone());
}
},
Uploading(_) => {}
}
2020-04-26 18:55:13 +00:00
}
}
2021-04-08 13:13:02 +00:00
/// Data stored in object version
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug, Serialize, Deserialize)]
2020-04-09 21:45:07 +00:00
pub enum ObjectVersionData {
2021-04-06 03:25:28 +00:00
/// The object was deleted, this Version is a tombstone to mark it as such
2020-04-09 15:32:28 +00:00
DeleteMarker,
2021-03-26 20:53:28 +00:00
/// The object is short, it's stored inlined
Inline(ObjectVersionMeta, #[serde(with = "serde_bytes")] Vec<u8>),
2021-03-26 20:53:28 +00:00
/// The object is not short, Hash of first block is stored here, next segments hashes are
/// stored in the version table
FirstBlock(ObjectVersionMeta, Hash),
}
impl AutoCRDT for ObjectVersionData {
const WARN_IF_DIFFERENT: bool = true;
}
2021-03-26 20:53:28 +00:00
/// Metadata about the object version
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug, Serialize, Deserialize)]
pub struct ObjectVersionMeta {
2021-03-26 20:53:28 +00:00
/// Headers to send to the client
2020-07-08 15:34:37 +00:00
pub headers: ObjectVersionHeaders,
2021-03-26 20:53:28 +00:00
/// Size of the object
pub size: u64,
2021-03-26 20:53:28 +00:00
/// etag of the object
2020-07-08 15:34:37 +00:00
pub etag: String,
}
2021-03-26 20:53:28 +00:00
/// Additional headers for an object
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug, Serialize, Deserialize)]
2020-07-08 15:33:14 +00:00
pub struct ObjectVersionHeaders {
2021-03-26 20:53:28 +00:00
/// Content type of the object
2020-07-08 15:34:37 +00:00
pub content_type: String,
2021-03-26 20:53:28 +00:00
/// Any other http headers to send
2020-07-08 15:34:37 +00:00
pub other: BTreeMap<String, String>,
2020-07-08 15:33:14 +00:00
}
impl ObjectVersion {
2020-04-26 18:55:13 +00:00
fn cmp_key(&self) -> (u64, UUID) {
(self.timestamp, self.uuid)
}
2021-03-26 20:53:28 +00:00
/// Is the object version currently being uploaded
2020-07-08 15:34:37 +00:00
pub fn is_uploading(&self) -> bool {
2021-04-23 19:57:32 +00:00
matches!(self.state, ObjectVersionState::Uploading(_))
2020-07-08 15:34:37 +00:00
}
2021-03-26 20:53:28 +00:00
/// Is the object version completely received
2020-04-26 18:55:13 +00:00
pub fn is_complete(&self) -> bool {
2021-04-23 19:57:32 +00:00
matches!(self.state, ObjectVersionState::Complete(_))
2020-04-26 18:55:13 +00:00
}
2021-03-26 20:53:28 +00:00
2021-04-06 03:25:28 +00:00
/// Is the object version available (received and not a tombstone)
2020-04-26 18:55:13 +00:00
pub fn is_data(&self) -> bool {
2020-07-08 15:34:37 +00:00
match self.state {
ObjectVersionState::Complete(ObjectVersionData::DeleteMarker) => false,
ObjectVersionState::Complete(_) => true,
_ => false,
}
}
}
2020-04-09 15:32:28 +00:00
impl Entry<String, String> for Object {
fn partition_key(&self) -> &String {
&self.bucket
}
fn sort_key(&self) -> &String {
&self.key
}
2021-03-16 15:51:15 +00:00
fn is_tombstone(&self) -> bool {
self.versions.len() == 1
&& self.versions[0].state
== ObjectVersionState::Complete(ObjectVersionData::DeleteMarker)
2021-03-16 15:51:15 +00:00
}
}
2020-04-09 15:32:28 +00:00
impl CRDT for Object {
2020-04-09 21:45:07 +00:00
fn merge(&mut self, other: &Self) {
// Merge versions from other into here
2020-04-09 15:32:28 +00:00
for other_v in other.versions.iter() {
match self
.versions
.binary_search_by(|v| v.cmp_key().cmp(&other_v.cmp_key()))
{
2020-04-09 15:32:28 +00:00
Ok(i) => {
2020-07-08 15:34:37 +00:00
self.versions[i].state.merge(&other_v.state);
2020-04-09 15:32:28 +00:00
}
Err(i) => {
self.versions.insert(i, other_v.clone());
}
}
}
// Remove versions which are obsolete, i.e. those that come
// before the last version which .is_complete().
let last_complete = self
.versions
.iter()
.enumerate()
.rev()
2021-04-23 19:57:32 +00:00
.find(|(_, v)| v.is_complete())
2020-04-09 15:32:28 +00:00
.map(|(vi, _)| vi);
if let Some(last_vi) = last_complete {
self.versions = self.versions.drain(last_vi..).collect::<Vec<_>>();
}
}
}
2020-04-09 21:45:07 +00:00
pub struct ObjectTable {
2020-04-12 11:03:55 +00:00
pub background: Arc<BackgroundRunner>,
pub version_table: Arc<Table<VersionTable, TableShardedReplication>>,
2020-04-09 21:45:07 +00:00
}
2020-04-12 20:24:53 +00:00
impl TableSchema for ObjectTable {
2020-04-09 15:32:28 +00:00
type P = String;
type S = String;
type E = Object;
type Filter = DeletedFilter;
2020-04-09 15:32:28 +00:00
fn updated(&self, old: Option<Self::E>, new: Option<Self::E>) {
2020-04-12 11:03:55 +00:00
let version_table = self.version_table.clone();
self.background.spawn(async move {
if let (Some(old_v), Some(new_v)) = (old, new) {
// Propagate deletion of old versions
for v in old_v.versions.iter() {
let newly_deleted = match new_v
.versions
.binary_search_by(|nv| nv.cmp_key().cmp(&v.cmp_key()))
{
Err(_) => true,
Ok(i) => {
new_v.versions[i].state == ObjectVersionState::Aborted
&& v.state != ObjectVersionState::Aborted
}
};
if newly_deleted {
let deleted_version =
Version::new(v.uuid, old_v.bucket.clone(), old_v.key.clone(), true);
version_table.insert(&deleted_version).await?;
2020-04-26 18:59:17 +00:00
}
}
}
Ok(())
})
2020-04-09 15:32:28 +00:00
}
fn matches_filter(entry: &Self::E, filter: &Self::Filter) -> bool {
let deleted = !entry.versions.iter().any(|v| v.is_data());
filter.apply(deleted)
}
}