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
use std::any::{type_name, Any};
use std::collections::HashMap;
use std::fmt::{Display, Formatter};
use std::future::Future;
use std::num::NonZeroUsize;
use std::panic;
use std::pin::Pin;
use std::sync::Arc;
use tokio::select;
use tokio::sync::mpsc::Sender;
use tokio::sync::Mutex;
use tokio::task::{yield_now, JoinError, JoinSet};
pub use builder::*;
use io::{PipeReader, PipeWriter};
use sync::Synchronizer;
mod builder;
mod io;
mod sync;
mod workers;
const DEFAULT_MAX_TASK_COUNT: usize = 100;
const DEFAULT_READER_BUFFER_SIZE: usize = 30;
/// Options that can be passed to methods in the [PipelineBuilder] when defining stages.
///
/// This implements [Default] which makes it easier to specify options when defining stages.
/// By default, each worker will be allowed 100 concurrent tasks maximum and the buffer of each pipe
/// is set to 30.
///
/// # Examples
///
/// ```
/// use async_pipes::{Pipeline, WorkerOptions};
///
/// #[tokio::main]
/// async fn main() {
/// let pipeline = Pipeline::builder()
/// .with_inputs("Pipe", vec![()])
/// .with_consumer("Pipe", WorkerOptions::default(), |_: ()| async move {
/// /* ... */
/// })
/// .build();
///
/// assert!(pipeline.is_ok());
/// }
/// ```
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub struct WorkerOptions {
/// The maximum number of items allowed per pipe before stages have to wait to write
/// more data to the pipe.
pub pipe_buffer_size: usize,
/// The maximum number of tasks that a worker can be concurrently running. Once this number
/// is reached in a worker, the worker will poll for tasks completions before spawning more.
pub max_task_count: usize,
}
impl Default for WorkerOptions {
fn default() -> Self {
Self::default_multi_task()
}
}
impl WorkerOptions {
/// Like the [Default] implementation, but specifies `1` for [WorkerOptions::max_task_count].
pub fn default_single_task() -> Self {
Self {
max_task_count: 1,
..Default::default()
}
}
/// Specifies `100` for [WorkerOptions::max_task_count] and `30` for
/// [WorkerOptions::pipe_buffer_size].
pub fn default_multi_task() -> Self {
Self {
max_task_count: DEFAULT_MAX_TASK_COUNT,
pipe_buffer_size: DEFAULT_READER_BUFFER_SIZE,
}
}
}
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
struct ValidWorkerOptions {
reader_buffer_size: NonZeroUsize,
max_task_count: NonZeroUsize,
}
impl TryFrom<WorkerOptions> for ValidWorkerOptions {
type Error = String;
fn try_from(value: WorkerOptions) -> Result<Self, Self::Error> {
Ok(Self {
reader_buffer_size: NonZeroUsize::new(value.pipe_buffer_size)
.ok_or("reader buffer size must not be zero")?,
max_task_count: NonZeroUsize::new(value.max_task_count)
.ok_or("max task count must not be zero")?,
})
}
}
/// A Box that can hold any value that is [Send].
///
/// Values sent through pipes are trait objects of this type.
///
/// This type is publicly exposed as it's needed when building a pipeline stage with multiple
/// outputs. Since each output could have a different type, it's more feasible to define the
/// outputs to use dynamic dispatching rather that static dispatching.
///
/// # Examples
///
/// Here's an example of a closure representing the task function given to the pipeline builder
/// when creating a "branching" stage. Three outputs are returned, each of a different type.
/// ```
/// use async_pipes::branch;
///
/// #[tokio::main]
/// async fn main() {
/// let task = |value: String| async move {
/// let length: usize = value.len();
/// let excited: String = format!("{}!", value);
/// let odd_length: bool = length % 2 == 1;
///
/// Some(branch![length, excited, odd_length])
/// };
///
/// // E.g.:
/// // ...
/// // .with_branching_stage("pipe_in", vec!["pipe_len", "pipe_excited", "pipe_odd"], <task>)
/// // ...
///
/// let mut results = task("hello".to_string()).await.unwrap();
///
/// let length = results.remove(0).unwrap().downcast::<usize>().unwrap();
/// let excited = results.remove(0).unwrap().downcast::<String>().unwrap();
/// let odd_length = results.remove(0).unwrap().downcast::<bool>().unwrap();
///
/// assert_eq!(*length, 5usize);
/// assert_eq!(*excited, "hello!".to_string());
/// assert_eq!(*odd_length, true);
/// }
/// ```
pub type BoxedAnySend = Box<dyn Any + Send + 'static>;
type ProducerFn = Box<dyn FnMut() -> TaskFuture + Send + 'static>;
type TaskFn = Box<dyn Fn(BoxedAnySend) -> TaskFuture + Send + Sync + 'static>;
type IterCastFn = Box<dyn Fn(BoxedAnySend) -> Vec<BoxedAnySend> + Send + Sync + 'static>;
type TaskFuture = Pin<Box<dyn Future<Output = Option<Vec<Option<BoxedAnySend>>>> + Send + 'static>>;
enum Stage {
Producer {
function: ProducerFn,
pipes: ProducerPipeNames,
},
Regular {
function: TaskFn,
pipes: TaskPipeNames,
options: WorkerOptions,
},
Iterator {
stage_type: IterStageType,
caster: IterCastFn,
pipes: TaskPipeNames,
options: WorkerOptions,
},
}
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
struct ProducerPipeNames {
writers: Vec<String>,
}
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
struct TaskPipeNames {
reader: String,
writers: Vec<String>,
}
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
enum IterStageType {
Flatten,
}
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
struct PipeConfig {
name: String,
options: ValidWorkerOptions,
}
#[derive(Debug)]
struct Pipe<T> {
/// Use an option here to "take" it when a reader is used.
/// Only allow one reader per pipe.
reader: Option<PipeReader<T>>,
writer: PipeWriter<T>,
}
/// Signals sent to stage workers.
///
/// Useful for interrupting the natural workflow to tell it something.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
enum StageWorkerSignal {
/// Used to tell stage workers to finish immediately without waiting for remaining tasks to end.
Terminate,
}
impl Display for StageWorkerSignal {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let signal = match self {
Self::Terminate => "Terminate",
};
write!(f, "{signal}")
}
}
/// A pipeline provides the infrastructure for managing a set of workers that run user-defined
/// "tasks" on data going through the pipes.
///
/// # Examples
///
/// Creating a single producer and a single consumer.
/// ```
/// use std::sync::Arc;
/// use std::sync::atomic::{AtomicUsize, Ordering};
/// use std::sync::atomic::Ordering::{Acquire, SeqCst};
/// use tokio::sync::Mutex;
/// use async_pipes::Pipeline;
///
/// #[tokio::main]
/// async fn main() {
/// use async_pipes::WorkerOptions;
/// let count = Arc::new(Mutex::new(0usize));
///
/// let sum = Arc::new(AtomicUsize::new(0));
/// let task_sum = sum.clone();
///
/// Pipeline::builder()
/// // Produce values 1 through 10
/// .with_producer("data", move || {
/// let count = count.clone();
/// async move {
/// let mut count = count.lock().await;
/// if *count < 10 {
/// *count += 1;
/// Some(*count)
/// } else {
/// None
/// }
/// }
/// })
/// .with_consumer("data", WorkerOptions::default_single_task(), move |value: usize| {
/// let sum = task_sum.clone();
/// async move {
/// sum.fetch_add(value, SeqCst);
/// }
/// })
/// .build()
/// .expect("failed to build pipeline")
/// .wait()
/// .await;
///
/// assert_eq!(sum.load(Acquire), 55);
/// }
/// ```
///
/// Creating a branching producer and two consumers for each branch.
/// ```
/// use std::sync::Arc;
/// use std::sync::atomic::{AtomicUsize, Ordering};
/// use std::sync::atomic::Ordering::Acquire;
/// use tokio::sync::Mutex;
/// use async_pipes::{branch, NoOutput, Pipeline};
///
/// #[tokio::main]
/// async fn main() {
/// use async_pipes::WorkerOptions;
/// let count = Arc::new(Mutex::new(0usize));
///
/// let odds_sum = Arc::new(AtomicUsize::new(0));
/// let task_odds_sum = odds_sum.clone();
///
/// let evens_sum = Arc::new(AtomicUsize::new(0));
/// let task_evens_sum = evens_sum.clone();
///
/// Pipeline::builder()
/// .with_branching_producer(vec!["evens", "odds"], move || {
/// let c = count.clone();
/// async move {
/// let mut c = c.lock().await;
/// if *c >= 10 {
/// return None;
/// }
/// *c += 1;
///
/// let result = if *c % 2 == 0 {
/// branch![*c, NoOutput]
/// } else {
/// branch![NoOutput, *c]
/// };
/// Some(result)
/// }
/// })
/// .with_consumer("odds", WorkerOptions::default_single_task(), move |n: usize| {
/// let odds_sum = task_odds_sum.clone();
/// async move {
/// odds_sum.fetch_add(n, Ordering::SeqCst);
/// }
/// })
/// .with_consumer("evens", WorkerOptions::default_single_task(), move |n: usize| {
/// let evens_sum = task_evens_sum.clone();
/// async move {
/// evens_sum.fetch_add(n, Ordering::SeqCst);
/// }
/// })
/// .build()
/// .expect("failed to build pipeline!")
/// .wait()
/// .await;
///
/// assert_eq!(odds_sum.load(Acquire), 25);
/// assert_eq!(evens_sum.load(Acquire), 30);
/// }
/// ```
#[derive(Debug)]
pub struct Pipeline {
synchronizer: Arc<Synchronizer>,
producers: JoinSet<()>,
workers: JoinSet<()>,
signal_txs: Vec<Sender<StageWorkerSignal>>,
}
impl Pipeline {
/// Create a new pipeline builder.
pub fn builder() -> PipelineBuilder {
PipelineBuilder::default()
}
/// Wait for the pipeline to complete.
///
/// Once the pipeline is complete, a termination signal is sent to to all the workers.
///
/// A pipeline progresses to completion by doing the following:
/// 1. Wait for all "producers" to complete while also progressing stage workers
/// 2. Wait for either all the stage workers to complete, or wait for the internal
/// synchronizer to notify of completion (i.e. there's no more data flowing through the
/// pipeline)
///
/// Step 1 implies that if the producers never finish, the pipeline will run forever. See
/// [PipelineBuilder::with_producer] for more info.
pub async fn wait(mut self) {
let workers_to_progress = Arc::new(Mutex::new(self.workers));
let workers_to_finish = workers_to_progress.clone();
let wait_for_producers = async {
while let Some(result) = self.producers.join_next().await {
check_join_result(result);
}
};
let wait_for_workers = |workers: Arc<Mutex<JoinSet<()>>>| async move {
while let Some(result) = workers.lock().await.join_next().await {
check_join_result(result);
}
};
let check_sync_completed = async move {
while !self.synchronizer.completed() {
yield_now().await
}
for tx in self.signal_txs {
tx.send(StageWorkerSignal::Terminate)
.await
.expect("failed to send done signal")
}
};
// Effectively, make progress until all producers are done.
// We do this to prevent the synchronizer from causing the pipeline to shutdown too early.
select! {
_ = wait_for_producers => {},
_ = wait_for_workers(workers_to_progress),
if !workers_to_progress.lock().await.is_empty() => {},
}
// If either the synchronizer determines we're done, or all workers completed, we're done
select! {
_ = wait_for_workers(workers_to_finish) => {},
_ = check_sync_completed => {},
}
}
}
fn find_reader(
name: &str,
pipes: &mut HashMap<String, Pipe<BoxedAnySend>>,
) -> Result<PipeReader<BoxedAnySend>, String> {
Ok(pipes
.get_mut(name)
.unwrap_or_else(|| panic!("no pipe with name '{}' found", name))
.reader
.take()
.ok_or("reader was already used")?)
}
fn find_writer(
name: &str,
pipes: &HashMap<String, Pipe<BoxedAnySend>>,
) -> Result<PipeWriter<BoxedAnySend>, String> {
Ok(pipes
.get(name)
.ok_or(format!("pipeline has open-ended pipe: '{}'", name))?
.writer
.clone())
}
fn find_writers(
names: &[String],
pipes: &HashMap<String, Pipe<BoxedAnySend>>,
) -> Result<Vec<PipeWriter<BoxedAnySend>>, String> {
let mut writers = Vec::new();
for name in names {
writers.push(find_writer(name, pipes)?);
}
Ok(writers)
}
async fn write_results<O>(writers: &[PipeWriter<O>], results: Vec<Option<O>>) {
if results.len() != writers.len() {
panic!("len(results) != len(writers)");
}
for (result, writer) in results.into_iter().zip(writers) {
if let Some(result) = result {
writer.write(result).await;
}
}
}
fn downcast_from_pipe<T: 'static>(value: BoxedAnySend, pipe_name: &str) -> Box<T> {
value.downcast::<T>().unwrap_or_else(|_| {
panic!(
"failed to downcast input value to {} from pipe '{}'",
type_name::<T>(),
pipe_name,
)
})
}
fn check_join_result<T>(result: Result<T, JoinError>) {
if let Err(e) = result {
if e.is_panic() {
panic::resume_unwind(e.into_panic())
}
}
}
#[cfg(test)]
mod tests {
use std::collections::hash_map::RandomState;
use std::collections::HashSet;
use std::sync::Arc;
use tokio::select;
use super::*;
macro_rules! pipe_writers {
($count:expr) => {{
pipe_writers!($count, ())
}};
($count:expr, $ch:ty) => {{
let sync = Arc::new(Synchronizer::default());
let mut writers = Vec::new();
let mut rxs = Vec::new();
for _ in 0..$count {
let id = ulid::Ulid::new().to_string();
let (tx, rx) = tokio::sync::mpsc::channel::<$ch>(1);
rxs.push(rx);
writers.push(PipeWriter::new(format!("{id}"), sync.clone(), tx));
}
(writers, rxs)
}};
}
macro_rules! pipe {
($id:expr, reader=$reader:literal) => {{
let id: String = $id.into();
let sync = Arc::new(Synchronizer::default());
let (tx, rx) = tokio::sync::mpsc::channel(1);
let pipe = Pipe {
writer: PipeWriter::new(id.clone(), sync.clone(), tx),
reader: $reader.then_some(PipeReader::new(id.clone(), sync, rx)),
};
(id, pipe)
}};
}
#[test]
fn test_find_reader() {
let pipe_id = "Pipe";
let mut pipes = HashMap::from([pipe!("Pipe", reader = true)]);
let reader = find_reader(pipe_id, &mut pipes);
assert!(reader.is_ok());
assert_eq!(reader.unwrap().get_pipe_id(), pipe_id);
}
#[test]
#[should_panic]
fn test_find_reader_panics_on_no_reader() {
let _ = find_reader("Pipe", &mut HashMap::from([]));
}
#[test]
fn test_find_reader_already_used() {
let mut pipes = HashMap::from([pipe!("NoReader", reader = false)]);
let reader = find_reader("NoReader", &mut pipes);
assert!(reader.is_err());
assert_eq!(reader.unwrap_err(), "reader was already used".to_string());
}
#[test]
fn test_find_writer() {
let pipe_id = "Pipe";
let pipes = HashMap::from([pipe!(pipe_id, reader = true)]);
let writer = find_writer(pipe_id, &pipes);
assert!(writer.is_ok());
assert_eq!(writer.unwrap().get_pipe_id(), pipe_id);
}
#[test]
fn test_find_writer_open_ended() {
let pipes = HashMap::from([]);
let writer = find_writer("Pipe", &pipes);
assert!(writer.is_err());
assert_eq!(writer.unwrap_err(), "pipeline has open-ended pipe: 'Pipe'");
}
#[test]
fn test_find_writers() {
let pipes = HashMap::from([
pipe!("One", reader = true),
pipe!("Two", reader = false),
pipe!("Three", reader = true),
]);
let pipe_ids = vec!["Two".to_string(), "Three".to_string()];
let writers = find_writers(&pipe_ids, &pipes);
assert!(writers.is_ok());
let mut pipe_ids = HashSet::<String, RandomState>::from_iter(pipe_ids);
let writers = writers.unwrap();
assert_eq!(writers.len(), 2);
for writer in writers {
let id = writer.get_pipe_id();
assert!(pipe_ids.remove(id), "missing ID");
}
}
#[test]
fn test_find_writers_open_ended() {
let pipes = HashMap::from([
pipe!("One", reader = true),
pipe!("Two", reader = false),
pipe!("Three", reader = true),
]);
let pipe_ids = vec!["Two".to_string(), "Three".to_string(), "Four".to_string()];
let writers = find_writers(&pipe_ids, &pipes);
assert!(writers.is_err());
assert_eq!(writers.unwrap_err(), "pipeline has open-ended pipe: 'Four'");
}
#[tokio::test]
async fn test_write_results() {
let (writers, mut txs) = pipe_writers!(3, usize);
let results = vec![Some(0), None, Some(2)];
write_results(&writers, results).await;
assert_eq!(txs.get_mut(0).unwrap().try_recv(), Ok(0));
assert!(txs.get_mut(1).unwrap().try_recv().is_err());
assert_eq!(txs.get_mut(2).unwrap().try_recv(), Ok(2));
}
#[tokio::test]
#[should_panic]
async fn test_write_results_panics_on_result_count_mismatch() {
let (writers, _txs) = pipe_writers!(5, i32);
let results = vec![Some(1), None, None];
write_results(&writers, results).await;
}
#[test]
fn test_downcast_from_pipe() {
let value = Box::new(3i8) as BoxedAnySend;
let casted = downcast_from_pipe::<i8>(value, "some_pipe");
assert_eq!(casted, Box::new(3i8));
}
#[test]
#[should_panic(expected = "failed to downcast input value to i32 from pipe 'some_pipe'")]
fn test_downcast_from_pipe_fails() {
let value = Box::new(3i8) as BoxedAnySend;
downcast_from_pipe::<i32>(value, "some_pipe");
}
#[test]
fn test_check_join_result_does_nothing_on_ok() {
check_join_result(Ok(3usize));
}
#[tokio::test]
#[should_panic]
async fn test_check_join_result_propagates_panic() {
let mut joins = JoinSet::new();
joins.spawn(async { panic!("aaaahhhhh") });
check_join_result(joins.join_next().await.unwrap())
}
#[tokio::test]
async fn test_stage_receives_signal_terminate() {
let (tx, mut rx) = tokio::sync::mpsc::channel(1);
let pipeline = Pipeline::builder()
.with_inputs("pipe", vec![()])
.with_consumer(
"pipe",
WorkerOptions::default_single_task(),
move |_: ()| {
let tx = tx.clone();
async move {
tx.send(()).await.unwrap();
tokio::time::sleep(tokio::time::Duration::from_secs(5)).await;
panic!("worker did not terminate!");
}
},
)
.build()
.unwrap();
let signaller = pipeline.signal_txs.first().unwrap().clone();
select! {
_ = pipeline.wait() => {},
_ = rx.recv() => {
signaller.send(StageWorkerSignal::Terminate).await.unwrap();
}
}
}
}