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
use quote::{quote_spanned, ToTokens};
use syn::parse_quote;
use super::{
OpInstGenerics, OperatorCategory, OperatorConstraints, OperatorInstance, OperatorWriteOutput,
Persistence, WriteContextArgs, RANGE_1,
};
use crate::diagnostic::{Diagnostic, Level};
/// > 2 input streams of type <(K, V1)> and <(K, V2)>, 1 output stream of type <(K, (V1, V2))>
///
/// Forms the equijoin of the tuples in the input streams by their first (key) attribute. Note that the result nests the 2nd input field (values) into a tuple in the 2nd output field.
///
/// ```dfir
/// source_iter(vec![("hello", "world"), ("stay", "gold"), ("hello", "world")]) -> [0]my_join;
/// source_iter(vec![("hello", "cleveland")]) -> [1]my_join;
/// my_join = join()
/// -> assert_eq([("hello", ("world", "cleveland"))]);
/// ```
///
/// `join` can also be provided with one or two generic lifetime persistence arguments, either
/// `'tick` or `'static`, to specify how join data persists. With `'tick`, pairs will only be
/// joined with corresponding pairs within the same tick. With `'static`, pairs will be remembered
/// across ticks and will be joined with pairs arriving in later ticks. When not explicitly
/// specified persistence defaults to `tick.
///
/// When two persistence arguments are supplied the first maps to port `0` and the second maps to
/// port `1`.
/// When a single persistence argument is supplied, it is applied to both input ports.
/// When no persistence arguments are applied it defaults to `'tick` for both.
///
/// The syntax is as follows:
/// ```dfir,ignore
/// join(); // Or
/// join::<'static>();
///
/// join::<'tick>();
///
/// join::<'static, 'tick>();
///
/// join::<'tick, 'static>();
/// // etc.
/// ```
///
/// `join` is defined to treat its inputs as *sets*, meaning that it
/// eliminates duplicated values in its inputs. If you do not want
/// duplicates eliminated, use the [`join_multiset`](#join_multiset) operator.
///
/// ### Examples
///
/// ```rustbook
/// let (input_send, input_recv) = dfir_rs::util::unbounded_channel::<(&str, &str)>();
/// let mut flow = dfir_rs::dfir_syntax! {
/// source_iter([("hello", "world")]) -> [0]my_join;
/// source_stream(input_recv) -> [1]my_join;
/// my_join = join::<'tick>() -> for_each(|(k, (v1, v2))| println!("({}, ({}, {}))", k, v1, v2));
/// };
/// input_send.send(("hello", "oakland")).unwrap();
/// flow.run_tick();
/// input_send.send(("hello", "san francisco")).unwrap();
/// flow.run_tick();
/// ```
/// Prints out `"(hello, (world, oakland))"` since `source_iter([("hello", "world")])` is only
/// included in the first tick, then forgotten.
///
/// ---
///
/// ```rustbook
/// let (input_send, input_recv) = dfir_rs::util::unbounded_channel::<(&str, &str)>();
/// let mut flow = dfir_rs::dfir_syntax! {
/// source_iter([("hello", "world")]) -> [0]my_join;
/// source_stream(input_recv) -> [1]my_join;
/// my_join = join::<'static>() -> for_each(|(k, (v1, v2))| println!("({}, ({}, {}))", k, v1, v2));
/// };
/// input_send.send(("hello", "oakland")).unwrap();
/// flow.run_tick();
/// input_send.send(("hello", "san francisco")).unwrap();
/// flow.run_tick();
/// ```
/// Prints out `"(hello, (world, oakland))"` and `"(hello, (world, san francisco))"` since the
/// inputs are peristed across ticks.
pub const JOIN: OperatorConstraints = OperatorConstraints {
name: "join",
categories: &[OperatorCategory::MultiIn],
hard_range_inn: &(2..=2),
soft_range_inn: &(2..=2),
hard_range_out: RANGE_1,
soft_range_out: RANGE_1,
num_args: 0,
persistence_args: &(0..=2),
type_args: &(0..=1),
is_external_input: false,
has_singleton_output: false,
flo_type: None,
ports_inn: Some(|| super::PortListSpec::Fixed(parse_quote! { 0, 1 })),
ports_out: None,
input_delaytype_fn: |_| None,
write_fn: |wc @ &WriteContextArgs {
root,
context,
hydroflow,
op_span,
ident,
inputs,
op_inst:
OperatorInstance {
generics:
OpInstGenerics {
persistence_args,
type_args,
..
},
..
},
..
},
diagnostics| {
let join_type =
type_args
.first()
.map(ToTokens::to_token_stream)
.unwrap_or(quote_spanned!(op_span=>
#root::compiled::pull::HalfSetJoinState
));
// TODO: This is really bad.
// This will break if the user aliases HalfSetJoinState to something else. Temporary hacky solution.
// Note that cross_join() depends on the implementation here as well.
let additional_trait_bounds = if join_type.to_string().contains("HalfSetJoinState") {
quote_spanned!(op_span=>
+ ::std::cmp::Eq
)
} else {
quote_spanned!(op_span=>)
};
let mut make_joindata = |persistence, side| {
let joindata_ident = wc.make_ident(format!("joindata_{}", side));
let borrow_ident = wc.make_ident(format!("joindata_{}_borrow", side));
let reset = match persistence {
Persistence::Tick => quote_spanned! {op_span=>
#hydroflow.set_state_tick_hook(#joindata_ident, |rcell| #root::util::clear::Clear::clear(rcell.get_mut()));
},
Persistence::Static => Default::default(),
Persistence::Mutable => {
diagnostics.push(Diagnostic::spanned(
op_span,
Level::Error,
"An implementation of 'mutable does not exist",
));
return Err(());
}
};
let init = quote_spanned! {op_span=>
let #joindata_ident = #hydroflow.add_state(::std::cell::RefCell::new(
#join_type::default()
));
#reset
};
Ok((joindata_ident, borrow_ident, init))
};
let persistences = match persistence_args[..] {
[] => [Persistence::Tick, Persistence::Tick],
[a] => [a, a],
[a, b] => [a, b],
_ => panic!(),
};
let (lhs_joindata_ident, lhs_borrow_ident, lhs_init) =
make_joindata(persistences[0], "lhs")?;
let (rhs_joindata_ident, rhs_borrow_ident, rhs_init) =
make_joindata(persistences[1], "rhs")?;
let write_prologue = quote_spanned! {op_span=>
#lhs_init
#rhs_init
};
let lhs = &inputs[0];
let rhs = &inputs[1];
let write_iterator = quote_spanned! {op_span=>
let mut #lhs_borrow_ident = #context.state_ref(#lhs_joindata_ident).borrow_mut();
let mut #rhs_borrow_ident = #context.state_ref(#rhs_joindata_ident).borrow_mut();
let #ident = {
// Limit error propagation by bounding locally, erasing output iterator type.
#[inline(always)]
fn check_inputs<'a, K, I1, V1, I2, V2>(
lhs: I1,
rhs: I2,
lhs_state: &'a mut #join_type<K, V1, V2>,
rhs_state: &'a mut #join_type<K, V2, V1>,
is_new_tick: bool,
) -> impl 'a + Iterator<Item = (K, (V1, V2))>
where
K: Eq + std::hash::Hash + Clone,
V1: Clone #additional_trait_bounds,
V2: Clone #additional_trait_bounds,
I1: 'a + Iterator<Item = (K, V1)>,
I2: 'a + Iterator<Item = (K, V2)>,
{
#root::compiled::pull::symmetric_hash_join_into_iter(lhs, rhs, lhs_state, rhs_state, is_new_tick)
}
check_inputs(#lhs, #rhs, &mut *#lhs_borrow_ident, &mut *#rhs_borrow_ident, #context.is_first_run_this_tick())
};
};
let write_iterator_after =
if persistences[0] == Persistence::Static || persistences[1] == Persistence::Static {
quote_spanned! {op_span=>
// TODO: Probably only need to schedule if #*_borrow.len() > 0?
#context.schedule_subgraph(#context.current_subgraph(), false);
}
} else {
quote_spanned! {op_span=>}
};
Ok(OperatorWriteOutput {
write_prologue,
write_iterator,
write_iterator_after,
})
},
};