blob: e345ba1d385e1a08e8cae8276c1ec619d4a76c4b [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/isolators/gpu/volume.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><li class="navelem"><a class="el" href="dir_7c165478aec9e654f08f29fd2fd0a034.html">isolators</a></li><li class="navelem"><a class="el" href="dir_0551c3d4c458bd0ac3ce38817955e8b6.html">gpu</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">volume.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="volume_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 __NVIDIA_VOLUME_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __NVIDIA_VOLUME_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;string&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 &lt;<a class="code" href="include_2mesos_2mesos_8hpp.html">mesos/mesos.hpp</a>&gt;</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="preprocessor">#include &lt;<a class="code" href="include_2mesos_2docker_2spec_8hpp.html">mesos/docker/spec.hpp</a>&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="try_8hpp.html">stout/try.hpp</a>&gt;</span></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">namespace </span>mesos {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span>slave {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">// Provides a consolidated volume of binaries and libraries</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">// from the user-space portion of the Nvidia GPU drivers.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">// We follow the approach taken by Nvidia&#39;s docker plugin:</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">// https://github.com/NVIDIA/nvidia-docker/</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html"> 36</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html">NvidiaVolume</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// Returns the Nvidia volume. Once we create the volume it is</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// never deleted until reboot. This means that if an agent</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// crashes and tries to recreate the volume it will only ever</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// *add* new libraries to it (nothing will be deleted from it).</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// This prevents already-running containers from having</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">// whatever libraries they depend on ripped out from under them.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">static</span> <a class="code" href="classTry.html">Try&lt;NvidiaVolume&gt;</a> <a class="code" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#ad33863703e3a5641a61b880afa6272d3">create</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">const</span> std::string&amp; <a class="code" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#a054a94b2f384ba56eb8b471fbf5bfba4">HOST_PATH</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">const</span> std::string&amp; <a class="code" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#a8da74eb3c8b1b527504a089fb980c6f9">CONTAINER_PATH</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="comment">// Returns whether the container based on a docker image</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// should have the volume injected. We follow nvidia-docker&#39;s</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="comment">// label conventions:</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">// https://github.com/NVIDIA/nvidia-docker/wiki/Image-inspection</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#a18b7ba063c77d278f7e30640bbed4e6b">shouldInject</a>(const ::docker::spec::v1::ImageManifest&amp; <a class="code" href="namespacemesos_1_1uri_1_1docker.html#a001e34ad4b471e43d16e9f03e39a4566">manifest</a>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html">NvidiaVolume</a>() = <span class="keyword">delete</span>;</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; <a class="code" href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html">NvidiaVolume</a>(<span class="keyword">const</span> std::string&amp; _hostPath,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">const</span> std::string&amp; _containerPath)</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; : hostPath(_hostPath),</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; containerPath(_containerPath) {}</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; std::string hostPath;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; std::string containerPath;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;};</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;} <span class="comment">// namespace slave {</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;} <span class="comment">// namespace internal {</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="preprocessor">#endif // __NVIDIA_GPU_VOLUME_HPP__</span></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="include_2mesos_2mesos_8hpp_html"><div class="ttname"><a href="include_2mesos_2mesos_8hpp.html">mesos.hpp</a></div></div>
<div class="ttc" id="namespacemesos_1_1uri_1_1docker_html_a001e34ad4b471e43d16e9f03e39a4566"><div class="ttname"><a href="namespacemesos_1_1uri_1_1docker.html#a001e34ad4b471e43d16e9f03e39a4566">mesos::uri::docker::manifest</a></div><div class="ttdeci">URI manifest(const std::string &amp;repository, const std::string &amp;reference, const std::string &amp;registry, const Option&lt; std::string &gt; &amp;scheme=None(), const Option&lt; int &gt; &amp;port=None())</div><div class="ttdef"><b>Definition:</b> docker.hpp:47</div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1NvidiaVolume_html_ad33863703e3a5641a61b880afa6272d3"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#ad33863703e3a5641a61b880afa6272d3">mesos::internal::slave::NvidiaVolume::create</a></div><div class="ttdeci">static Try&lt; NvidiaVolume &gt; create()</div></div>
<div class="ttc" id="include_2mesos_2docker_2spec_8hpp_html"><div class="ttname"><a href="include_2mesos_2docker_2spec_8hpp.html">spec.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1NvidiaVolume_html_a18b7ba063c77d278f7e30640bbed4e6b"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#a18b7ba063c77d278f7e30640bbed4e6b">mesos::internal::slave::NvidiaVolume::shouldInject</a></div><div class="ttdeci">bool shouldInject(const ::docker::spec::v1::ImageManifest &amp;manifest) const </div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1NvidiaVolume_html_a054a94b2f384ba56eb8b471fbf5bfba4"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#a054a94b2f384ba56eb8b471fbf5bfba4">mesos::internal::slave::NvidiaVolume::HOST_PATH</a></div><div class="ttdeci">const std::string &amp; HOST_PATH() const </div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1NvidiaVolume_html_a8da74eb3c8b1b527504a089fb980c6f9"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html#a8da74eb3c8b1b527504a089fb980c6f9">mesos::internal::slave::NvidiaVolume::CONTAINER_PATH</a></div><div class="ttdeci">const std::string &amp; CONTAINER_PATH() const </div></div>
<div class="ttc" id="try_8hpp_html"><div class="ttname"><a href="try_8hpp.html">try.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1internal_1_1slave_1_1NvidiaVolume_html"><div class="ttname"><a href="classmesos_1_1internal_1_1slave_1_1NvidiaVolume.html">mesos::internal::slave::NvidiaVolume</a></div><div class="ttdef"><b>Definition:</b> volume.hpp:36</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>