| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 --> |
| <title>RuntimeMaster (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="RuntimeMaster (Nemo Project 0.4 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/RuntimeMaster.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.runtime.master</a></div> |
| <h2 title="Class RuntimeMaster" class="title">Class RuntimeMaster</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.nemo.runtime.master.RuntimeMaster</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">RuntimeMaster</span> |
| extends java.lang.Object</pre> |
| <div class="block">(WARNING) Use runtimeMasterThread for all public methods to avoid race conditions. |
| See comments in the <a href="scheduler/Scheduler.html" title="interface in org.apache.nemo.runtime.master.scheduler"><code>Scheduler</code></a> for avoiding race conditions. |
| <p> |
| Runtime Master is the central controller of Runtime. |
| Compiler submits an <a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan"><code>PhysicalPlan</code></a> to Runtime Master to execute a job. |
| Runtime Master handles: |
| a) Scheduling the plan with <a href="scheduler/Scheduler.html" title="interface in org.apache.nemo.runtime.master.scheduler"><code>Scheduler</code></a>. |
| b) Managing resources with <a href="resource/ContainerManager.html" title="class in org.apache.nemo.runtime.master.resource"><code>ContainerManager</code></a>. |
| c) Managing blocks with <a href="BlockManagerMaster.html" title="class in org.apache.nemo.runtime.master"><code>BlockManagerMaster</code></a>. |
| d) Receiving and sending control messages with <a href="../common/message/MessageEnvironment.html" title="interface in org.apache.nemo.runtime.common.message"><code>MessageEnvironment</code></a>. |
| e) Metric using <a href="metric/MetricMessageHandler.html" title="interface in org.apache.nemo.runtime.master.metric"><code>MetricMessageHandler</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RuntimeMaster.MasterControlMessageReceiver.html" title="class in org.apache.nemo.runtime.master">RuntimeMaster.MasterControlMessageReceiver</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Handler for control messages received by Master.</div> |
| </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><a href="../../common/Pair.html" title="class in org.apache.nemo.common">Pair</a><<a href="PlanStateManager.html" title="class in org.apache.nemo.runtime.master">PlanStateManager</a>,​java.util.concurrent.ScheduledExecutorService></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(org.apache.nemo.runtime.common.plan.PhysicalPlan,int)">execute</a></span>​(<a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> plan, |
| int maxScheduleAttempt)</code></th> |
| <td class="colLast"> |
| <div class="block">Submits the <a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan"><code>PhysicalPlan</code></a> to Runtime.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushMetrics()">flushMetrics</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Flush metrics.</div> |
| </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="#onContainerAllocated(java.lang.String,org.apache.reef.driver.evaluator.AllocatedEvaluator,org.apache.reef.tang.Configuration)">onContainerAllocated</a></span>​(java.lang.String executorId, |
| org.apache.reef.driver.evaluator.AllocatedEvaluator allocatedEvaluator, |
| org.apache.reef.tang.Configuration executorConfiguration)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when a container is allocated for this runtime.</div> |
| </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="#onExecutorFailed(org.apache.reef.driver.evaluator.FailedEvaluator)">onExecutorFailed</a></span>​(org.apache.reef.driver.evaluator.FailedEvaluator failedEvaluator)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when an executor fails due to container failure on this runtime.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onExecutorLaunched(org.apache.reef.driver.context.ActiveContext)">onExecutorLaunched</a></span>​(org.apache.reef.driver.context.ActiveContext activeContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when an executor is launched on a container for this runtime.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#recordIRDAGMetrics(org.apache.nemo.common.ir.IRDAG,java.lang.String)">recordIRDAGMetrics</a></span>​(<a href="../../common/ir/IRDAG.html" title="class in org.apache.nemo.common.ir">IRDAG</a> irdag, |
| java.lang.String planId)</code></th> |
| <td class="colLast"> |
| <div class="block">Record IR DAG related metrics.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestContainer(java.lang.String)">requestContainer</a></span>​(java.lang.String resourceSpecificationString)</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a container with resource specification.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#terminate()">terminate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Terminates the RuntimeMaster.</div> |
| </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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="recordIRDAGMetrics(org.apache.nemo.common.ir.IRDAG,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recordIRDAGMetrics</h4> |
| <pre class="methodSignature">public void recordIRDAGMetrics​(<a href="../../common/ir/IRDAG.html" title="class in org.apache.nemo.common.ir">IRDAG</a> irdag, |
| java.lang.String planId)</pre> |
| <div class="block">Record IR DAG related metrics.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>irdag</code> - the IR DAG to record.</dd> |
| <dd><code>planId</code> - the ID of the IR DAG Physical Plan.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="flushMetrics()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flushMetrics</h4> |
| <pre class="methodSignature">public void flushMetrics()</pre> |
| <div class="block">Flush metrics.</div> |
| </li> |
| </ul> |
| <a id="execute(org.apache.nemo.runtime.common.plan.PhysicalPlan,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre class="methodSignature">public <a href="../../common/Pair.html" title="class in org.apache.nemo.common">Pair</a><<a href="PlanStateManager.html" title="class in org.apache.nemo.runtime.master">PlanStateManager</a>,​java.util.concurrent.ScheduledExecutorService> execute​(<a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan">PhysicalPlan</a> plan, |
| int maxScheduleAttempt)</pre> |
| <div class="block">Submits the <a href="../common/plan/PhysicalPlan.html" title="class in org.apache.nemo.runtime.common.plan"><code>PhysicalPlan</code></a> to Runtime. |
| At now, we are assuming that a single job submit multiple plans.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>plan</code> - to execute</dd> |
| <dd><code>maxScheduleAttempt</code> - the max number of times this plan/sub-part of the plan should be attempted.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>pair of <a href="PlanStateManager.html" title="class in org.apache.nemo.runtime.master"><code>PlanStateManager</code></a> and <code>ScheduledExecutorService</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="terminate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>terminate</h4> |
| <pre class="methodSignature">public void terminate()</pre> |
| <div class="block">Terminates the RuntimeMaster.</div> |
| </li> |
| </ul> |
| <a id="requestContainer(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requestContainer</h4> |
| <pre class="methodSignature">public void requestContainer​(java.lang.String resourceSpecificationString)</pre> |
| <div class="block">Requests a container with resource specification.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceSpecificationString</code> - the resource specification.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onContainerAllocated(java.lang.String,org.apache.reef.driver.evaluator.AllocatedEvaluator,org.apache.reef.tang.Configuration)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onContainerAllocated</h4> |
| <pre class="methodSignature">public void onContainerAllocated​(java.lang.String executorId, |
| org.apache.reef.driver.evaluator.AllocatedEvaluator allocatedEvaluator, |
| org.apache.reef.tang.Configuration executorConfiguration)</pre> |
| <div class="block">Called when a container is allocated for this runtime. |
| A wrapper function for <a href="resource/ContainerManager.html" title="class in org.apache.nemo.runtime.master.resource"><code>ContainerManager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executorId</code> - to use for the executor to be launched on this container.</dd> |
| <dd><code>allocatedEvaluator</code> - to be used as the container.</dd> |
| <dd><code>executorConfiguration</code> - to use for the executor to be launched on this container.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onExecutorLaunched(org.apache.reef.driver.context.ActiveContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onExecutorLaunched</h4> |
| <pre class="methodSignature">public boolean onExecutorLaunched​(org.apache.reef.driver.context.ActiveContext activeContext)</pre> |
| <div class="block">Called when an executor is launched on a container for this runtime.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>activeContext</code> - of the launched executor.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if all requested executors have been launched, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onExecutorFailed(org.apache.reef.driver.evaluator.FailedEvaluator)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onExecutorFailed</h4> |
| <pre class="methodSignature">public void onExecutorFailed​(org.apache.reef.driver.evaluator.FailedEvaluator failedEvaluator)</pre> |
| <div class="block">Called when an executor fails due to container failure on this runtime.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>failedEvaluator</code> - that failed.</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/RuntimeMaster.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |