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 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//! Worker-local state for compute timely instances.
use std::any::Any;
use std::cell::RefCell;
use std::collections::{BTreeMap, BTreeSet, VecDeque};
use std::num::NonZeroUsize;
use std::ops::DerefMut;
use std::rc::Rc;
use std::sync::{mpsc, Arc};
use std::time::{Duration, Instant};
use bytesize::ByteSize;
use differential_dataflow::operators::arrange::TraceAgent;
use differential_dataflow::trace::{Cursor, TraceReader};
use differential_dataflow::{Data, Hashable};
use mz_compute_client::logging::LoggingConfig;
use mz_compute_client::protocol::command::{
ComputeCommand, ComputeParameters, InstanceConfig, Peek, PeekTarget,
};
use mz_compute_client::protocol::history::ComputeCommandHistory;
use mz_compute_client::protocol::response::{
ComputeResponse, CopyToResponse, OperatorHydrationStatus, PeekResponse, StatusResponse,
SubscribeResponse,
};
use mz_compute_types::dataflows::DataflowDescription;
use mz_compute_types::dyncfgs::{ENABLE_CONTROLLER_DATAFLOW_SCHEDULING, HYDRATION_CONCURRENCY};
use mz_compute_types::plan::flat_plan::FlatPlan;
use mz_compute_types::plan::LirId;
use mz_dyncfg::ConfigSet;
use mz_expr::SafeMfpPlan;
use mz_ore::cast::CastFrom;
use mz_ore::metrics::UIntGauge;
use mz_ore::task::AbortOnDropHandle;
use mz_ore::tracing::{OpenTelemetryContext, TracingHandle};
use mz_persist_client::cache::PersistClientCache;
use mz_persist_client::read::ReadHandle;
use mz_persist_client::Diagnostics;
use mz_persist_txn::txn_cache::TxnsCache;
use mz_persist_types::codec_impls::UnitSchema;
use mz_repr::fixed_length::{FromRowByTypes, IntoRowByTypes};
use mz_repr::{ColumnType, DatumVec, Diff, GlobalId, Row, RowArena, Timestamp};
use mz_storage_operators::stats::StatsCursor;
use mz_storage_types::controller::CollectionMetadata;
use mz_storage_types::sources::SourceData;
use timely::communication::Allocate;
use timely::container::columnation::Columnation;
use timely::order::PartialOrder;
use timely::progress::frontier::Antichain;
use timely::scheduling::Scheduler;
use timely::worker::Worker as TimelyWorker;
use tokio::sync::oneshot;
use tracing::{debug, error, info, span, warn, Level};
use uuid::Uuid;
use crate::arrangement::manager::{SpecializedTraceHandle, TraceBundle, TraceManager};
use crate::logging;
use crate::logging::compute::ComputeEvent;
use crate::metrics::ComputeMetrics;
use crate::render::{LinearJoinSpec, StartSignal};
use crate::server::{ComputeInstanceContext, ResponseSender};
/// Worker-local state that is maintained across dataflows.
///
/// This state is restricted to the COMPUTE state, the deterministic, idempotent work
/// done between data ingress and egress.
pub struct ComputeState {
/// State kept for each installed compute collection.
///
/// Each collection has exactly one frontier.
/// How the frontier is communicated depends on the collection type:
/// * Frontiers of indexes are equal to the frontier of their corresponding traces in the
/// `TraceManager`.
/// * Persist sinks store their current frontier in `CollectionState::sink_write_frontier`.
/// * Subscribes report their frontiers through the `subscribe_response_buffer`.
pub collections: BTreeMap<GlobalId, CollectionState>,
/// Collections that were recently dropped and whose removal needs to be reported.
pub dropped_collections: Vec<GlobalId>,
/// The traces available for sharing across dataflows.
pub traces: TraceManager,
/// Shared buffer with SUBSCRIBE operator instances by which they can respond.
///
/// The entries are pairs of sink identifier (to identify the subscribe instance)
/// and the response itself.
pub subscribe_response_buffer: Rc<RefCell<Vec<(GlobalId, SubscribeResponse)>>>,
/// Shared buffer with S3 oneshot operator instances by which they can respond.
///
/// The entries are pairs of sink identifier (to identify the s3 oneshot instance)
/// and the response itself.
pub copy_to_response_buffer: Rc<RefCell<Vec<(GlobalId, CopyToResponse)>>>,
/// Peek commands that are awaiting fulfillment.
pub pending_peeks: BTreeMap<Uuid, PendingPeek>,
/// The logger, from Timely's logging framework, if logs are enabled.
pub compute_logger: Option<logging::compute::Logger>,
/// A process-global cache of (blob_uri, consensus_uri) -> PersistClient.
/// This is intentionally shared between workers.
pub persist_clients: Arc<PersistClientCache>,
/// History of commands received by this workers and all its peers.
pub command_history: ComputeCommandHistory<UIntGauge>,
/// Max size in bytes of any result.
max_result_size: u64,
/// Specification for rendering linear joins.
pub linear_join_spec: LinearJoinSpec,
/// Metrics for this replica.
pub metrics: ComputeMetrics,
/// A process-global handle to tracing configuration.
tracing_handle: Arc<TracingHandle>,
/// Other configuration for compute
pub context: ComputeInstanceContext,
/// Per-worker dynamic configuration.
///
/// This is separate from the process-global `ConfigSet` and contains config options that need
/// to be applied consistently with compute command order.
///
/// For example, for options that influence dataflow rendering it is important that all workers
/// render the same dataflow with the same options. If these options were stored in a global
/// `ConfigSet`, we couldn't guarantee that all workers observe changes to them at the same
/// point in the stream of compute commands. Storing per-worker configuration ensures that
/// because each worker's configuration is only updated once that worker observes the
/// respective `UpdateConfiguration` command.
pub worker_config: ConfigSet,
/// Receiver of operator hydration events.
pub hydration_rx: mpsc::Receiver<HydrationEvent>,
/// Transmitter of operator hydration events.
///
/// Copies of this sender are passed to the hydration logging operators.
pub hydration_tx: mpsc::Sender<HydrationEvent>,
/// Collections awaiting schedule instruction by the controller.
///
/// Each entry stores a reference to a token that can be dropped to unsuspend the collection's
/// dataflow. Multiple collections can reference the same token if they are exported by the
/// same dataflow.
waiting_collections: BTreeMap<GlobalId, Rc<Box<dyn Any>>>,
/// Collections in the process of hydrating.
hydrating_collections: BTreeSet<GlobalId>,
/// Queue of dataflows awaiting hydration.
///
/// Each entry is a dataflow ID and a token that can be dropped to unsuspend the dataflow.
hydration_queue: VecDeque<(usize, Box<dyn Any>)>,
}
impl ComputeState {
/// Construct a new `ComputeState`.
pub fn new(
worker_id: usize,
persist_clients: Arc<PersistClientCache>,
metrics: ComputeMetrics,
tracing_handle: Arc<TracingHandle>,
context: ComputeInstanceContext,
) -> Self {
let traces = TraceManager::new(metrics.for_traces(worker_id));
let command_history = ComputeCommandHistory::new(metrics.for_history(worker_id));
let (hydration_tx, hydration_rx) = mpsc::channel();
Self {
collections: Default::default(),
dropped_collections: Default::default(),
traces,
subscribe_response_buffer: Default::default(),
copy_to_response_buffer: Default::default(),
pending_peeks: Default::default(),
compute_logger: None,
persist_clients,
command_history,
max_result_size: u64::MAX,
linear_join_spec: Default::default(),
metrics,
tracing_handle,
context,
worker_config: mz_dyncfgs::all_dyncfgs(),
hydration_rx,
hydration_tx,
waiting_collections: Default::default(),
hydration_queue: Default::default(),
hydrating_collections: Default::default(),
}
}
/// Return whether a collection with the given ID exists.
pub fn collection_exists(&self, id: GlobalId) -> bool {
self.collections.contains_key(&id)
}
/// Return a reference to the identified collection.
///
/// Panics if the collection doesn't exist.
pub fn expect_collection(&self, id: GlobalId) -> &CollectionState {
self.collections.get(&id).expect("collection must exist")
}
/// Return a mutable reference to the identified collection.
///
/// Panics if the collection doesn't exist.
pub fn expect_collection_mut(&mut self, id: GlobalId) -> &mut CollectionState {
self.collections
.get_mut(&id)
.expect("collection must exist")
}
/// Apply the current `worker_config` to the compute state.
fn apply_worker_config(&mut self) {
use mz_compute_types::dyncfgs::*;
let config = &self.worker_config;
self.linear_join_spec = LinearJoinSpec::from_config(config);
if ENABLE_COLUMNATION_LGALLOC.get(config) {
if let Some(path) = &self.context.scratch_directory {
let eager_return = ENABLE_LGALLOC_EAGER_RECLAMATION.get(config);
let interval = LGALLOC_BACKGROUND_INTERVAL.get(config);
let clear_bytes = LGALLOC_SLOW_CLEAR_BYTES.get(config);
info!(
?path,
eager_return, backgrund_interval=?interval, clear_bytes, "enabling lgalloc"
);
let background_worker_config = lgalloc::BackgroundWorkerConfig {
interval,
clear_bytes,
};
lgalloc::lgalloc_set_config(
lgalloc::LgAlloc::new()
.enable()
.with_path(path.clone())
.with_background_config(background_worker_config)
.eager_return(eager_return),
);
} else {
debug!("not enabling lgalloc, scratch directory not specified");
}
} else {
info!("disabling lgalloc");
lgalloc::lgalloc_set_config(&lgalloc::LgAlloc::new())
}
let chunked_stack = ENABLE_CHUNKED_STACK.get(config);
info!("using chunked stack: {chunked_stack}");
crate::containers::stack::use_chunked_stack(chunked_stack);
}
/// Returns the cc or non-cc version of "dataflow_max_inflight_bytes", as
/// appropriate to this replica.
pub fn dataflow_max_inflight_bytes(&self) -> Option<usize> {
use mz_compute_types::dyncfgs::{
DATAFLOW_MAX_INFLIGHT_BYTES, DATAFLOW_MAX_INFLIGHT_BYTES_CC,
};
if self.persist_clients.cfg.is_cc_active {
DATAFLOW_MAX_INFLIGHT_BYTES_CC.get(&self.worker_config)
} else {
DATAFLOW_MAX_INFLIGHT_BYTES.get(&self.worker_config)
}
}
/// Check for completed hydration of dataflows and begin hydrating new ones if capacity is
/// available.
pub fn process_sequential_hydration(&mut self) {
self.hydrating_collections.retain(|id| {
let collection = self.collections.get(id).expect("must exist");
if collection.is_hydrated() {
info!(%id, "collection hydrated (or dropped)");
false
} else {
true
}
});
let capacity = HYDRATION_CONCURRENCY.get(&self.worker_config);
while self.hydrating_collections.len() < capacity {
let Some((dataflow_id, suspension_token)) = self.hydration_queue.pop_front() else {
break;
};
drop(suspension_token);
for (id, collection) in &self.collections {
if collection.dataflow_id == Some(dataflow_id) {
info!(?id, "collection hydration started");
self.hydrating_collections.insert(*id);
}
}
}
}
}
/// A wrapper around [ComputeState] with a live timely worker and response channel.
pub(crate) struct ActiveComputeState<'a, A: Allocate> {
/// The underlying Timely worker.
pub timely_worker: &'a mut TimelyWorker<A>,
/// The compute state itself.
pub compute_state: &'a mut ComputeState,
/// The channel over which frontier information is reported.
pub response_tx: &'a mut ResponseSender,
}
/// A token that keeps a sink alive.
pub struct SinkToken(Box<dyn Any>);
impl SinkToken {
/// Create a new `SinkToken`.
pub fn new(t: Box<dyn Any>) -> Self {
Self(t)
}
}
impl<'a, A: Allocate + 'static> ActiveComputeState<'a, A> {
/// Entrypoint for applying a compute command.
#[mz_ore::instrument(level = "debug")]
pub fn handle_compute_command(&mut self, cmd: ComputeCommand) {
use ComputeCommand::*;
self.compute_state.command_history.push(cmd.clone());
match cmd {
CreateTimely { .. } => panic!("CreateTimely must be captured before"),
CreateInstance(instance_config) => self.handle_create_instance(instance_config),
InitializationComplete => (),
UpdateConfiguration(params) => self.handle_update_configuration(params),
CreateDataflow(dataflow) => self.handle_create_dataflow(dataflow),
Schedule(id) => self.handle_schedule(id),
AllowCompaction { id, frontier } => self.handle_allow_compaction(id, frontier),
Peek(peek) => {
peek.otel_ctx.attach_as_parent();
self.handle_peek(peek)
}
CancelPeek { uuid } => self.handle_cancel_peek(uuid),
}
}
fn handle_create_instance(&mut self, config: InstanceConfig) {
// Ensure the state is consistent with the config before we initialize anything.
self.compute_state.apply_worker_config();
self.initialize_logging(&config.logging);
}
fn handle_update_configuration(&mut self, params: ComputeParameters) {
info!("Applying configuration update: {params:?}");
let ComputeParameters {
max_result_size,
tracing,
grpc_client: _grpc_client,
dyncfg_updates,
} = params;
if let Some(v) = max_result_size {
self.compute_state.max_result_size = v;
}
tracing.apply(self.compute_state.tracing_handle.as_ref());
dyncfg_updates.apply(&self.compute_state.worker_config);
dyncfg_updates.apply(&self.compute_state.persist_clients.cfg().configs);
self.compute_state.apply_worker_config();
}
fn handle_create_dataflow(
&mut self,
dataflow: DataflowDescription<FlatPlan, CollectionMetadata>,
) {
// Collect the exported object identifiers, paired with their associated "collection" identifier.
// The latter is used to extract dependency information, which is in terms of collections ids.
let dataflow_index = self.timely_worker.next_dataflow_index();
let as_of = dataflow.as_of.clone().unwrap();
if dataflow.is_transient() {
tracing::debug!(
name = %dataflow.debug_name,
import_ids = %dataflow.display_import_ids(),
export_ids = %dataflow.display_export_ids(),
as_of = ?as_of.elements(),
until = ?dataflow.until.elements(),
"creating dataflow",
);
} else {
tracing::info!(
name = %dataflow.debug_name,
import_ids = %dataflow.display_import_ids(),
export_ids = %dataflow.display_export_ids(),
as_of = ?as_of.elements(),
until = ?dataflow.until.elements(),
"creating dataflow",
);
};
// Initialize compute and logging state for each object.
for object_id in dataflow.export_ids() {
let mut collection = CollectionState::new();
collection.as_of = as_of.clone();
collection.dataflow_id = Some(dataflow_index);
collection.reported_frontier = ReportedFrontier::NotReported {
lower: as_of.clone(),
};
let existing = self.compute_state.collections.insert(object_id, collection);
if existing.is_some() {
error!(
id = ?object_id,
"existing collection for newly created dataflow",
);
}
// Log dataflow construction and frontier construction.
if let Some(logger) = self.compute_state.compute_logger.as_mut() {
logger.log(ComputeEvent::Export {
id: object_id,
dataflow_index,
});
logger.log(ComputeEvent::Frontier {
id: object_id,
time: timely::progress::Timestamp::minimum(),
diff: 1,
});
}
}
// Schedule transient dataflows immediately, under the assumption that they are created for
// interactive user queries. Suspend non-transient dataflows, to enforce the configured
// `hydration_concurrency`.
let (start_signal, suspension_token) = StartSignal::new();
if dataflow.is_transient() {
drop(suspension_token);
} else if !ENABLE_CONTROLLER_DATAFLOW_SCHEDULING.get(&self.compute_state.worker_config) {
drop(suspension_token);
} else {
let token = Rc::new(suspension_token);
for id in dataflow.export_ids() {
self.compute_state
.waiting_collections
.insert(id, Rc::clone(&token));
}
}
crate::render::build_compute_dataflow(
self.timely_worker,
self.compute_state,
dataflow,
start_signal,
);
}
fn handle_schedule(&mut self, id: GlobalId) {
// A `Schedule` command instructs us to begin dataflow computation for a collection, so
// we should unsuspend it by dropping the corresponding suspension token. Note that a
// dataflow can export multiple collections and they all share one suspension token, so the
// computation of a dataflow will only start once all its exported collections have been
// scheduled.
//
// Instead of immediately dropping the suspension token, we add it to the
// `hydration_queue`, to enforce the configured `hydration_concurrency`.
let Some(suspension_token) = self.compute_state.waiting_collections.remove(&id) else {
// During reconciliation we might reuse already running dataflows, for which we will
// then receive `Schedule` commands even though they are not suspended.
return;
};
let Some(suspension_token) = Rc::into_inner(suspension_token) else {
// The dataflow exports other collections that are still unscheduled.
return;
};
let collection = self.compute_state.expect_collection(id);
let dataflow_id = collection.dataflow_id.expect("must be known");
self.compute_state
.hydration_queue
.push_back((dataflow_id, suspension_token));
}
fn handle_allow_compaction(&mut self, id: GlobalId, frontier: Antichain<Timestamp>) {
if frontier.is_empty() {
// Indicates that we may drop `id`, as there are no more valid times to read.
self.drop_collection(id);
} else {
self.compute_state
.traces
.allow_compaction(id, frontier.borrow());
}
}
#[mz_ore::instrument(level = "debug")]
fn handle_peek(&mut self, peek: Peek) {
let pending = match &peek.target {
PeekTarget::Index { id } => {
// Acquire a copy of the trace suitable for fulfilling the peek.
let trace_bundle = self.compute_state.traces.get(id).unwrap().clone();
PendingPeek::index(peek, trace_bundle)
}
PeekTarget::Persist { metadata, .. } => {
let metadata = metadata.clone();
PendingPeek::persist(
peek,
Arc::clone(&self.compute_state.persist_clients),
metadata,
usize::cast_from(self.compute_state.max_result_size),
self.timely_worker,
)
}
};
// Log the receipt of the peek.
if let Some(logger) = self.compute_state.compute_logger.as_mut() {
logger.log(pending.as_log_event(true));
}
self.process_peek(&mut Antichain::new(), pending);
}
fn handle_cancel_peek(&mut self, uuid: Uuid) {
if let Some(peek) = self.compute_state.pending_peeks.remove(&uuid) {
self.send_peek_response(peek, PeekResponse::Canceled);
}
}
fn drop_collection(&mut self, id: GlobalId) {
let collection = self
.compute_state
.collections
.remove(&id)
.expect("dropped untracked collection");
// If this collection is an index, remove its trace.
self.compute_state.traces.del_trace(&id);
// Remove scheduling and hydration tracking state.
self.compute_state.waiting_collections.remove(&id);
self.compute_state.hydrating_collections.remove(&id);
// Remove frontier logging.
if let Some(logger) = self.compute_state.compute_logger.as_mut() {
logger.log(ComputeEvent::ExportDropped { id });
if let Some(time) = collection.reported_frontier.logging_time() {
logger.log(ComputeEvent::Frontier { id, time, diff: -1 });
}
}
// We need to emit a final response reporting the dropping of this collection,
// unless:
// * The collection is a subscribe, in which case we will emit a
// `SubscribeResponse::Dropped` independently.
// * The collection has already advanced to the empty frontier, in which case
// the final `FrontierUpper` response already serves the purpose of reporting
// the end of the dataflow.
if !collection.is_subscribe() && !collection.reported_frontier.is_empty() {
self.compute_state.dropped_collections.push(id);
}
}
/// Initializes timely dataflow logging and publishes as a view.
pub fn initialize_logging(&mut self, config: &LoggingConfig) {
if self.compute_state.compute_logger.is_some() {
panic!("dataflow server has already initialized logging");
}
let (logger, traces) = logging::initialize(self.timely_worker, config);
// Install traces as maintained indexes
for (log, trace) in traces {
let id = config.index_logs[&log];
self.compute_state.traces.set(id, trace);
}
// Initialize compute and logging state for each logging index.
let index_ids = config.index_logs.values().copied();
for id in index_ids {
let collection = CollectionState::new();
let existing = self.compute_state.collections.insert(id, collection);
if existing.is_some() {
error!(
id = ?id,
"existing collection for newly initialized logging export",
);
}
logger.log(ComputeEvent::Frontier {
id,
time: timely::progress::Timestamp::minimum(),
diff: 1,
});
}
self.compute_state.compute_logger = Some(logger);
}
/// Send progress information to the coordinator.
pub fn report_compute_frontiers(&mut self) {
let mut new_uppers = Vec::new();
// Maintain a single allocation for `new_frontier` to avoid allocating on every iteration.
let mut new_frontier = Antichain::new();
for (&id, collection) in self.compute_state.collections.iter_mut() {
new_frontier.clear();
if let Some(traces) = self.compute_state.traces.get_mut(&id) {
assert!(
collection.sink_write_frontier.is_none(),
"collection {id} has multiple frontiers"
);
traces.oks_mut().read_upper(&mut new_frontier);
} else if let Some(frontier) = &collection.sink_write_frontier {
new_frontier.clone_from(&frontier.borrow());
} else {
// Subscribe frontiers are reported in `process_subscribes` instead.
if !collection.is_subscribe() {
error!(id = ?id, "collection without frontier");
}
continue;
}
match &collection.reported_frontier {
ReportedFrontier::Reported(old_frontier) => {
// In steady state it is not expected for `old_frontier` to be beyond
// `new_frontier`. However, during reconcilation this can happen as we
// artificially advance the frontiers of to-be-dropped collections to disable
// frontier reporting for them.
if !PartialOrder::less_than(old_frontier, &new_frontier) {
continue; // nothing new to report
}
}
ReportedFrontier::NotReported { lower } => {
if !PartialOrder::less_equal(lower, &new_frontier) {
continue; // lower bound for reporting not yet reached
}
}
}
let new_reported_frontier = ReportedFrontier::Reported(new_frontier.clone());
if let Some(logger) = self.compute_state.compute_logger.as_mut() {
if let Some(time) = collection.reported_frontier.logging_time() {
logger.log(ComputeEvent::Frontier { id, time, diff: -1 });
}
if let Some(time) = new_reported_frontier.logging_time() {
logger.log(ComputeEvent::Frontier { id, time, diff: 1 });
}
}
new_uppers.push((id, new_frontier.clone()));
collection.reported_frontier = new_reported_frontier;
}
for (id, upper) in new_uppers {
self.send_compute_response(ComputeResponse::FrontierUpper { id, upper });
}
}
/// Report dropped collections to the controller.
pub fn report_dropped_collections(&mut self) {
let dropped_collections = std::mem::take(&mut self.compute_state.dropped_collections);
// TODO(#16275): It is, in fact, wrong to report the dropping of a collection before it has
// advanced to the empty frontier by announcing that it has advanced to the empty
// frontier. We should introduce a new compute response variant that has the right
// semantics.
for id in dropped_collections {
// Sanity check: A collection that was dropped should not exist.
assert!(
!self.compute_state.collection_exists(id),
"tried to report a dropped collection that still exists: {id}"
);
self.send_compute_response(ComputeResponse::FrontierUpper {
id,
upper: Antichain::new(),
});
}
}
/// Report operator hydration events.
pub fn report_operator_hydration(&mut self) {
let worker_id = self.timely_worker.index();
for event in self.compute_state.hydration_rx.try_iter() {
// The compute protocol forbids reporting `Status` about collections that have advanced
// to the empty frontier, so we ignore updates for those.
let collection = self.compute_state.collections.get(&event.export_id);
if collection.map_or(true, |c| c.reported_frontier.is_empty()) {
continue;
}
let status = OperatorHydrationStatus {
collection_id: event.export_id,
lir_id: event.lir_id,
worker_id,
hydrated: event.hydrated,
};
let response = ComputeResponse::Status(StatusResponse::OperatorHydration(status));
self.send_compute_response(response);
}
}
/// Either complete the peek (and send the response) or put it in the pending set.
fn process_peek(&mut self, upper: &mut Antichain<Timestamp>, mut peek: PendingPeek) {
let response = match &mut peek {
PendingPeek::Index(peek) => {
peek.seek_fulfillment(upper, self.compute_state.max_result_size)
}
PendingPeek::Persist(peek) => peek.result.try_recv().ok().map(|(result, duration)| {
self.compute_state
.metrics
.persist_peek_seconds
.observe(duration.as_secs_f64());
result
}),
};
if let Some(response) = response {
let _span = span!(parent: peek.span(), Level::DEBUG, "process_peek").entered();
self.send_peek_response(peek, response)
} else {
let uuid = peek.peek().uuid;
self.compute_state.pending_peeks.insert(uuid, peek);
}
}
/// Scan pending peeks and attempt to retire each.
pub fn process_peeks(&mut self) {
let mut upper = Antichain::new();
let pending_peeks = std::mem::take(&mut self.compute_state.pending_peeks);
for (_uuid, peek) in pending_peeks {
self.process_peek(&mut upper, peek);
}
}
/// Sends a response for this peek's resolution to the coordinator.
///
/// Note that this function takes ownership of the `PendingPeek`, which is
/// meant to prevent multiple responses to the same peek.
#[mz_ore::instrument(level = "debug")]
fn send_peek_response(&mut self, peek: PendingPeek, response: PeekResponse) {
let log_event = peek.as_log_event(false);
// Respond with the response.
self.send_compute_response(ComputeResponse::PeekResponse(
peek.peek().uuid,
response,
OpenTelemetryContext::obtain(),
));
// Log responding to the peek request.
if let Some(logger) = self.compute_state.compute_logger.as_mut() {
logger.log(log_event);
}
}
/// Scan the shared subscribe response buffer, and forward results along.
pub fn process_subscribes(&mut self) {
let mut subscribe_responses = self.compute_state.subscribe_response_buffer.borrow_mut();
for (sink_id, mut response) in subscribe_responses.drain(..) {
// Update frontier logging for this subscribe.
if let Some(collection) = self.compute_state.collections.get_mut(&sink_id) {
let new_frontier = match &response {
SubscribeResponse::Batch(b) => b.upper.clone(),
SubscribeResponse::DroppedAt(_) => Antichain::new(),
};
match &collection.reported_frontier {
ReportedFrontier::Reported(old_frontier) => {
assert!(
PartialOrder::less_than(old_frontier, &new_frontier),
"new frontier {new_frontier:?} is not beyond \
old frontier {old_frontier:?}"
);
}
ReportedFrontier::NotReported { lower } => {
assert!(
PartialOrder::less_equal(lower, &new_frontier),
"new frontier {new_frontier:?} is before lower bound {lower:?}"
);
}
}
let new_reported_frontier = ReportedFrontier::Reported(new_frontier);
if let Some(logger) = self.compute_state.compute_logger.as_mut() {
if let Some(time) = collection.reported_frontier.logging_time() {
logger.log(ComputeEvent::Frontier {
id: sink_id,
time,
diff: -1,
});
}
if let Some(time) = new_reported_frontier.logging_time() {
logger.log(ComputeEvent::Frontier {
id: sink_id,
time,
diff: 1,
});
}
}
collection.reported_frontier = new_reported_frontier;
} else {
// Presumably tracking state for this subscribe was already dropped by
// `drop_collection`. There is nothing left to do for logging.
}
response
.to_error_if_exceeds(usize::try_from(self.compute_state.max_result_size).unwrap());
self.send_compute_response(ComputeResponse::SubscribeResponse(sink_id, response));
}
}
/// Scan the shared copy to response buffer, and forward results along.
pub fn process_copy_tos(&mut self) {
let mut responses = self.compute_state.copy_to_response_buffer.borrow_mut();
for (sink_id, response) in responses.drain(..) {
self.send_compute_response(ComputeResponse::CopyToResponse(sink_id, response));
}
}
/// Send a response to the coordinator.
fn send_compute_response(&self, response: ComputeResponse) {
// Ignore send errors because the coordinator is free to ignore our
// responses. This happens during shutdown.
let _ = self.response_tx.send(response);
}
}
/// A peek against either an index or a Persist collection.
///
/// Note that `PendingPeek` intentionally does not implement or derive `Clone`,
/// as each `PendingPeek` is meant to be dropped after it's responded to.
pub enum PendingPeek {
/// A peek against an index. (Possibly a temporary index created for the purpose.)
Index(IndexPeek),
/// A peek against a Persist-backed collection.
Persist(PersistPeek),
}
impl PendingPeek {
/// Produces a corresponding log event.
pub fn as_log_event(&self, installed: bool) -> ComputeEvent {
let peek = self.peek();
let peek_type = match self {
PendingPeek::Index(_) => logging::compute::PeekType::Index,
PendingPeek::Persist(_) => logging::compute::PeekType::Persist,
};
ComputeEvent::Peek {
peek: logging::compute::Peek::new(peek.target.id(), peek.timestamp, peek.uuid),
peek_type,
installed,
}
}
fn index(peek: Peek, mut trace_bundle: TraceBundle) -> Self {
let empty_frontier = Antichain::new();
let timestamp_frontier = Antichain::from_elem(peek.timestamp);
trace_bundle
.oks_mut()
.set_logical_compaction(timestamp_frontier.borrow());
trace_bundle
.errs_mut()
.set_logical_compaction(timestamp_frontier.borrow());
trace_bundle
.oks_mut()
.set_physical_compaction(empty_frontier.borrow());
trace_bundle
.errs_mut()
.set_physical_compaction(empty_frontier.borrow());
PendingPeek::Index(IndexPeek {
peek,
trace_bundle,
span: tracing::Span::current(),
})
}
fn persist<A: Allocate>(
peek: Peek,
persist_clients: Arc<PersistClientCache>,
metadata: CollectionMetadata,
max_result_size: usize,
timely_worker: &mut TimelyWorker<A>,
) -> Self {
let active_worker = {
// Choose the worker that does the actual peek arbitrarily but consistently.
let chosen_index = usize::cast_from(peek.uuid.hashed()) % timely_worker.peers();
chosen_index == timely_worker.index()
};
let activator = timely_worker.sync_activator_for(&[]);
let peek_uuid = peek.uuid;
let (result_tx, result_rx) = oneshot::channel();
let timestamp = peek.timestamp;
let mfp_plan = peek.map_filter_project.clone();
let max_results_needed = peek
.finishing
.limit
.map(|l| usize::cast_from(u64::from(l)))
.unwrap_or(usize::MAX)
+ peek.finishing.offset;
let task_handle = mz_ore::task::spawn(|| "persist::peek", async move {
let start = Instant::now();
let result = if active_worker {
PersistPeek::do_peek(
&persist_clients,
metadata,
timestamp,
mfp_plan,
max_result_size,
max_results_needed,
)
.await
} else {
Ok(vec![])
};
let result = match result {
Ok(rows) => PeekResponse::Rows(rows),
Err(e) => PeekResponse::Error(e.to_string()),
};
match result_tx.send((result, start.elapsed())) {
Ok(()) => {}
Err((_result, elapsed)) => {
debug!(duration =? elapsed, "dropping result for cancelled peek {peek_uuid}")
}
}
match activator.activate() {
Ok(()) => {}
Err(_) => {
debug!("unable to wake timely after completed peek {peek_uuid}");
}
}
});
PendingPeek::Persist(PersistPeek {
peek,
_abort_handle: task_handle.abort_on_drop(),
result: result_rx,
span: tracing::Span::current(),
})
}
fn span(&self) -> &tracing::Span {
match self {
PendingPeek::Index(p) => &p.span,
PendingPeek::Persist(p) => &p.span,
}
}
pub(crate) fn peek(&self) -> &Peek {
match self {
PendingPeek::Index(p) => &p.peek,
PendingPeek::Persist(p) => &p.peek,
}
}
}
/// An in-progress Persist peek.
///
/// Note that `PendingPeek` intentionally does not implement or derive `Clone`,
/// as each `PendingPeek` is meant to be dropped after it's responded to.
pub struct PersistPeek {
pub(crate) peek: Peek,
/// A background task that's responsible for producing the peek results.
/// If we're no longer interested in the results, we abort the task.
_abort_handle: AbortOnDropHandle<()>,
/// The result of the background task, eventually.
result: oneshot::Receiver<(PeekResponse, Duration)>,
/// The `tracing::Span` tracking this peek's operation
span: tracing::Span,
}
impl PersistPeek {
async fn do_peek(
persist_clients: &PersistClientCache,
metadata: CollectionMetadata,
as_of: Timestamp,
mfp_plan: SafeMfpPlan,
max_result_size: usize,
mut limit_remaining: usize,
) -> Result<Vec<(Row, NonZeroUsize)>, String> {
let client = persist_clients
.open(metadata.persist_location)
.await
.map_err(|e| e.to_string())?;
let mut reader: ReadHandle<SourceData, (), Timestamp, Diff> = client
.open_leased_reader(
metadata.data_shard,
Arc::new(metadata.relation_desc.clone()),
Arc::new(UnitSchema),
Diagnostics::from_purpose("persist::peek"),
)
.await
.map_err(|e| e.to_string())?;
// If we are using persist-txn for this collection, then the upper might
// be advanced lazily and we have to go through persist-txn for reads.
//
// TODO: If/when we have a process-wide TxnsRead worker for clusterd,
// use in here (instead of opening a new TxnsCache) to save a persist
// reader registration and some txns shard read traffic.
let mut txns_read = if let Some(txns_id) = metadata.txns_shard {
Some(TxnsCache::open(&client, txns_id, Some(metadata.data_shard)).await)
} else {
None
};
let metrics = client.metrics();
let mut cursor = StatsCursor::new(
&mut reader,
txns_read.as_mut(),
metrics,
&metadata.relation_desc,
Antichain::from_elem(as_of),
)
.await
.map_err(|since| {
format!("attempted to peek at {as_of}, but the since has advanced to {since:?}")
})?;
// Re-used state for processing and building rows.
let mut result = vec![];
let mut datum_vec = DatumVec::new();
let mut row_builder = Row::default();
let arena = RowArena::new();
let mut total_size = 0usize;
while limit_remaining > 0 {
let Some(batch) = cursor.next().await else {
break;
};
for (data, _, d) in batch {
let row = data.map_err(|e| e.to_string())?;
let count: usize = d.try_into().map_err(|_| {
format!(
"Invalid data in source, saw retractions ({}) for row that does not exist: {:?}",
d * -1,
row,
)
})?;
let Some(count) = NonZeroUsize::new(count) else {
continue;
};
let mut datum_local = datum_vec.borrow_with(&row);
let eval_result = mfp_plan
.evaluate_into(&mut datum_local, &arena, &mut row_builder)
.map_err(|e| e.to_string())?;
if let Some(row) = eval_result {
total_size = total_size
.saturating_add(row.byte_len())
.saturating_add(std::mem::size_of::<NonZeroUsize>());
if total_size > max_result_size {
return Err(format!(
"result exceeds max size of {}",
ByteSize::b(u64::cast_from(max_result_size))
));
}
result.push((row, count));
limit_remaining = limit_remaining.saturating_sub(count.get());
if limit_remaining == 0 {
break;
}
}
}
}
Ok(result)
}
}
/// An in-progress index-backed peek, and data to eventually fulfill it.
pub struct IndexPeek {
peek: Peek,
/// The data from which the trace derives.
trace_bundle: TraceBundle,
/// The `tracing::Span` tracking this peek's operation
span: tracing::Span,
}
impl IndexPeek {
/// Attempts to fulfill the peek and reports success.
///
/// To produce output at `peek.timestamp`, we must be certain that
/// it is no longer changing. A trace guarantees that all future
/// changes will be greater than or equal to an element of `upper`.
///
/// If an element of `upper` is less or equal to `peek.timestamp`,
/// then there can be further updates that would change the output.
/// If no element of `upper` is less or equal to `peek.timestamp`,
/// then for any time `t` less or equal to `peek.timestamp` it is
/// not the case that `upper` is less or equal to that timestamp,
/// and so the result cannot further evolve.
fn seek_fulfillment(
&mut self,
upper: &mut Antichain<Timestamp>,
max_result_size: u64,
) -> Option<PeekResponse> {
self.trace_bundle.oks_mut().read_upper(upper);
if upper.less_equal(&self.peek.timestamp) {
return None;
}
self.trace_bundle.errs_mut().read_upper(upper);
if upper.less_equal(&self.peek.timestamp) {
return None;
}
let read_frontier = self.trace_bundle.compaction_frontier();
if !read_frontier.less_equal(&self.peek.timestamp) {
let error = format!(
"Arrangement compaction frontier ({:?}) is beyond the time of the attempted read ({})",
read_frontier.elements(),
self.peek.timestamp,
);
return Some(PeekResponse::Error(error));
}
let response = match self.collect_finished_data(max_result_size) {
Ok(rows) => PeekResponse::Rows(rows),
Err(text) => PeekResponse::Error(text),
};
Some(response)
}
/// Collects data for a known-complete peek from the ok stream.
fn collect_finished_data(
&mut self,
max_result_size: u64,
) -> Result<Vec<(Row, NonZeroUsize)>, String> {
// Check if there exist any errors and, if so, return whatever one we
// find first.
let (mut cursor, storage) = self.trace_bundle.errs_mut().cursor();
while cursor.key_valid(&storage) {
let mut copies = 0;
cursor.map_times(&storage, |time, diff| {
if time.less_equal(&self.peek.timestamp) {
copies += diff;
}
});
if copies < 0 {
return Err(format!(
"Invalid data in source errors, saw retractions ({}) for row that does not exist: {}",
copies * -1,
cursor.key(&storage),
));
}
if copies > 0 {
return Err(cursor.key(&storage).to_string());
}
cursor.step_key(&storage);
}
self.dispatch_collect_ok_finished_data(max_result_size)
}
/// Dispatches peek finishing of data in the ok stream according to
/// arrangement key-value types.
fn dispatch_collect_ok_finished_data(
&mut self,
max_result_size: u64,
) -> Result<Vec<(Row, NonZeroUsize)>, String> {
let peek = &mut self.peek;
let oks = self.trace_bundle.oks_mut();
match oks {
SpecializedTraceHandle::RowUnit(oks_handle) => {
// Explicit types required due to Rust type inference limitations.
use crate::typedefs::RowSpine;
Self::collect_ok_finished_data::<RowSpine<_, _>>(
peek,
oks_handle,
None,
max_result_size,
)
}
SpecializedTraceHandle::RowRow(oks_handle) => {
// Explicit types required due to Rust type inference limitations.
use crate::typedefs::RowRowSpine;
Self::collect_ok_finished_data::<RowRowSpine<_, _>>(
peek,
oks_handle,
None,
max_result_size,
)
}
}
}
/// Collects data for a known-complete peek from the ok stream.
fn collect_ok_finished_data<Tr>(
peek: &mut Peek<Timestamp>,
oks_handle: &mut TraceAgent<Tr>,
key_types: Option<&[ColumnType]>,
max_result_size: u64,
) -> Result<Vec<(Row, NonZeroUsize)>, String>
where
Tr: TraceReader<Time = Timestamp, Diff = Diff>,
for<'a> Tr::Key<'a>: IntoRowByTypes,
for<'a> Tr::Val<'a>: IntoRowByTypes,
Tr::KeyOwned: Columnation + Data + FromRowByTypes + IntoRowByTypes,
Tr::ValOwned: Columnation + Data + IntoRowByTypes,
{
let max_result_size = usize::cast_from(max_result_size);
let count_byte_size = std::mem::size_of::<NonZeroUsize>();
// Cursor and bound lifetime for `Row` data in the backing trace.
let (mut cursor, storage) = oks_handle.cursor();
// Accumulated `Vec<(row, count)>` results that we are likely to return.
let mut results = Vec::new();
let mut total_size: usize = 0;
// When set, a bound on the number of records we need to return.
// The requirements on the records are driven by the finishing's
// `order_by` field. Further limiting will happen when the results
// are collected, so we don't need to have exactly this many results,
// just at least those results that would have been returned.
let max_results = peek
.finishing
.limit
.map(|l| usize::cast_from(u64::from(l)) + peek.finishing.offset);
use mz_ore::result::ResultExt;
let mut row_builder = Row::default();
let mut datum_vec = DatumVec::new();
let mut l_datum_vec = DatumVec::new();
let mut r_datum_vec = DatumVec::new();
let mut key_buf = Tr::KeyOwned::default();
// We have to sort the literal constraints because cursor.seek_key can seek only forward.
peek.literal_constraints
.iter_mut()
.for_each(|vec| vec.sort());
let has_literal_constraints = peek.literal_constraints.is_some();
let mut literals = peek.literal_constraints.iter().flat_map(|l| l);
let mut current_literal = None;
while cursor.key_valid(&storage) {
if has_literal_constraints {
loop {
// Go to the next literal constraint.
// (i.e., to the next OR argument in something like `c=3 OR c=7 OR c=9`)
current_literal = literals.next();
match current_literal {
None => return Ok(results),
Some(current_literal) => {
// NOTE(vmarcos): We expect the extra allocations below to be manageable
// since we only perform as many of them as there are literals.
let current_literal =
key_buf.from_row(current_literal.clone(), key_types);
cursor.seek_key_owned(&storage, ¤t_literal);
if !cursor.key_valid(&storage) {
return Ok(results);
}
use differential_dataflow::trace::cursor::MyTrait;
if cursor.get_key(&storage).unwrap().equals(¤t_literal) {
// The cursor found a record whose key matches the current literal.
// We break from the inner loop, and process this key.
break;
}
// The cursor landed on a record that has a different key, meaning that there is
// no record whose key would match the current literal.
}
}
}
}
while cursor.val_valid(&storage) {
// TODO: This arena could be maintained and reused for longer,
// but it wasn't clear at what interval we should flush
// it to ensure we don't accidentally spike our memory use.
// This choice is conservative, and not the end of the world
// from a performance perspective.
let arena = RowArena::new();
let key_item = cursor.key(&storage);
let key = key_item.into_datum_iter();
let row_item = cursor.val(&storage);
let row = row_item.into_datum_iter();
let mut borrow = datum_vec.borrow();
borrow.extend(key);
borrow.extend(row);
if has_literal_constraints {
// The peek was created from an IndexedFilter join. We have to add those columns
// here that the join would add in a dataflow.
let datum_vec = borrow.deref_mut();
// unwrap is ok, because it could be None only if !has_literal_constraints or if
// the iteration is finished. In the latter case we already exited the while
// loop.
datum_vec.extend(current_literal.unwrap().iter());
}
if let Some(result) = peek
.map_filter_project
.evaluate_into(&mut borrow, &arena, &mut row_builder)
.map_err_to_string_with_causes()?
{
let mut copies = 0;
cursor.map_times(&storage, |time, diff| {
if time.less_equal(&peek.timestamp) {
copies += diff;
}
});
let copies: usize = if copies < 0 {
return Err(format!(
"Invalid data in source, saw retractions ({}) for row that does not exist: {:?}",
copies * -1,
&*borrow,
));
} else {
copies.try_into().unwrap()
};
// if copies > 0 ... otherwise skip
if let Some(copies) = NonZeroUsize::new(copies) {
total_size = total_size
.saturating_add(result.byte_len())
.saturating_add(count_byte_size);
if total_size > max_result_size {
return Err(format!(
"result exceeds max size of {}",
ByteSize::b(u64::cast_from(max_result_size))
));
}
results.push((result, copies));
}
// If we hold many more than `max_results` records, we can thin down
// `results` using `self.finishing.ordering`.
if let Some(max_results) = max_results {
// We use a threshold twice what we intend, to amortize the work
// across all of the insertions. We could tighten this, but it
// works for the moment.
if results.len() >= 2 * max_results {
if peek.finishing.order_by.is_empty() {
results.truncate(max_results);
return Ok(results);
} else {
// We can sort `results` and then truncate to `max_results`.
// This has an effect similar to a priority queue, without
// its interactive dequeueing properties.
// TODO: Had we left these as `Vec<Datum>` we would avoid
// the unpacking; we should consider doing that, although
// it will require a re-pivot of the code to branch on this
// inner test (as we prefer not to maintain `Vec<Datum>`
// in the other case).
results.sort_by(|left, right| {
let left_datums = l_datum_vec.borrow_with(&left.0);
let right_datums = r_datum_vec.borrow_with(&right.0);
mz_expr::compare_columns(
&peek.finishing.order_by,
&left_datums,
&right_datums,
|| left.0.cmp(&right.0),
)
});
let dropped = results.drain(max_results..);
let dropped_size =
dropped.into_iter().fold(0, |acc: usize, (row, _count)| {
acc.saturating_add(
row.byte_len().saturating_add(count_byte_size),
)
});
total_size = total_size.saturating_sub(dropped_size);
}
}
}
}
cursor.step_val(&storage);
}
// The cursor doesn't have anything more to say for the current key.
if !has_literal_constraints {
// We are simply stepping through all the keys that the index has.
cursor.step_key(&storage);
}
}
Ok(results)
}
}
/// A frontier we have reported to the controller, or the least frontier we are allowed to report.
#[derive(Debug)]
pub enum ReportedFrontier {
/// A frontier has been previously reported.
Reported(Antichain<Timestamp>),
/// No frontier has been reported yet.
NotReported {
/// A lower bound for frontiers that may be reported in the future.
lower: Antichain<Timestamp>,
},
}
impl ReportedFrontier {
/// Create a new `ReportedFrontier` enforcing the minimum lower bound.
pub fn new() -> Self {
let lower = Antichain::from_elem(timely::progress::Timestamp::minimum());
Self::NotReported { lower }
}
/// Whether the reported frontier is the empty frontier.
pub fn is_empty(&self) -> bool {
match self {
Self::Reported(frontier) => frontier.is_empty(),
Self::NotReported { .. } => false,
}
}
/// Return a timestamp suitable for logging the reported frontier.
pub fn logging_time(&self) -> Option<Timestamp> {
match self {
Self::Reported(frontier) => frontier.get(0).copied(),
Self::NotReported { .. } => Some(timely::progress::Timestamp::minimum()),
}
}
}
/// State maintained for a compute collection.
pub struct CollectionState {
/// The initial as-of frontier.
as_of: Antichain<Timestamp>,
/// The ID of the dataflow maintaining this collection.
///
/// `None` if the dataflow ID is unknown, which is the case for logging collections.
dataflow_id: Option<usize>,
/// Tracks the frontier that has been reported to the controller.
pub reported_frontier: ReportedFrontier,
/// A token that should be dropped when this collection is dropped to clean up associated
/// sink state.
///
/// Only `Some` if the collection is a sink.
pub sink_token: Option<SinkToken>,
/// Frontier of sink writes.
///
/// Only `Some` if the collection is a sink and *not* a subscribe.
pub sink_write_frontier: Option<Rc<RefCell<Antichain<Timestamp>>>>,
}
impl CollectionState {
fn new() -> Self {
Self {
as_of: Antichain::from_elem(Timestamp::MIN),
dataflow_id: None,
reported_frontier: ReportedFrontier::new(),
sink_token: None,
sink_write_frontier: None,
}
}
fn is_subscribe(&self) -> bool {
self.sink_token.is_some() && self.sink_write_frontier.is_none()
}
fn is_hydrated(&self) -> bool {
match &self.reported_frontier {
ReportedFrontier::Reported(frontier) => PartialOrder::less_than(&self.as_of, frontier),
ReportedFrontier::NotReported { .. } => false,
}
}
}
/// An event reporting the hydration status of an LIR node in a dataflow.
pub struct HydrationEvent {
/// The ID of the export this dataflow maintains.
pub export_id: GlobalId,
/// The ID of the LIR node.
pub lir_id: LirId,
/// Whether the node is hydrated.
pub hydrated: bool,
}