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


use std::rc::Rc;
use std::collections::HashMap;
use std::collections::HashSet;
use std::any::Any;
use std::hash::Hash;
use std::hash::Hasher;


/// Represents a builder for an artifact.
///
/// Each builder is supposed to contain all direct depenencies possibly other
/// builders.
/// In the `build()` function, the builder can access the cache inorder to
/// resolve depending builders to their artifact.
///
pub trait Builder {
    type Artifact;
    
    fn build(&self, cache: &mut ArtifactResolver) -> Self::Artifact;
}


/// Encapsulates a builder are handle for its artifact from the ArtifactCache.
///
/// This struct is essentially a wrapper around `Rc<B>`, but it provides a
/// `Hash` and `Eq` implementation based no the identity of the Rcs inner value.
///
/// All clones of an `ArtifactPromise` are considered identical.
///
#[derive(Debug)]
pub struct ArtifactPromise<B: ?Sized> {
	builder: Rc<B>,
}

impl<B> ArtifactPromise<B> {
	/// Crates a new promise for the given builder.
	///
	pub fn new(builder: B) -> Self {
		Self {
			builder: Rc::new(builder),
		}
	}
	
	fn into_any(self) -> ArtifactPromise<dyn Any>
			where B: 'static {
		ArtifactPromise {
			builder: self.builder,
		}
	}
}

impl<B: ?Sized> ArtifactPromise<B> {
	/// Returns the pointer to the inner value.
	///
	fn as_ptr(&self) -> *const B {
		self.builder.as_ref() as &B as *const B
	}
}

impl<B: ?Sized> Clone for ArtifactPromise<B> {
	fn clone(&self) -> Self {
		ArtifactPromise {
			builder: self.builder.clone(),
		}
	}
}

impl<B: ?Sized> Hash for ArtifactPromise<B> {
	fn hash<H: Hasher>(&self, state: &mut H) {
		self.as_ptr().hash(state);
	}
}

impl<B: ?Sized> PartialEq for ArtifactPromise<B> {
	fn eq(&self, other: &Self) -> bool {
		self.as_ptr().eq(&other.as_ptr())
	}
}

impl<B: ?Sized> Eq for ArtifactPromise<B> {
}


/// Resolves any `ArtifactPromise` used to resolve the dependencies of builders.
///
/// This struct records each resolution in order to keep track of dependencies.
/// This is used for correct cache invalidation.
///
pub struct ArtifactResolver<'a> {
	user: ArtifactPromise<dyn Any>,
	cache: &'a mut ArtifactCache,
}

impl<'a> ArtifactResolver<'a> {
	/// Resolves the given `ArtifactPromise` into its `Artifact`.
	///
	pub fn resolve<B: Builder + 'static>(&mut self, cap: &ArtifactPromise<B>) -> Rc<B::Artifact> {
		self.cache.do_resolve(&self.user, cap)
	}
}



/// Central structure to prevent dependency duplication on building.
///
pub struct ArtifactCache {
	/// Maps Builder-Capsules to their Artifact value
	cache: HashMap<ArtifactPromise<dyn Any>, Rc<dyn Any>>,
	
	/// Tracks the direct promise dependants of each promise
	dependants: HashMap<ArtifactPromise<dyn Any>, HashSet<ArtifactPromise<dyn Any>>>,
}

impl Default for ArtifactCache {
	fn default() -> Self {
		ArtifactCache::new()
	}
}

impl ArtifactCache {
	
	/// Creates new empty cache
	///
	pub fn new() -> Self {
		Self {
			cache: HashMap::new(),
			dependants: HashMap::new(),
		}
	}
	
	/// Resolves artifact of cap and records dependency between user and cap.
	///
	fn do_resolve<B: Builder + 'static>(&mut self, user: &ArtifactPromise<dyn Any>, cap: &ArtifactPromise<B>) -> Rc<B::Artifact> {
		
		let deps = self.get_dependants(&cap.clone().into_any());
		if !deps.contains(user) {
			deps.insert(user.clone());
		}
		
		self.get(cap)
	}
	
	/// Returns the vector of dependants of cap
	///
	fn get_dependants(&mut self, cap: &ArtifactPromise<dyn Any>) -> &mut HashSet<ArtifactPromise<dyn Any>> {
		if !self.dependants.contains_key(cap) {
			self.dependants.insert(cap.clone(), HashSet::new());
		}
		
		self.dependants.get_mut(cap).unwrap()
	}
	
	/// Get the stored artifact if it exists.
	///
	fn lookup<B: Builder + 'static>(&self, builder: &ArtifactPromise<B>) -> Option<Rc<B::Artifact>>
			where <B as Builder>::Artifact: 'static {
		
		// Get the artifact from the hash map ensuring integrity
		self.cache.get(&ArtifactPromise {
			builder: builder.clone().builder,
		}).map(
			|rc| {
				// Ensure value type
				rc.clone().downcast()
					.expect("Cached Builder Artifact is of invalid type")
			}
		)
	}
	
	/// Store given artifact for given builder.
	///
	fn insert<B: Builder + 'static>(&mut self, builder: ArtifactPromise<B>, artifact: Rc<B::Artifact>) {
		
		// Insert artifact
		self.cache.insert(
			ArtifactPromise {
				builder: builder.clone().builder,
			},
			artifact
		);
		
	}
	
	/// Gets the artifact of the given builder.
	///
	/// This method looksup whether the artifact for the given builder is still
	/// present in the cache, or it will use the builder to build and store the
	/// artifact.
	///
	/// Notice the given builder will be stored keept to prevent it from
	/// deallocating. `clear()` must be called inorder to free those Rcs.
	///
	pub fn get<B: Builder + 'static>(&mut self, builder: &ArtifactPromise<B>) -> Rc<B::Artifact>
			where <B as Builder>::Artifact: 'static {
		
		if let Some(rc) = self.lookup(builder) {
			rc
			
		} else {
			let rc = Rc::new(builder.builder.build(&mut ArtifactResolver {
				user: ArtifactPromise {
					builder: builder.clone().builder,
				},
				cache: self,
			}));
			
			self.insert(builder.clone(), rc.clone());
			
			rc
		}
	}
	
	/// Clears the entire cache including all hold builder Rcs.
	///
	pub fn clear(&mut self) {
		self.cache.clear();
		self.dependants.clear();
	}
	
	fn invalidate_any(&mut self, any_promise: &ArtifactPromise<dyn Any>) {
		if let Some(set) = self.dependants.remove(any_promise) {
			for dep in set {
				self.invalidate_any(&dep);
			}
		}
		
		self.cache.remove(any_promise);
	}
	
	/// Clears the entire cache including all hold builder Rcs.
	///
	pub fn invalidate<B: Builder + 'static>(&mut self, cap: &ArtifactPromise<B>) {
		let any_promise = cap.clone().into_any();
		
		self.invalidate_any(&any_promise);
	}
}





// -----------

#[cfg(test)]
mod tests {
	use super::*;
	
	use std::rc::Rc;
	use std::sync::atomic::Ordering;
	use std::sync::atomic::AtomicU32;
	
	
	// Dummy counter to differentiate the leaf instances
	static COUNTER: AtomicU32 = AtomicU32::new(0);

	#[derive(Debug, PartialEq, Eq)]
	struct Leaf {
		id: u32,
	}

	#[derive(Debug)]
	struct BuilderLeaf {
		// empty
	}

	impl BuilderLeaf {
		pub fn new() -> Self {
		    Self {
		    	// empty
		    }
		}
	}

	impl Builder for BuilderLeaf {
		type Artifact = Leaf;
		
		fn build(&self, _cache: &mut ArtifactResolver) -> Self::Artifact {
		    Leaf{
				id: COUNTER.fetch_add(1, Ordering::SeqCst),
			}
		}
	}


	#[derive(Debug, PartialEq, Eq)]
	struct SimpleNode {
		id: u32,
		leaf: Rc<Leaf>,
	}

	#[derive(Debug)]
	struct BuilderSimpleNode {
		leaf: ArtifactPromise<BuilderLeaf>,
	}

	impl BuilderSimpleNode {
		pub fn new(leaf: ArtifactPromise<BuilderLeaf>) -> Self {
		    Self {
		        leaf,
		    }
		}
	}

	impl Builder for BuilderSimpleNode {
		type Artifact = SimpleNode;
		
		fn build(&self, cache: &mut ArtifactResolver) -> Self::Artifact {
			let leaf = cache.resolve(&self.leaf);
		    
		    SimpleNode{
		    	id: COUNTER.fetch_add(1, Ordering::SeqCst),
		    	leaf
		    }
		}
	}

	#[derive(Debug, PartialEq, Eq)]
	enum LeafOrNodes {
		Leaf(Rc<Leaf>),
		Nodes {
			left: Rc<ComplexNode>,
			right: Rc<ComplexNode>
		},
	}

	#[derive(Debug)]
	enum BuilderLeafOrNodes {
		Leaf(ArtifactPromise<BuilderLeaf>),
		Nodes {
			left: ArtifactPromise<BuilderComplexNode>,
			right: ArtifactPromise<BuilderComplexNode>
		},
	}
	
	impl BuilderLeafOrNodes {
		fn build(&self, cache: &mut ArtifactResolver) -> LeafOrNodes {
			match self {
				Self::Leaf(l) => {
					LeafOrNodes::Leaf(cache.resolve(l))
				},
				Self::Nodes{left, right} => {
					LeafOrNodes::Nodes{
						left: cache.resolve(left),
						right: cache.resolve(right),
					}
				},
			}
		}
	}

	#[derive(Debug, PartialEq, Eq)]
	struct ComplexNode {
		id: u32,
		inner: LeafOrNodes,
	}
	
	impl ComplexNode {
		pub fn leaf(&self) -> Option<&Rc<Leaf>> {
			if let LeafOrNodes::Leaf(ref l) = self.inner {
				Some(l)
			} else {
				None
			}
		}
		
		pub fn left(&self) -> Option<&Rc<ComplexNode>> {
			if let LeafOrNodes::Nodes{ref left, ..} = self.inner {
				Some(left)
			} else {
				None
			}
		}
		
		pub fn right(&self) -> Option<&Rc<ComplexNode>> {
			if let LeafOrNodes::Nodes{ref right, ..} = self.inner {
				Some(right)
			} else {
				None
			}
		}
	}

	#[derive(Debug)]
	struct BuilderComplexNode {
		inner: BuilderLeafOrNodes,
	}

	impl BuilderComplexNode {
		pub fn new_leaf(leaf: ArtifactPromise<BuilderLeaf>) -> Self {
		    Self {
		        inner: BuilderLeafOrNodes::Leaf(leaf),
		    }
		}
		
		pub fn new_nodes(left: ArtifactPromise<BuilderComplexNode>, right: ArtifactPromise<BuilderComplexNode>) -> Self {
		    Self {
		        inner: BuilderLeafOrNodes::Nodes{left, right},
		    }
		}
	}

	impl Builder for BuilderComplexNode {
		type Artifact = ComplexNode;
		
		fn build(&self, cache: &mut ArtifactResolver) -> Self::Artifact {
		    ComplexNode{
		    	id: COUNTER.fetch_add(1, Ordering::SeqCst),
		    	inner: self.inner.build(cache),
		    }
		}
	}
    
    #[test]
	fn test_leaf() {
		let mut cache = ArtifactCache::new();
		
		let leaf1 = ArtifactPromise::new(BuilderLeaf::new());
		let leaf2 = ArtifactPromise::new(BuilderLeaf::new());
		
		//println!("BuilderLeaf: {:?}; {:?}", leaf1, leaf2);
		
		// Ensure same builder results in same artifact
		assert_eq!(cache.get(&leaf1), cache.get(&leaf1));
		
		// Ensure different builder result in  different artifacts
		assert_ne!(cache.get(&leaf1), cache.get(&leaf2));
	}
    
    #[test]
	fn test_node() {
		let mut cache = ArtifactCache::new();
		
		let leaf1 = ArtifactPromise::new(BuilderLeaf::new());
		let leaf2 = ArtifactPromise::new(BuilderLeaf::new());
		
		let node1 = ArtifactPromise::new(BuilderSimpleNode::new(leaf1.clone()));
		let node2 = ArtifactPromise::new(BuilderSimpleNode::new(leaf2.clone()));
		let node3 = ArtifactPromise::new(BuilderSimpleNode::new(leaf2.clone()));
		
		// Ensure same builder results in same artifact
		assert_eq!(cache.get(&node1), cache.get(&node1));
		
		// Ensure different builder result in  different artifacts
		assert_ne!(cache.get(&node2), cache.get(&node3));
		
		// Enusre that different artifacts may link the same dependent artifact
		assert_eq!(cache.get(&node2).leaf, cache.get(&node3).leaf);
		
	}
    
    #[test]
	fn test_complex() {
		let mut cache = ArtifactCache::new();
		
		let leaf1 = ArtifactPromise::new(BuilderLeaf::new());
		let leaf2 = ArtifactPromise::new(BuilderLeaf::new());
		
		let nodef1 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf1.clone()));
		let nodef2 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf2.clone()));
		let nodef3 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf2.clone()));
		
		let noden1 = ArtifactPromise::new(BuilderComplexNode::new_nodes(nodef1.clone(), nodef2.clone()));
		let noden2 = ArtifactPromise::new(BuilderComplexNode::new_nodes(nodef3.clone(), noden1.clone()));
		let noden3 = ArtifactPromise::new(BuilderComplexNode::new_nodes(noden2.clone(), noden2.clone()));
		
		// Ensure same builder results in same artifact
		assert_eq!(cache.get(&noden3), cache.get(&noden3));
		
		// Ensure different builder result in  different artifacts
		assert_ne!(cache.get(&noden1), cache.get(&noden2));
		
		let artifact_leaf = cache.get(&leaf1);
		let artifact_node = cache.get(&noden1);
		let artifact_root = cache.get(&noden3);
		
		assert_eq!(artifact_root.left(), artifact_root.right());
		
		assert_eq!(artifact_root.left().unwrap().right(), Some(&artifact_node));
		assert_eq!(artifact_node.left().unwrap().leaf(), Some(&artifact_leaf));
		
	}
    
    #[test]
	fn test_clear() {
		let mut cache = ArtifactCache::new();
		
		let leaf1 = ArtifactPromise::new(BuilderLeaf::new());
		
		let artifact1 = cache.get(&leaf1);
		
		cache.clear();
		
		let artifact2 = cache.get(&leaf1);
		
		// Ensure artifacts differ after clear
		assert_ne!(artifact1, artifact2);
		
	}
    
    #[test]
	fn test_complex_clear() {
		let mut cache = ArtifactCache::new();
		
		let leaf1 = ArtifactPromise::new(BuilderLeaf::new());
		let leaf2 = ArtifactPromise::new(BuilderLeaf::new());
		
		let nodef1 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf1.clone()));
		let nodef2 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf2.clone()));
		let nodef3 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf2.clone()));
		
		let noden1 = ArtifactPromise::new(BuilderComplexNode::new_nodes(nodef1.clone(), nodef2.clone()));
		let noden2 = ArtifactPromise::new(BuilderComplexNode::new_nodes(nodef3.clone(), noden1.clone()));
		let noden3 = ArtifactPromise::new(BuilderComplexNode::new_nodes(noden2.clone(), noden2.clone()));
		
		let artifact_leaf = cache.get(&leaf1);
		let artifact_node = cache.get(&noden1);
		let artifact_root = cache.get(&noden3);
		
		cache.clear();
		
		let artifact_leaf_2 = cache.get(&leaf1);
		let artifact_node_2 = cache.get(&noden1);
		let artifact_root_2 = cache.get(&noden3);
		
		assert_ne!(artifact_leaf, artifact_leaf_2);
		assert_ne!(artifact_node, artifact_node_2);
		assert_ne!(artifact_root, artifact_root_2);
		
	}
    
    #[test]
	fn test_invalidate() {
		let mut cache = ArtifactCache::new();
		
		let leaf1 = ArtifactPromise::new(BuilderLeaf::new());
		
		let artifact1 = cache.get(&leaf1);
		
		cache.invalidate(&leaf1);
		
		let artifact2 = cache.get(&leaf1);
		
		// Ensure artifacts differ after clear
		assert_ne!(artifact1, artifact2);
		
	}
    
    #[test]
	fn test_complex_invalidate() {
		let mut cache = ArtifactCache::new();
		
		let leaf1 = ArtifactPromise::new(BuilderLeaf::new());
		let leaf2 = ArtifactPromise::new(BuilderLeaf::new());
		
		let nodef1 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf1.clone()));
		let nodef2 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf2.clone()));
		let nodef3 = ArtifactPromise::new(BuilderComplexNode::new_leaf(leaf2.clone()));
		
		let noden1 = ArtifactPromise::new(BuilderComplexNode::new_nodes(nodef1.clone(), nodef2.clone()));
		let noden2 = ArtifactPromise::new(BuilderComplexNode::new_nodes(nodef3.clone(), noden1.clone()));
		let noden3 = ArtifactPromise::new(BuilderComplexNode::new_nodes(noden2.clone(), noden2.clone()));
		
		let artifact_leaf = cache.get(&leaf1);
		let artifact_node = cache.get(&noden1);
		let artifact_root = cache.get(&noden3);
		
		cache.invalidate(&noden1);
		
		let artifact_leaf_2 = cache.get(&leaf1);
		let artifact_node_2 = cache.get(&noden1);
		let artifact_root_2 = cache.get(&noden3);
		
		assert_eq!(artifact_leaf, artifact_leaf_2);
		assert_ne!(artifact_node, artifact_node_2);
		assert_ne!(artifact_root, artifact_root_2);
		
	}
}