blob: c4ec0f2b9f2b6a2b5d30d45ce15a831a9178f779 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Apache Mesos: src/slave/containerizer/mesos/linux_launcher.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_80f0d4a0945c74dfa611dba2ec326a39.html">slave</a></li><li class="navelem"><a class="el" href="dir_fbb1f3397356a940a2dbc4baf07ee5bb.html">containerizer</a></li><li class="navelem"><a class="el" href="dir_06602996fd31a3e264808d1450975cb2.html">mesos</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">linux_launcher.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="linux__launcher_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef __LINUX_LAUNCHER_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __LINUX_LAUNCHER_HPP__</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="owned_8hpp.html">process/owned.hpp</a>&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="slave_2containerizer_2mesos_2launcher_8hpp.html">slave/containerizer/mesos/launcher.hpp</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span>slave {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">class </span>LinuxLauncherProcess;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">// Launcher for Linux systems with cgroups. Uses a freezer cgroup to</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// track pids.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html">LinuxLauncher</a> : <span class="keyword">public</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1Launcher.html">Launcher</a></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">static</span> <a class="code" href="classTry.html">Try&lt;Launcher*&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a188c7d32972b2998023f77444d125247">create</a>(<span class="keyword">const</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1Flags.html">Flags</a>&amp; <a class="code" href="namespacemesos_1_1internal_1_1tests.html#af8289f648a916c3f66923867452c7b1b">flags</a>);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="comment">// Returns &#39;true&#39; if prerequisites for using LinuxLauncher are available.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a9680e53e3800a5e174295e6719e8ca6c">available</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a6b27ed8348acf0a92a80bd762cb3977f">~LinuxLauncher</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">process::Future&lt;hashset&lt;ContainerID&gt;</a>&gt; <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a699c488ac03f1df509d0e09bb021a239">recover</a>(</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">const</span> std::list&lt;mesos::slave::ContainerState&gt;&amp; states);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classTry.html">Try&lt;pid_t&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#ab939867760688ac31fb30c42f75c9aea">fork</a>(</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> ContainerID&amp; containerId,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">const</span> std::string&amp; path,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; argv,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> <a class="code" href="classprocess_1_1Subprocess_1_1IO.html">process::Subprocess::IO</a>&amp; in,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">const</span> <a class="code" href="classprocess_1_1Subprocess_1_1IO.html">process::Subprocess::IO</a>&amp; out,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">const</span> <a class="code" href="classprocess_1_1Subprocess_1_1IO.html">process::Subprocess::IO</a>&amp; err,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">const</span> <a class="code" href="classflags_1_1FlagsBase.html">flags::FlagsBase</a>* flags,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option</a>&lt;std::map&lt;std::string, std::string&gt;&gt;&amp; <a class="code" href="namespacemesos_1_1internal_1_1tests.html#a1396c5e3b0a179220de2792d74770ec2">environment</a>,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;int&gt;</a>&amp; enterNamespaces,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;int&gt;</a>&amp; cloneNamespaces);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">process::Future&lt;Nothing&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a65f573e7693965e7030327e5d5cf8b16">destroy</a>(<span class="keyword">const</span> ContainerID&amp; containerId);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">process::Future&lt;ContainerStatus&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#acb8f27191f0c9a78b85fe27c5e387a59">status</a>(</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">const</span> ContainerID&amp; containerId);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html">LinuxLauncher</a>(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">const</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1Flags.html">Flags</a>&amp; flags,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">const</span> std::string&amp; freezerHierarchy,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;std::string&gt;</a>&amp; systemdHierarchy);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="classprocess_1_1Owned.html">process::Owned&lt;LinuxLauncherProcess&gt;</a> process;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;};</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;} <span class="comment">// namespace slave {</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;} <span class="comment">// namespace internal {</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor">#endif // __LINUX_LAUNCHER_HPP__</span></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1Launcher_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1Launcher.html">mesos::internal::slave::Launcher</a></div><div class="ttdef"><b>Definition:</b> launcher.hpp:46</div></div>
<div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option</a></div><div class="ttdef"><b>Definition:</b> option.hpp:24</div></div>
<div class="ttc" id="classTry_html"><div class="ttname"><a href="classTry.html">Try</a></div><div class="ttdef"><b>Definition:</b> try.hpp:34</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html_a699c488ac03f1df509d0e09bb021a239"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a699c488ac03f1df509d0e09bb021a239">mesos::internal::slave::LinuxLauncher::recover</a></div><div class="ttdeci">virtual process::Future&lt; hashset&lt; ContainerID &gt; &gt; recover(const std::list&lt; mesos::slave::ContainerState &gt; &amp;states)</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html_acb8f27191f0c9a78b85fe27c5e387a59"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#acb8f27191f0c9a78b85fe27c5e387a59">mesos::internal::slave::LinuxLauncher::status</a></div><div class="ttdeci">virtual process::Future&lt; ContainerStatus &gt; status(const ContainerID &amp;containerId)</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1Flags_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1Flags.html">mesos::internal::slave::Flags</a></div><div class="ttdef"><b>Definition:</b> flags.hpp:38</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html_ab939867760688ac31fb30c42f75c9aea"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#ab939867760688ac31fb30c42f75c9aea">mesos::internal::slave::LinuxLauncher::fork</a></div><div class="ttdeci">virtual Try&lt; pid_t &gt; fork(const ContainerID &amp;containerId, const std::string &amp;path, const std::vector&lt; std::string &gt; &amp;argv, const process::Subprocess::IO &amp;in, const process::Subprocess::IO &amp;out, const process::Subprocess::IO &amp;err, const flags::FlagsBase *flags, const Option&lt; std::map&lt; std::string, std::string &gt;&gt; &amp;environment, const Option&lt; int &gt; &amp;enterNamespaces, const Option&lt; int &gt; &amp;cloneNamespaces)</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html_a6b27ed8348acf0a92a80bd762cb3977f"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a6b27ed8348acf0a92a80bd762cb3977f">mesos::internal::slave::LinuxLauncher::~LinuxLauncher</a></div><div class="ttdeci">virtual ~LinuxLauncher()</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1tests_html_a1396c5e3b0a179220de2792d74770ec2"><div class="ttname"><a href="namespacemesos_1_1internal_1_1tests.html#a1396c5e3b0a179220de2792d74770ec2">mesos::internal::tests::environment</a></div><div class="ttdeci">Environment * environment</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html">mesos::internal::slave::LinuxLauncher</a></div><div class="ttdef"><b>Definition:</b> linux_launcher.hpp:32</div></div>
<div class="ttc" id="classprocess_1_1Subprocess_1_1IO_html"><div class="ttname"><a href="classprocess_1_1Subprocess_1_1IO.html">process::Subprocess::IO</a></div><div class="ttdoc">Describes how the I/O is redirected for stdin/stdout/stderr. </div><div class="ttdef"><b>Definition:</b> subprocess_base.hpp:63</div></div>
<div class="ttc" id="classflags_1_1FlagsBase_html"><div class="ttname"><a href="classflags_1_1FlagsBase.html">flags::FlagsBase</a></div><div class="ttdef"><b>Definition:</b> flags.hpp:44</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html_a9680e53e3800a5e174295e6719e8ca6c"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a9680e53e3800a5e174295e6719e8ca6c">mesos::internal::slave::LinuxLauncher::available</a></div><div class="ttdeci">static bool available()</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html_a188c7d32972b2998023f77444d125247"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a188c7d32972b2998023f77444d125247">mesos::internal::slave::LinuxLauncher::create</a></div><div class="ttdeci">static Try&lt; Launcher * &gt; create(const Flags &amp;flags)</div></div>
<div class="ttc" id="owned_8hpp_html"><div class="ttname"><a href="owned_8hpp.html">owned.hpp</a></div></div>
<div class="ttc" id="slave_2containerizer_2mesos_2launcher_8hpp_html"><div class="ttname"><a href="slave_2containerizer_2mesos_2launcher_8hpp.html">launcher.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1LinuxLauncher_html_a65f573e7693965e7030327e5d5cf8b16"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1LinuxLauncher.html#a65f573e7693965e7030327e5d5cf8b16">mesos::internal::slave::LinuxLauncher::destroy</a></div><div class="ttdeci">virtual process::Future&lt; Nothing &gt; destroy(const ContainerID &amp;containerId)</div></div>
<div class="ttc" id="classprocess_1_1Owned_html"><div class="ttname"><a href="classprocess_1_1Owned.html">process::Owned&lt; LinuxLauncherProcess &gt;</a></div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1tests_html_af8289f648a916c3f66923867452c7b1b"><div class="ttname"><a href="namespacemesos_1_1internal_1_1tests.html#af8289f648a916c3f66923867452c7b1b">mesos::internal::tests::flags</a></div><div class="ttdeci">Flags flags</div></div>
<div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future</a></div><div class="ttdef"><b>Definition:</b> future.hpp:56</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>