kanidmd_lib/repl/entry.rs
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
use super::cid::Cid;
use crate::be::dbrepl::DbEntryChangeState;
use crate::be::dbvalue::DbCidV1;
use crate::entry::Eattrs;
use crate::prelude::*;
use crate::schema::SchemaTransaction;
use std::collections::BTreeMap;
#[derive(Debug, Clone)]
pub enum State {
Live {
at: Cid,
changes: BTreeMap<Attribute, Cid>,
},
Tombstone {
at: Cid,
},
}
#[derive(Debug, Clone)]
pub struct EntryChangeState {
pub(super) st: State,
}
impl EntryChangeState {
pub fn new(cid: &Cid, attrs: &Eattrs, _schema: &dyn SchemaTransaction) -> Self {
let changes = attrs
.keys()
.cloned()
.map(|attr| (attr, cid.clone()))
.collect();
let st = State::Live {
at: cid.clone(),
changes,
};
EntryChangeState { st }
}
pub fn new_without_schema(cid: &Cid, attrs: &Eattrs) -> Self {
let class = attrs.get(&Attribute::Class);
let st = if class
.as_ref()
.map(|c| c.contains(&EntryClass::Tombstone.to_partialvalue()))
.unwrap_or(false)
{
State::Tombstone { at: cid.clone() }
} else {
let changes = attrs
.keys()
.cloned()
.map(|attr| (attr, cid.clone()))
.collect();
State::Live {
at: cid.clone(),
changes,
}
};
EntryChangeState { st }
}
pub(crate) fn to_db_changestate(&self) -> DbEntryChangeState {
match &self.st {
State::Live { at, changes } => {
let at = DbCidV1 {
server_id: at.s_uuid,
timestamp: at.ts,
};
let changes = changes
.iter()
.map(|(attr, cid)| {
(
attr.clone(),
DbCidV1 {
server_id: cid.s_uuid,
timestamp: cid.ts,
},
)
})
.collect();
DbEntryChangeState::V1Live { at, changes }
}
State::Tombstone { at } => {
let at = DbCidV1 {
server_id: at.s_uuid,
timestamp: at.ts,
};
DbEntryChangeState::V1Tombstone { at }
}
}
}
pub(crate) fn from_db_changestate(db_ecstate: DbEntryChangeState) -> Self {
match db_ecstate {
DbEntryChangeState::V1Live { at, changes } => {
let at = Cid {
s_uuid: at.server_id,
ts: at.timestamp,
};
let changes = changes
.iter()
.map(|(attr, cid)| {
(
attr.clone(),
Cid {
s_uuid: cid.server_id,
ts: cid.timestamp,
},
)
})
.collect();
EntryChangeState {
st: State::Live { at, changes },
}
}
DbEntryChangeState::V1Tombstone { at } => EntryChangeState {
st: State::Tombstone {
at: Cid {
s_uuid: at.server_id,
ts: at.timestamp,
},
},
},
}
}
pub(crate) fn build(st: State) -> Self {
EntryChangeState { st }
}
pub fn current(&self) -> &State {
&self.st
}
pub fn at(&self) -> &Cid {
match &self.st {
State::Live { at, .. } => at,
State::Tombstone { at } => at,
}
}
pub(crate) fn stub(&self) -> Self {
let st = match &self.st {
State::Live { at, changes: _ } => State::Live {
at: at.clone(),
changes: Default::default(),
},
State::Tombstone { at } => State::Tombstone { at: at.clone() },
};
EntryChangeState { st }
}
pub fn change_ava(&mut self, cid: &Cid, attr: &Attribute) {
match &mut self.st {
State::Live {
at: _,
ref mut changes,
} => {
if let Some(change) = changes.get_mut(attr) {
// Update the cid.
if change != cid {
*change = cid.clone()
}
} else {
changes.insert(attr.clone(), cid.clone());
}
}
State::Tombstone { .. } => {
unreachable!();
}
}
}
pub fn tombstone(&mut self, cid: &Cid) {
match &mut self.st {
State::Live { at: _, changes: _ } => self.st = State::Tombstone { at: cid.clone() },
State::Tombstone { .. } => {} // no-op
};
}
pub fn can_delete(&self, cid: &Cid) -> bool {
match &self.st {
State::Live { .. } => false,
State::Tombstone { at } => at < cid,
}
}
pub fn is_live(&self) -> bool {
match &self.st {
State::Live { .. } => true,
State::Tombstone { .. } => false,
}
}
pub fn contains_tail_cid(&self, cid: &Cid) -> bool {
// This is slow? Is it needed?
match &self.st {
State::Live { at: _, changes } => changes.values().any(|change| change == cid),
State::Tombstone { at } => at == cid,
}
}
pub(crate) fn get_max_cid(&self) -> &Cid {
match &self.st {
State::Live { at, changes } => changes.values().max().unwrap_or(at),
State::Tombstone { at } => at,
}
}
#[cfg(test)]
pub(crate) fn get_attr_cid(&self, attr: Attribute) -> Option<&Cid> {
match &self.st {
State::Live { at: _, changes } => changes.get(&attr),
State::Tombstone { at: _ } => None,
}
}
pub(crate) fn cid_iter(&self) -> Vec<&Cid> {
match &self.st {
State::Live { at: _, changes } => {
let mut v: Vec<_> = changes.values().collect();
v.sort_unstable();
v.dedup();
v
}
State::Tombstone { at } => vec![at],
}
}
pub fn retain<F>(&mut self, f: F)
where
F: FnMut(&Attribute, &mut Cid) -> bool,
{
match &mut self.st {
State::Live { at: _, changes } => changes.retain(f),
State::Tombstone { .. } => {}
}
}
#[instrument(level = "trace", name = "verify", skip_all)]
pub fn verify(
&self,
schema: &dyn SchemaTransaction,
expected_attrs: &Eattrs,
entry_id: u64,
results: &mut Vec<Result<(), ConsistencyError>>,
) {
let class = expected_attrs.get(&Attribute::Class);
let is_ts = class
.as_ref()
.map(|c| c.contains(&EntryClass::Tombstone.to_partialvalue()))
.unwrap_or(false);
match (&self.st, is_ts) {
(State::Live { at, changes }, false) => {
// Every change must be after at.
// Check that all attrs from expected, have a value in our changes.
let inconsistent: Vec<_> = expected_attrs
.keys()
.filter(|attr| {
/*
* If the attribute is a replicated attribute, and it is NOT present
* in the change state then we are in a desync state.
*
* However, we don't check the inverse - if an entry is in the change state
* but is NOT replicated by schema. This is because there is is a way to
* delete an attribute in schema which will then prevent future replications
* of that value. However the value, while not being updated, will retain
* a state entry in the change state.
*
* For the entry to then be replicated once more, it would require it's schema
* attributes to be re-added and then the replication will resume from whatever
* receives the changes first. Generally there are lots of desync and edge
* cases here, which is why we pretty much don't allow schema to be deleted
* but we have to handle it here due to a test case that simulates this.
*/
let change_cid_present = if let Some(change_cid) = changes.get(*attr) {
if change_cid < at {
warn!("changestate has a change that occurs before entry was created! {attr:?} {change_cid:?} {at:?}");
results.push(Err(ConsistencyError::ChangeStateDesynchronised(entry_id)));
}
true
} else {
false
};
// Only assert this when we actually have replication requirements.
let desync = schema.is_replicated(attr) && !change_cid_present;
if desync {
debug!(%entry_id, %attr, %desync);
}
desync
})
.collect();
if inconsistent.is_empty() {
trace!("changestate is synchronised");
} else {
warn!("changestate has desynchronised! Missing state attrs {inconsistent:?}");
results.push(Err(ConsistencyError::ChangeStateDesynchronised(entry_id)));
}
}
(State::Tombstone { .. }, true) => {
trace!("changestate is synchronised");
}
(State::Live { .. }, true) => {
warn!("changestate has desynchronised! State Live when tombstone is true");
results.push(Err(ConsistencyError::ChangeStateDesynchronised(entry_id)));
}
(State::Tombstone { .. }, false) => {
warn!("changestate has desynchronised! State Tombstone when tombstone is false");
results.push(Err(ConsistencyError::ChangeStateDesynchronised(entry_id)));
}
}
}
}
impl PartialEq for EntryChangeState {
fn eq(&self, rhs: &Self) -> bool {
match (&self.st, &rhs.st) {
(
State::Live {
at: at_left,
changes: changes_left,
},
State::Live {
at: at_right,
changes: changes_right,
},
) => at_left.eq(at_right) && changes_left.eq(changes_right),
(State::Tombstone { at: at_left }, State::Tombstone { at: at_right }) => {
at_left.eq(at_right)
}
(_, _) => false,
}
}
}