Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-nodemanager / apidocs / org / apache / hadoop / yarn / server / nodemanager / containermanager / linux / resources / CGroupsCpuResourceHandlerImpl.html
blob: a76c7368bd1e032d2d6141f6106b1b88080a7074 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:11:21 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CGroupsCpuResourceHandlerImpl (Apache Hadoop YARN NodeManager 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CGroupsCpuResourceHandlerImpl (Apache Hadoop YARN NodeManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CGroupsCpuResourceHandlerImpl.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">
<li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsBlkioResourceHandlerImpl.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html" target="_top">Frames</a></li>
<li><a href="CGroupsCpuResourceHandlerImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources</div>
<h2 title="Class CGroupsCpuResourceHandlerImpl" class="title">Class CGroupsCpuResourceHandlerImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.CGroupsCpuResourceHandlerImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CpuResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">CpuResourceHandler</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandler</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceStability.Unstable
@InterfaceAudience.Private
public class <span class="typeNameLabel">CGroupsCpuResourceHandlerImpl</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CpuResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">CpuResourceHandler</a></pre>
<div class="block">An implementation for using CGroups to restrict CPU usage on Linux. The
implementation supports 3 different controls - restrict usage of all YARN
containers, restrict relative usage of individual YARN containers and
restrict usage of individual YARN containers. Admins can set the overall CPU
to be used by all YARN containers - this is implemented by setting
cpu.cfs_period_us and cpu.cfs_quota_us to the ratio desired. If strict
resource usage mode is not enabled, cpu.shares is set for individual
containers - this prevents containers from exceeding the overall limit for
YARN containers but individual containers can use as much of the CPU as
available(under the YARN limit). If strict resource usage is enabled, then
container can only use the percentage of CPU allocated to them and this is
again implemented using cpu.cfs_period_us and cpu.cfs_quota_us.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#bootstrap-org.apache.hadoop.conf.Configuration-">bootstrap</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Bootstrap resource susbsystem.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#cpuLimitsExist-java.lang.String-">cpuLimitsExist</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static int[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#getOverallLimits-float-">getOverallLimits</a></span>(float&nbsp;yarnProcessors)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#postComplete-org.apache.hadoop.yarn.api.records.ContainerId-">postComplete</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">Perform any tasks necessary after container completion.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#preStart-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">preStart</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a>&nbsp;container)</code>
<div class="block">Prepare a resource environment for container launch</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#reacquireContainer-org.apache.hadoop.yarn.api.records.ContainerId-">reacquireContainer</a></span>(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)</code>
<div class="block">Require state for container that was already launched</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#teardown--">teardown</a></span>()</code>
<div class="block">Teardown environment for resource subsystem if requested.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html#updateContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">updateContainer</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a>&nbsp;container)</code>
<div class="block">Update state for container that was already launched</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="bootstrap-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bootstrap</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;&nbsp;bootstrap(org.apache.hadoop.conf.Configuration&nbsp;conf)
throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#bootstrap-org.apache.hadoop.conf.Configuration-">ResourceHandler</a></code></span></div>
<div class="block">Bootstrap resource susbsystem.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#bootstrap-org.apache.hadoop.conf.Configuration-">bootstrap</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandler</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(possibly empty) list of operations that require elevated
privileges</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></code></dd>
</dl>
</li>
</ul>
<a name="cpuLimitsExist-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cpuLimitsExist</h4>
<pre>@InterfaceAudience.Private
public static&nbsp;boolean&nbsp;cpuLimitsExist(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getOverallLimits-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOverallLimits</h4>
<pre>@InterfaceAudience.Private
public static&nbsp;int[]&nbsp;getOverallLimits(float&nbsp;yarnProcessors)</pre>
</li>
</ul>
<a name="preStart-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preStart</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;&nbsp;preStart(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a>&nbsp;container)
throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#preStart-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">ResourceHandler</a></code></span></div>
<div class="block">Prepare a resource environment for container launch</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#preStart-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">preStart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - Container being launched</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(possibly empty) list of operations that require elevated
privileges e.g a) create a custom cgroup b) add pid for container to tasks
file for a cgroup.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></code></dd>
</dl>
</li>
</ul>
<a name="reacquireContainer-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reacquireContainer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;&nbsp;reacquireContainer(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)
throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#reacquireContainer-org.apache.hadoop.yarn.api.records.ContainerId-">ResourceHandler</a></code></span></div>
<div class="block">Require state for container that was already launched</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#reacquireContainer-org.apache.hadoop.yarn.api.records.ContainerId-">reacquireContainer</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - id of the container being reacquired.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(possibly empty) list of operations that require elevated
privileges</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></code></dd>
</dl>
</li>
</ul>
<a name="updateContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateContainer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;&nbsp;updateContainer(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a>&nbsp;container)
throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#updateContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">ResourceHandler</a></code></span></div>
<div class="block">Update state for container that was already launched</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#updateContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">updateContainer</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>container</code> - the container being updated.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(possibly empty) list of operations that require elevated
privileges</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></code></dd>
</dl>
</li>
</ul>
<a name="postComplete-org.apache.hadoop.yarn.api.records.ContainerId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postComplete</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;&nbsp;postComplete(org.apache.hadoop.yarn.api.records.ContainerId&nbsp;containerId)
throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#postComplete-org.apache.hadoop.yarn.api.records.ContainerId-">ResourceHandler</a></code></span></div>
<div class="block">Perform any tasks necessary after container completion.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#postComplete-org.apache.hadoop.yarn.api.records.ContainerId-">postComplete</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandler</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerId</code> - of the container that was completed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(possibly empty) list of operations that require elevated
privileges</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></code></dd>
</dl>
</li>
</ul>
<a name="teardown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>teardown</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperation.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperation</a>&gt;&nbsp;teardown()
throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#teardown--">ResourceHandler</a></code></span></div>
<div class="block">Teardown environment for resource subsystem if requested. This method
needs to be used with care since it could impact running containers.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html#teardown--">teardown</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandler</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(possibly empty) list of operations that require elevated
privileges</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/ResourceHandlerException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">ResourceHandlerException</a></code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CGroupsCpuResourceHandlerImpl.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">
<li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsBlkioResourceHandlerImpl.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsCpuResourceHandlerImpl.html" target="_top">Frames</a></li>
<li><a href="CGroupsCpuResourceHandlerImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>