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
use std::fmt; use hashbrown::HashMap; use crate::{ dispatch::{ dispatcher::{SystemId, ThreadLocal, ThreadPoolWrapper}, stage::StagesBuilder, BatchAccessor, BatchController, Dispatcher, }, system::{RunNow, System, SystemData}, }; /// Builder for the [`Dispatcher`]. /// /// [`Dispatcher`]: struct.Dispatcher.html /// /// ## Barriers /// /// Barriers are a way of sequentializing parts of /// the system execution. See `add_barrier()`/`with_barrier()`. /// /// ## Examples /// /// This is how you create a dispatcher with /// a shared thread pool: /// /// ```rust /// # #![allow(unused)] /// # /// # extern crate shred; /// # #[macro_use] /// # extern crate shred_derive; /// # use shred::{Dispatcher, DispatcherBuilder, Read, ResourceId, World, System, SystemData}; /// # #[derive(Debug, Default)] struct Res; /// # #[derive(SystemData)] #[allow(unused)] struct Data<'a> { a: Read<'a, Res> } /// # struct Dummy; /// # impl<'a> System<'a> for Dummy { /// # type SystemData = Data<'a>; /// # /// # fn run(&mut self, _: Data<'a>) {} /// # } /// # /// # fn main() { /// # let system_a = Dummy; /// # let system_b = Dummy; /// # let system_c = Dummy; /// # let system_d = Dummy; /// # let system_e = Dummy; /// let dispatcher: Dispatcher = DispatcherBuilder::new() /// .with(system_a, "a", &[]) /// .with(system_b, "b", &["a"]) // b depends on a /// .with(system_c, "c", &["a"]) // c also depends on a /// .with(system_d, "d", &[]) /// .with(system_e, "e", &["c", "d"]) // e executes after c and d are finished /// .build(); /// # } /// ``` /// /// Systems can be conditionally added by using the `add_` functions: /// /// ```rust /// # #![allow(unused)] /// # /// # extern crate shred; /// # #[macro_use] /// # extern crate shred_derive; /// # use shred::{Dispatcher, DispatcherBuilder, Read, ResourceId, World, System, SystemData}; /// # #[derive(Debug, Default)] struct Res; /// # #[derive(SystemData)] #[allow(unused)] struct Data<'a> { a: Read<'a, Res> } /// # struct Dummy; /// # impl<'a> System<'a> for Dummy { /// # type SystemData = Data<'a>; /// # /// # fn run(&mut self, _: Data<'a>) {} /// # } /// # /// # fn main() { /// # let b_enabled = true; /// # let system_a = Dummy; /// # let system_b = Dummy; /// let mut builder = DispatcherBuilder::new() /// .with(system_a, "a", &[]); /// /// if b_enabled { /// builder.add(system_b, "b", &[]); /// } /// /// let dispatcher = builder.build(); /// # } /// ``` #[derive(Default)] pub struct DispatcherBuilder<'a, 'b> { current_id: usize, map: HashMap<String, SystemId>, pub(crate) stages_builder: StagesBuilder<'a>, thread_local: ThreadLocal<'b>, #[cfg(feature = "parallel")] thread_pool: ::std::sync::Arc<::std::sync::RwLock<ThreadPoolWrapper>>, } impl<'a, 'b> DispatcherBuilder<'a, 'b> { /// Creates a new `DispatcherBuilder` by using the `Default` implementation. /// /// The default behaviour is to create a thread pool on `finish`. /// If you already have a rayon `ThreadPool`, it's highly recommended to /// configure this builder to use it with `with_pool` instead. pub fn new() -> Self { Default::default() } /// Adds a new system with a given name and a list of dependencies. /// Please note that the dependency should be added before /// you add the depending system. /// /// If you want to register systems which can not be specified as /// dependencies, you can use `""` as their name, which will not panic /// (using another name twice will). /// /// Same as [`add()`](struct.DispatcherBuilder.html#method.add), but /// returns `self` to enable method chaining. /// /// # Panics /// /// * if the specified dependency does not exist /// * if a system with the same name was already registered. pub fn with<T>(mut self, system: T, name: &str, dep: &[&str]) -> Self where T: for<'c> System<'c> + Send + 'a, { self.add(system, name, dep); self } /// Adds a new system with a given name and a list of dependencies. /// Please note that the dependency should be added before /// you add the depending system. /// /// If you want to register systems which can not be specified as /// dependencies, you can use `""` as their name, which will not panic /// (using another name twice will). /// /// # Panics /// /// * if the specified dependency does not exist /// * if a system with the same name was already registered. pub fn add<T>(&mut self, system: T, name: &str, dep: &[&str]) where T: for<'c> System<'c> + Send + 'a, { use hashbrown::hash_map::Entry; let id = self.next_id(); let dependencies = dep .iter() .map(|x| { *self .map .get(*x) .unwrap_or_else(|| panic!("No such system registered (\"{}\")", *x)) }) .collect(); if name != "" { if let Entry::Vacant(e) = self.map.entry(name.to_owned()) { e.insert(id); } else { panic!( "Cannot insert multiple systems with the same name (\"{}\")", name ); } } self.stages_builder.insert(dependencies, id, system); } /// The `Batch` is a `System` which contains a `Dispatcher`. /// By wrapping a `Dispatcher` inside a system, we can control the execution /// of a whole group of system, without sacrificing parallelism or /// conciseness. /// /// This function accepts the `DispatcherBuilder` as parameter, and the type /// of the `System` that will drive the execution of the internal /// dispatcher. /// /// Note that depending on the dependencies of the SubSystems the Batch /// can run in parallel with other Systems. /// In addition the Sub Systems can run in parallel within the Batch. /// /// The `Dispatcher` created for this `Batch` is completelly separate, /// from the parent `Dispatcher`. /// This mean that the dependencies, the `System` names, etc.. specified on /// the `Batch` `Dispatcher` are not visible on the parent, and is not /// allowed to specify cross dependencies. pub fn with_batch<T>( mut self, dispatcher_builder: DispatcherBuilder<'a, 'b>, name: &str, dep: &[&str], ) -> Self where T: for<'c> System<'c> + BatchController<'a, 'b> + Send + 'a, { self.add_batch::<T>(dispatcher_builder, name, dep); self } /// The `Batch` is a `System` which contains a `Dispatcher`. /// By wrapping a `Dispatcher` inside a system, we can control the execution /// of a whole group of system, without sacrificing parallelism or /// conciseness. /// /// This function accepts the `DispatcherBuilder` as parameter, and the type /// of the `System` that will drive the execution of the internal /// dispatcher. /// /// Note that depending on the dependencies of the SubSystems the Batch /// can run in parallel with other Systems. /// In addition the Sub Systems can run in parallel within the Batch. /// /// The `Dispatcher` created for this `Batch` is completelly separate, /// from the parent `Dispatcher`. /// This mean that the dependencies, the `System` names, etc.. specified on /// the `Batch` `Dispatcher` are not visible on the parent, and is not /// allowed to specify cross dependencies. pub fn add_batch<T>( &mut self, mut dispatcher_builder: DispatcherBuilder<'a, 'b>, name: &str, dep: &[&str], ) where T: for<'c> System<'c> + BatchController<'a, 'b> + Send + 'a, { dispatcher_builder.thread_pool = self.thread_pool.clone(); let mut reads = dispatcher_builder.stages_builder.fetch_all_reads(); reads.extend(<T::BatchSystemData as SystemData>::reads()); reads.sort(); reads.dedup(); let mut writes = dispatcher_builder.stages_builder.fetch_all_writes(); writes.extend(<T::BatchSystemData as SystemData>::reads()); writes.sort(); writes.dedup(); let accessor = BatchAccessor::new(reads, writes); let dispatcher = dispatcher_builder.build(); let batch_system = unsafe { T::create(accessor, dispatcher) }; self.add(batch_system, name, dep); } /// Adds a new thread local system. /// /// Please only use this if your struct is not `Send` and `Sync`. /// /// Thread-local systems are dispatched in-order. /// /// Same as [DispatcherBuilder::add_thread_local], but returns `self` to /// enable method chaining. pub fn with_thread_local<T>(mut self, system: T) -> Self where T: for<'c> RunNow<'c> + 'b, { self.add_thread_local(system); self } /// Adds a new thread local system. /// /// Please only use this if your struct is not `Send` and `Sync`. /// /// Thread-local systems are dispatched in-order. pub fn add_thread_local<T>(&mut self, system: T) where T: for<'c> RunNow<'c> + 'b, { self.thread_local.push(Box::new(system)); } /// Inserts a barrier which assures that all systems /// added before the barrier are executed before the ones /// after this barrier. /// /// Does nothing if there were no systems added /// since the last call to `add_barrier()`/`with_barrier()`. /// /// Thread-local systems are not affected by barriers; /// they're always executed at the end. /// /// Same as [DispatcherBuilder::add_barrier], but returns `self` to enable /// method chaining. pub fn with_barrier(mut self) -> Self { self.add_barrier(); self } /// Inserts a barrier which assures that all systems /// added before the barrier are executed before the ones /// after this barrier. /// /// Does nothing if there were no systems added /// since the last call to `add_barrier()`/`with_barrier()`. /// /// Thread-local systems are not affected by barriers; /// they're always executed at the end. pub fn add_barrier(&mut self) { self.stages_builder.add_barrier(); } /// Attach a rayon thread pool to the builder /// and use that instead of creating one. /// /// Same as /// [`add_pool()`](struct.DispatcherBuilder.html#method.add_pool), /// but returns `self` to enable method chaining. #[cfg(feature = "parallel")] pub fn with_pool(mut self, pool: ::std::sync::Arc<::rayon::ThreadPool>) -> Self { self.add_pool(pool); self } /// Attach a rayon thread pool to the builder /// and use that instead of creating one. #[cfg(feature = "parallel")] pub fn add_pool(&mut self, pool: ::std::sync::Arc<::rayon::ThreadPool>) { *self.thread_pool.write().unwrap() = Some(pool); } /// Prints the equivalent system graph /// that can be easily used to get the graph using the `seq!` and `par!` /// macros. This is only recommended for advanced users. pub fn print_par_seq(&self) { println!("{:#?}", self); } /// Builds the `Dispatcher`. /// /// In the future, this method will /// precompute useful information in /// order to speed up dispatching. pub fn build(self) -> Dispatcher<'a, 'b> { use crate::dispatch::dispatcher::new_dispatcher; #[cfg(feature = "parallel")] self.thread_pool .write() .unwrap() .get_or_insert_with(|| Self::create_thread_pool()); #[cfg(feature = "parallel")] let d = new_dispatcher( self.stages_builder.build(), self.thread_local, self.thread_pool, ); #[cfg(not(feature = "parallel"))] let d = new_dispatcher(self.stages_builder.build(), self.thread_local); d } fn next_id(&mut self) -> SystemId { let id = self.current_id; self.current_id += 1; SystemId(id) } #[cfg(feature = "parallel")] fn create_thread_pool() -> ::std::sync::Arc<::rayon::ThreadPool> { use rayon::ThreadPoolBuilder; use std::sync::Arc; Arc::new( ThreadPoolBuilder::new() .build() .expect("Invalid configuration"), ) } } #[cfg(feature = "parallel")] impl<'b> DispatcherBuilder<'static, 'b> { /// Builds an async dispatcher. /// /// It does not allow non-static types and accepts a `World` struct or a /// value that can be borrowed as `World`. pub fn build_async<R>( self, world: R, ) -> crate::dispatch::async_dispatcher::AsyncDispatcher<'b, R> { use crate::dispatch::async_dispatcher::new_async; self.thread_pool .write() .unwrap() .get_or_insert_with(|| Self::create_thread_pool()); new_async( world, self.stages_builder.build(), self.thread_local, self.thread_pool, ) } } impl<'a, 'b> fmt::Debug for DispatcherBuilder<'a, 'b> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { self.stages_builder.write_par_seq(f, &self.map) } }