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
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
//! Management of arrangements across dataflows.
use std::any::Any;
use std::collections::BTreeMap;
use std::rc::Rc;
use std::time::Instant;
use differential_dataflow::lattice::{antichain_join, Lattice};
use differential_dataflow::operators::arrange::ShutdownButton;
use differential_dataflow::trace::TraceReader;
use mz_repr::{Diff, GlobalId, Timestamp};
use timely::dataflow::operators::CapabilitySet;
use timely::dataflow::scopes::Child;
use timely::dataflow::Scope;
use timely::progress::frontier::{Antichain, AntichainRef};
use timely::progress::timestamp::Refines;
use crate::logging::compute::{LogImportFrontiers, Logger};
use crate::metrics::TraceMetrics;
use crate::render::context::SpecializedArrangementImport;
use crate::typedefs::{ErrAgent, RowAgent, RowRowAgent};
/// A `TraceManager` stores maps from global identifiers to the primary arranged
/// representation of that collection.
pub struct TraceManager {
pub(crate) traces: BTreeMap<GlobalId, TraceBundle>,
metrics: TraceMetrics,
}
impl TraceManager {
/// TODO(undocumented)
pub fn new(metrics: TraceMetrics) -> Self {
TraceManager {
traces: BTreeMap::new(),
metrics,
}
}
/// performs maintenance work on the managed traces.
///
/// In particular, this method enables the physical merging of batches, so that at most a logarithmic
/// number of batches need to be maintained. Any new batches introduced after this method is called
/// will not be physically merged until the method is called again. This is mostly due to limitations
/// of differential dataflow, which requires users to perform this explicitly; if that changes we may
/// be able to remove this code.
pub fn maintenance(&mut self) {
let start = Instant::now();
self.metrics.maintenance_active_info.set(1);
let mut antichain = Antichain::new();
for bundle in self.traces.values_mut() {
bundle.oks.read_upper(&mut antichain);
bundle.oks.set_physical_compaction(antichain.borrow());
bundle.errs.read_upper(&mut antichain);
bundle.errs.set_physical_compaction(antichain.borrow());
}
let duration = start.elapsed().as_secs_f64();
self.metrics.maintenance_seconds_total.inc_by(duration);
self.metrics.maintenance_active_info.set(0);
}
/// Enables compaction of traces associated with the identifier.
///
/// Compaction may not occur immediately, but once this method is called the
/// associated traces may not accumulate to the correct quantities for times
/// not in advance of `frontier`. Users should take care to only rely on
/// accumulations at times in advance of `frontier`.
pub fn allow_compaction(&mut self, id: GlobalId, frontier: AntichainRef<Timestamp>) {
if let Some(bundle) = self.traces.get_mut(&id) {
bundle.oks.set_logical_compaction(frontier);
bundle.errs.set_logical_compaction(frontier);
}
}
/// Returns a reference to the trace for `id`, should it exist.
pub fn get(&self, id: &GlobalId) -> Option<&TraceBundle> {
self.traces.get(id)
}
/// Returns a mutable reference to the trace for `id`, should it
/// exist.
pub fn get_mut(&mut self, id: &GlobalId) -> Option<&mut TraceBundle> {
self.traces.get_mut(id)
}
/// Binds the arrangement for `id` to `trace`.
pub fn set(&mut self, id: GlobalId, trace: TraceBundle) {
self.traces.insert(id, trace);
}
/// Removes the trace for `id`.
pub fn del_trace(&mut self, id: &GlobalId) -> bool {
self.traces.remove(id).is_some()
}
}
/// Represents a type-specialized trace handle for successful computations wherein keys or
/// values were previously type-specialized via `render::context::SpecializedArrangementFlavor`.
///
/// The variants defined here must thus match the ones used in creating type-specialized
/// arrangements.
#[derive(Clone)]
pub enum SpecializedTraceHandle {
RowUnit(RowAgent<Timestamp, Diff>),
RowRow(RowRowAgent<Timestamp, Diff>),
}
impl SpecializedTraceHandle {
/// Obtains the logical compaction frontier for the underlying trace handle.
fn get_logical_compaction(&mut self) -> AntichainRef<Timestamp> {
match self {
SpecializedTraceHandle::RowUnit(handle) => handle.get_logical_compaction(),
SpecializedTraceHandle::RowRow(handle) => handle.get_logical_compaction(),
}
}
/// Advances the logical compaction frontier for the underlying trace handle.
pub fn set_logical_compaction(&mut self, frontier: AntichainRef<Timestamp>) {
match self {
SpecializedTraceHandle::RowUnit(handle) => handle.set_logical_compaction(frontier),
SpecializedTraceHandle::RowRow(handle) => handle.set_logical_compaction(frontier),
}
}
/// Advances the physical compaction frontier for the underlying trace handle.
pub fn set_physical_compaction(&mut self, frontier: AntichainRef<Timestamp>) {
match self {
SpecializedTraceHandle::RowUnit(handle) => handle.set_physical_compaction(frontier),
SpecializedTraceHandle::RowRow(handle) => handle.set_physical_compaction(frontier),
}
}
/// Reads the upper frontier of the underlying trace handle.
pub fn read_upper(&mut self, target: &mut Antichain<Timestamp>) {
match self {
SpecializedTraceHandle::RowUnit(handle) => handle.read_upper(target),
SpecializedTraceHandle::RowRow(handle) => handle.read_upper(target),
}
}
/// Maps the underlying trace handle to a `SpecializedArrangementImport`,
/// while readjusting times by `since` and `until`.
pub fn import_frontier_logged<'g, G, T>(
&mut self,
scope: &Child<'g, G, T>,
name: &str,
since: Antichain<Timestamp>,
until: Antichain<Timestamp>,
logger: Option<Logger>,
idx_id: GlobalId,
export_ids: Vec<GlobalId>,
) -> (
SpecializedArrangementImport<Child<'g, G, T>, Timestamp>,
ShutdownButton<CapabilitySet<Timestamp>>,
)
where
G: Scope<Timestamp = Timestamp>,
T: Lattice + Refines<G::Timestamp>,
{
match self {
SpecializedTraceHandle::RowUnit(handle) => {
let (oks, oks_button) =
handle.import_frontier_core(&scope.parent, name, since, until);
let oks = if let Some(logger) = logger {
oks.log_import_frontiers(logger, idx_id, export_ids)
} else {
oks
};
(
SpecializedArrangementImport::RowUnit(oks.enter(scope)),
oks_button,
)
}
SpecializedTraceHandle::RowRow(handle) => {
let (oks, oks_button) =
handle.import_frontier_core(&scope.parent, name, since, until);
let oks = if let Some(logger) = logger {
oks.log_import_frontiers(logger, idx_id, export_ids)
} else {
oks
};
(
SpecializedArrangementImport::RowRow(oks.enter(scope)),
oks_button,
)
}
}
}
}
/// Bundles together traces for the successful computations (`oks`), the
/// failed computations (`errs`), additional tokens that should share
/// the lifetime of the bundled traces (`to_drop`).
#[derive(Clone)]
pub struct TraceBundle {
oks: SpecializedTraceHandle,
errs: ErrAgent<Timestamp, Diff>,
to_drop: Option<Rc<dyn Any>>,
}
impl TraceBundle {
/// Constructs a new trace bundle out of an `oks` trace and `errs` trace.
pub fn new(oks: SpecializedTraceHandle, errs: ErrAgent<Timestamp, Diff>) -> TraceBundle {
TraceBundle {
oks,
errs,
to_drop: None,
}
}
/// Adds tokens to be dropped when the trace bundle is dropped.
pub fn with_drop<T>(self, to_drop: T) -> TraceBundle
where
T: 'static,
{
TraceBundle {
to_drop: Some(Rc::new(Box::new(to_drop))),
..self
}
}
/// Returns a mutable reference to the `oks` trace.
pub fn oks_mut(&mut self) -> &mut SpecializedTraceHandle {
&mut self.oks
}
/// Returns a mutable reference to the `errs` trace.
pub fn errs_mut(&mut self) -> &mut ErrAgent<Timestamp, Diff> {
&mut self.errs
}
/// Returns a reference to the `to_drop` tokens.
pub fn to_drop(&self) -> &Option<Rc<dyn Any>> {
&self.to_drop
}
/// Returns the frontier up to which the traces have been allowed to compact.
pub fn compaction_frontier(&mut self) -> Antichain<Timestamp> {
antichain_join(
&self.oks.get_logical_compaction(),
&self.errs.get_logical_compaction(),
)
}
}