Difference between revisions of "Iced Cakes Pipeline"

From CSE231 Wiki
Jump to navigation Jump to search
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
[[File:KitchenAid Stand Mixer.jpg|thumb|KitchenAid Stand Mixer]] [[File:Jean-François Millet (II) 005.jpg|thumb|Jean-François Millet (II) 005]] [[File:Piping buttercream onto cake.JPG|thumb|Piping buttercream onto cake]]
 +
 
=Motivation=
 
=Motivation=
 
Pipelines can increase throughput when processing a stream of data.  We will gain additional experience with Phasers by building a software pipeline.
 
Pipelines can increase throughput when processing a stream of data.  We will gain additional experience with Phasers by building a software pipeline.
  
−
=Backgroud=
+
=Perhaps Outdated Lecture=
−
<youtube>3cqVtc2rDlg</youtube>
+
{{CollapsibleYouTube|Perhaps Outdated Pipeline Lecture|<youtube>umTGnCc9cGU</youtube>}}
  
 
=Code To Use=
 
=Code To Use=
−
==Cakes==
+
==Mixer==
−
class Mixer
+
[https://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/pipeline/cake/core/Mixer.html class Mixer]
−
:mix(int cakeIndex)
+
:[https://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/pipeline/cake/core/Mixer.html#mix-int- mix(int cakeIndex)]
−
class Baker
+
==Oven==
−
:bake(int cakeIndex, MixedIngredients mixedIngredients)
+
[https://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/pipeline/cake/core/Oven.html class Oven]
−
class Icer
+
:[https://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/pipeline/cake/core/Oven.html#bake-int-pipeline.cake.core.MixedIngredients- bake(int cakeIndex, MixedIngredients mixedIngredients)]
−
:ice(int cakeIndex, BakedCake bakedCake)
+
==Icer==
 +
[https://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/pipeline/cake/core/Icer.html class Icer]
 +
:[https://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/pipeline/cake/core/Icer.html#ice-int-pipeline.cake.core.BakedCake- ice(int cakeIndex, BakedCake bakedCake)]
  
 +
==Phasers==
 +
<youtube>whPAPmylbEU</youtube>
  
−
==Looping==
+
[[Reference_Page#Phasers|Our reference page's phasers section]]
−
[https://docs.oracle.com/javase/tutorial/java/nutsandbolts/for.html Java For Loop]
 
  
−
==Phasers==
 
 
[https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Phaser.html class Phaser] ([http://www.baeldung.com/java-phaser Guide to the Java Phaser])
 
[https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Phaser.html class Phaser] ([http://www.baeldung.com/java-phaser Guide to the Java Phaser])
 
: [https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Phaser.html#register-- register]
 
: [https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Phaser.html#register-- register]
Line 24: Line 28:
 
: [https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Phaser.html#awaitAdvance-int- awaitAdvance] use via PhaserUtils.awaitAdvanceForPhase(phaser, phase)
 
: [https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Phaser.html#awaitAdvance-int- awaitAdvance] use via PhaserUtils.awaitAdvanceForPhase(phaser, phase)
  
−
[http://www.cse.wustl.edu/~cosgroved/courses/cse231/s18/apidocs/edu/wustl/cse231s/concurrent/PhaserUtils.html PhaserUtils]
+
[http://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/edu/wustl/cse231s/concurrent/PhaserUtils.html PhaserUtils]
−
: [http://www.cse.wustl.edu/~cosgroved/courses/cse231/s18/apidocs/edu/wustl/cse231s/concurrent/PhaserUtils.html#awaitAdvanceForPhase-java.util.concurrent.Phaser-int- awaitAdvanceForPhase]
+
: [http://www.cse.wustl.edu/~cosgroved/courses/cse231/current/apidocs/edu/wustl/cse231s/concurrent/PhaserUtils.html#awaitAdvanceForPhase-java.util.concurrent.Phaser-int- awaitAdvanceForPhase]
−
 
 
−
If you are on or past the phase you want to await, then calling <code>phaser.awaitAdvance()</code> directly is fine.  If you might be on a prior phase, then invoke <code>PhaserUtils.awaitAdvanceForPhase(phaser, phase)</code>.  If in doubt, invoking awaitAdvanceForPhase is safer.
 
−
 
 
−
<nowiki> public static int awaitAdvanceForPhase(Phaser phaser, int phase) {
 
−
return awaitAdvanceForPhase(phaser, phase, () -> Thread.yield());
 
−
}
 
−
 
 
−
public static int awaitAdvanceForPhase(Phaser phaser, int phase, Runnable runnable) {
 
−
while (true) {
 
−
int currentPhase = phaser.awaitAdvance(phase);
 
−
if (currentPhase < 0 || currentPhase > phase) {
 
−
return currentPhase;
 
−
} else {
 
−
if (runnable != null) {
 
−
runnable.run();
 
−
}
 
−
}
 
−
}
 
−
}</nowiki>
 
−
 
 
−
=Questions To Ask Yourself=
 
−
# What are my tasks?
 
−
# What work does each task need to do?
 
−
# What, if anything, does each task depend upon?  That is: what does each task have to wait for before it may proceed?
 
  
 
=Code To Implement=
 
=Code To Implement=
Line 55: Line 35:
 
{{CodeToImplement|CakePipeline|mixBakeAndIceCakes|pipeline.cake.studio}}
 
{{CodeToImplement|CakePipeline|mixBakeAndIceCakes|pipeline.cake.studio}}
  
−
{{Parallel|public static IcedCake[] mixBakeAndIceCakes(Mixer mixer, Baker baker, Icer icer, int cakeCount)}}
+
{{Parallel|public static IcedCake[] mixBakeAndIceCakes(Mixer mixer, Oven oven, Icer icer, int cakeCount)}}
  
 
Design a simple pipeline using Phasers. In order to have a finished cake, you need to first mix the ingredients, then bake the cake, and finally ice it with frosting. Although you only have one tool for each step (one whisk, one oven, and one icing spatula), there's no problem with icing one cake while another is baking in the oven. That's where the parallelism comes in. Answering the above questions should give you all the information you need to set up this method. Remember that this needs to be able work for any number of cakes passed through!  
 
Design a simple pipeline using Phasers. In order to have a finished cake, you need to first mix the ingredients, then bake the cake, and finally ice it with frosting. Although you only have one tool for each step (one whisk, one oven, and one icing spatula), there's no problem with icing one cake while another is baking in the oven. That's where the parallelism comes in. Answering the above questions should give you all the information you need to set up this method. Remember that this needs to be able work for any number of cakes passed through!  
  
 
Note that icer.ice() returns an object of IcedCake. Collect all the 'IcedCake's you make, and return them in an array.
 
Note that icer.ice() returns an object of IcedCake. Collect all the 'IcedCake's you make, and return them in an array.
 +
 +
{{Warning|Do not forget to ensure that all of your tasks (mix, bake, and ice) complete before you return. }}
 +
 +
[[File:CakePipeline.svg | 600px]]
  
 
==Optional Challenge==
 
==Optional Challenge==
−
{{CodeToImplement|TwoOvenPipeline|mixBakeAndIceCakes|pipeline.cake.challenge}}
+
{{CodeToImplement|MultiOvenCakePipeline|mixBakeAndIceCakes|pipeline.cake.challenge}}
  
−
{{Parallel|public static IcedCake[] mixBakeAndIceCakes(Mixer mixer, Baker baker1, Baker baker2, Icer icer, int cakeCount)}}
+
{{Parallel|public static IcedCake[] mixBakeAndIceCakes(Mixer mixer, List<Oven> ovens, Icer icer, int cakeCount)}}
  
−
As we've discussed in class, not all steps of the pipeline always take the same amount of time to complete. In this example, baking a cake in the oven usually takes much longer than simply mixing the ingredients or icing the cake. The Baker is the bottleneck on the performance of this pipeline. One way to further improve the process then is to simply add another oven. This time, build a similar pipeline to what you made earlier, but use both of the Bakers passed to you in order to speed things up. Here's a couple things to take note of:
+
As we've discussed in class, not all steps of the pipeline always take the same amount of time to complete. In this example, baking a cake in the oven usually takes much longer than simply mixing the ingredients or icing the cake. The Oven is the bottleneck on the performance of this pipeline. One way to further improve the process then is to simply more ovens. This time, build a similar pipeline to what you made earlier, but use all of the Ovens passed to you in order to speed things up. Here's a couple things to take note of:
−
*How have the tasks changed? How does this additional oven affect the number of threads your program will use?
+
*How have the tasks changed? How does this additional oven affect the number of tasks your program will use?
 +
<!--
 
*Assume that the only way to get a second oven is to buy an old, used one. It can't get as hot, so it will need more time to bake a cake. Because of this, it is better to set up your solution such that when a set of ingredients has been mixed, it sends them to any open oven, rather than just alternating between the two ovens.
 
*Assume that the only way to get a second oven is to buy an old, used one. It can't get as hot, so it will need more time to bake a cake. Because of this, it is better to set up your solution such that when a set of ingredients has been mixed, it sends them to any open oven, rather than just alternating between the two ovens.
−
*Make sure that only one of the two ovens bakes any given cake. Don't let both ovens try to bake the same cake!
+
*Make sure that only one of the two ovens bakes any given cake. Use baker.inUse() and baker.numberAlreadyBaked() to help keep track of which oven has done which cakes.
 +
-->
 +
 
 +
{{Alert|<br/>Recall that [https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Phaser.html#awaitAdvance-int- awaitAdvance(phase)]'s returns immediately if the current phase is not the given phase.<br/>It is often better to use [https://www.cse.wustl.edu/~dennis.cosgrove/courses/cse231/current/apidocs/edu/wustl/cse231s/concurrent/PhaserUtils.html#awaitAdvanceForPhase(java.util.concurrent.Phaser,int) PhaserUtils.awaitAdvanceForPhase(phaser, phase)].}}
  
 
=Testing Your Solution=
 
=Testing Your Solution=
Line 82: Line 70:
  
 
==Correctness==
 
==Correctness==
−
{{TestSuite|CakePipelineTestSuite|pipeline.cake.studio}}
+
{{TestSuite|_CakePipelineTestSuite| pipeline.cake.exercise}}
  
−
When you are passing the tests and your visualization looks good, demo it to an instructor.
+
=Pledge, Acknowledgments, Citations=
 +
{{Pledge|exercise-cake-pipeline}}

Latest revision as of 03:13, 26 April 2023

KitchenAid Stand Mixer
Jean-François Millet (II) 005
Piping buttercream onto cake

Motivation

Pipelines can increase throughput when processing a stream of data. We will gain additional experience with Phasers by building a software pipeline.

Perhaps Outdated Lecture

Video: Perhaps Outdated Pipeline Lecture  

Code To Use

Mixer

class Mixer

mix(int cakeIndex)

Oven

class Oven

bake(int cakeIndex, MixedIngredients mixedIngredients)

Icer

class Icer

ice(int cakeIndex, BakedCake bakedCake)

Phasers

Our reference page's phasers section

class Phaser (Guide to the Java Phaser)

register
arrive
awaitAdvance use via PhaserUtils.awaitAdvanceForPhase(phaser, phase)

PhaserUtils

awaitAdvanceForPhase

Code To Implement

Required Code

class: CakePipeline.java Java.png
methods: mixBakeAndIceCakes
package: pipeline.cake.studio
source folder: student/src/main/java

method: public static IcedCake[] mixBakeAndIceCakes(Mixer mixer, Oven oven, Icer icer, int cakeCount) Parallel.svg (parallel implementation required)

Design a simple pipeline using Phasers. In order to have a finished cake, you need to first mix the ingredients, then bake the cake, and finally ice it with frosting. Although you only have one tool for each step (one whisk, one oven, and one icing spatula), there's no problem with icing one cake while another is baking in the oven. That's where the parallelism comes in. Answering the above questions should give you all the information you need to set up this method. Remember that this needs to be able work for any number of cakes passed through!

Note that icer.ice() returns an object of IcedCake. Collect all the 'IcedCake's you make, and return them in an array.

Attention niels epting.svg Warning:Do not forget to ensure that all of your tasks (mix, bake, and ice) complete before you return.

CakePipeline.svg

Optional Challenge

class: MultiOvenCakePipeline.java Java.png
methods: mixBakeAndIceCakes
package: pipeline.cake.challenge
source folder: student/src/main/java

method: public static IcedCake[] mixBakeAndIceCakes(Mixer mixer, List<Oven> ovens, Icer icer, int cakeCount) Parallel.svg (parallel implementation required)

As we've discussed in class, not all steps of the pipeline always take the same amount of time to complete. In this example, baking a cake in the oven usually takes much longer than simply mixing the ingredients or icing the cake. The Oven is the bottleneck on the performance of this pipeline. One way to further improve the process then is to simply more ovens. This time, build a similar pipeline to what you made earlier, but use all of the Ovens passed to you in order to speed things up. Here's a couple things to take note of:

  • How have the tasks changed? How does this additional oven affect the number of tasks your program will use?
Attention niels epting.svg Alert:
Recall that awaitAdvance(phase)'s returns immediately if the current phase is not the given phase.
It is often better to use PhaserUtils.awaitAdvanceForPhase(phaser, phase).

Testing Your Solution

Visualization

class: CakePipelineVizApp.java VIZ
package: pipeline.cake.viz
source folder: student/src//java

CakePipelineGIF.gif

The viz below is for the challenge assignment.

TwoOvenPipelineGIF.gif

Correctness

class: _CakePipelineTestSuite.java Junit.png
package: pipeline.cake.exercise
source folder: testing/src/test/java

Pledge, Acknowledgments, Citations

file: exercise-cake-pipeline-pledge-acknowledgments-citations.txt

More info about the Honor Pledge

Retrieved from "http://classes.engineering.wustl.edu/cse231/core/index.php?title=Iced_Cakes_Pipeline&oldid=4995"