| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 --> |
| <title>NemoPlanRewriter (Nemo Project 0.4 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-09"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NemoPlanRewriter (Nemo Project 0.4 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NemoPlanRewriter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.nemo.compiler.backend.nemo</a></div> |
| <h2 title="Class NemoPlanRewriter" class="title">Class NemoPlanRewriter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.nemo.compiler.backend.nemo.NemoPlanRewriter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../../runtime/common/plan/PlanRewriter.html" title="interface in org.apache.nemo.runtime.common.plan">PlanRewriter</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">NemoPlanRewriter</span> |
| extends java.lang.Object |
| implements <a href="../../../runtime/common/plan/PlanRewriter.html" title="interface in org.apache.nemo.runtime.common.plan">PlanRewriter</a></pre> |
| <div class="block">Rewrites the physical plan during execution, to enforce the optimizations of Nemo RunTimePasses. |
| <p> |
| A high-level flow of a rewrite is as follows: |
| Runtime - (PhysicalPlan-level info) - NemoPlanRewriter - (IRDAG-level info) - NemoOptimizer - (new IRDAG) |
| - NemoPlanRewriter - (new PhysicalPlan) - Runtime |
| <p> |
| Here, the NemoPlanRewriter acts as a translator between the Runtime that only understands PhysicalPlan-level info, |
| and the NemoOptimizer that only understands IRDAG-level info. |
| <p> |
| This decoupling between the NemoOptimizer and the Runtime lets Nemo optimization policies dynamically control |
| distributed execution behaviors, and at the same time enjoy correctness/reusability/composability properties that |
| the IRDAG abstraction provides.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.nemo.compiler.optimizer.NemoOptimizer,org.apache.nemo.compiler.backend.nemo.NemoBackend,org.apache.reef.tang.InjectionFuture,org.apache.nemo.runtime.common.plan.PhysicalPlanGenerator)">NemoPlanRewriter</a></span>​(<a href="../../optimizer/NemoOptimizer.html" title="class in org.apache.nemo.compiler.optimizer">NemoOptimizer</a> nemoOptimizer, |
| <a href="NemoBackend.html" title="class in org.apache.nemo.compiler.backend.nemo">NemoBackend</a> nemoBackend, |
| org.apache.reef.tang.InjectionFuture<<a href="../../../runtime/master/scheduler/SimulationScheduler.html" title="class in org.apache.nemo.runtime.master.scheduler">SimulationScheduler</a>> simulationSchedulerInjectionFuture, |
| <a href="../../../runtime/common/plan/PhysicalPlanGenerator.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlanGenerator</a> physicalPlanGenerator)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accumulate(int,java.util.Set,java.lang.Object)">accumulate</a></span>​(int messageId, |
| java.util.Set<<a href="../../../runtime/common/plan/StageEdge.html" title="class in org.apache.nemo.runtime.common.plan">StageEdge</a>> targetEdges, |
| java.lang.Object data)</code></th> |
| <td class="colLast"> |
| <div class="block">Accumulate the data needed in Plan Rewrite.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../runtime/common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewrite(int)">rewrite</a></span>​(int messageId)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCurrentIRDAG(org.apache.nemo.common.ir.IRDAG)">setCurrentIRDAG</a></span>​(<a href="../../../common/ir/IRDAG.html" title="class in org.apache.nemo.common.ir">IRDAG</a> currentIRDAG)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCurrentPhysicalPlan(org.apache.nemo.runtime.common.plan.PhysicalPlan)">setCurrentPhysicalPlan</a></span>​(<a href="../../../runtime/common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> currentPhysicalPlan)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.nemo.compiler.optimizer.NemoOptimizer,org.apache.nemo.compiler.backend.nemo.NemoBackend,org.apache.reef.tang.InjectionFuture,org.apache.nemo.runtime.common.plan.PhysicalPlanGenerator)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NemoPlanRewriter</h4> |
| <pre>@Inject |
| public NemoPlanRewriter​(<a href="../../optimizer/NemoOptimizer.html" title="class in org.apache.nemo.compiler.optimizer">NemoOptimizer</a> nemoOptimizer, |
| <a href="NemoBackend.html" title="class in org.apache.nemo.compiler.backend.nemo">NemoBackend</a> nemoBackend, |
| org.apache.reef.tang.InjectionFuture<<a href="../../../runtime/master/scheduler/SimulationScheduler.html" title="class in org.apache.nemo.runtime.master.scheduler">SimulationScheduler</a>> simulationSchedulerInjectionFuture, |
| <a href="../../../runtime/common/plan/PhysicalPlanGenerator.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlanGenerator</a> physicalPlanGenerator)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setCurrentIRDAG(org.apache.nemo.common.ir.IRDAG)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentIRDAG</h4> |
| <pre class="methodSignature">public void setCurrentIRDAG​(<a href="../../../common/ir/IRDAG.html" title="class in org.apache.nemo.common.ir">IRDAG</a> currentIRDAG)</pre> |
| </li> |
| </ul> |
| <a id="setCurrentPhysicalPlan(org.apache.nemo.runtime.common.plan.PhysicalPlan)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentPhysicalPlan</h4> |
| <pre class="methodSignature">public void setCurrentPhysicalPlan​(<a href="../../../runtime/common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> currentPhysicalPlan)</pre> |
| </li> |
| </ul> |
| <a id="rewrite(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewrite</h4> |
| <pre class="methodSignature">public <a href="../../../runtime/common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> rewrite​(int messageId)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../runtime/common/plan/PlanRewriter.html#rewrite(int)">rewrite</a></code> in interface <code><a href="../../../runtime/common/plan/PlanRewriter.html" title="interface in org.apache.nemo.runtime.common.plan">PlanRewriter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageId</code> - of the rewrite.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>physical plan.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="accumulate(int,java.util.Set,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>accumulate</h4> |
| <pre class="methodSignature">public void accumulate​(int messageId, |
| java.util.Set<<a href="../../../runtime/common/plan/StageEdge.html" title="class in org.apache.nemo.runtime.common.plan">StageEdge</a>> targetEdges, |
| java.lang.Object data)</pre> |
| <div class="block">Accumulate the data needed in Plan Rewrite. |
| DATA_NOT_AUGMENTED indicates that the information need in rewrite is not stored in RunTimePassMessageEntry, |
| and we should explicitly generate it using Prophet class. In this case, the data will contain only one entry with |
| key as DATA_NOT_AUGMENTED.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../runtime/common/plan/PlanRewriter.html#accumulate(int,java.util.Set,java.lang.Object)">accumulate</a></code> in interface <code><a href="../../../runtime/common/plan/PlanRewriter.html" title="interface in org.apache.nemo.runtime.common.plan">PlanRewriter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>messageId</code> - of the rewrite.</dd> |
| <dd><code>targetEdges</code> - edges to change during rewrite.</dd> |
| <dd><code>data</code> - to accumulate.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NemoPlanRewriter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
