blob: fd7e2c6142086a89b09df642c060f31c71b8c647 [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/provisioner/appc/paths.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_f319675d4a0209ee44e08f6c8dad3e25.html">provisioner</a></li><li class="navelem"><a class="el" href="dir_4f41d30518de1e59bcb759f18fc06d2a.html">appc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">paths.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="containerizer_2mesos_2provisioner_2appc_2paths_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 __PROVISIONER_APPC_PATHS_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __PROVISIONER_APPC_PATHS_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="hashmap_8hpp.html">stout/hashmap.hpp</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</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="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mesos_2appc_2spec_8hpp.html">mesos/appc/spec.hpp</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span>slave {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span>appc {</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html"> 31</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceos_1_1libraries.html#a41b3cb8b32c32ab2abf7a7aa62de9f18">paths</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">// The appc store file system layout is as follows:</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">// &lt;store_dir&gt; (&#39;--appc_store_dir&#39; flag)</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">// |--staging (contains temp directories for staging downloads)</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">// |</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment">// |--images (stores validated images)</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// |--&lt;image_id&gt; (in the form of &quot;sha512-&lt;128_character_hash_sum&gt;&quot;)</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// |--manifest</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">// |--rootfs</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">// |--... (according to the ACI spec)</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// TODO(xujyan): The staging directory is unused for now (it&#39;s</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// externally managed) but implemented to illustrate the need for a</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment">// separate &#39;images&#39; directory. Complete the layout diagram when the</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">// staging directory is utilized by the provisioner.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;std::string <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#afe762bdaed14ea2293b3db4b076bb650">getStagingDir</a>(<span class="keyword">const</span> std::string&amp; storeDir);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;std::string <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#a12909a1910f5ec152fd5a5722f404ea8">getImagesDir</a>(<span class="keyword">const</span> std::string&amp; storeDir);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;std::string <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#af62e6ac6a6f447bf9861ee74b98da15e">getImagePath</a>(</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">const</span> std::string&amp; storeDir,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">const</span> std::string&amp; imageId);</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;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;std::string <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#a17489dbcd97bdbbb300923e01dee456a">getImageRootfsPath</a>(</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">const</span> std::string&amp; storeDir,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> std::string&amp; imageId);</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;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;std::string <a class="code" href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#aa4d78d16b3e6cd13881a753885635733">getImageManifestPath</a>(</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">const</span> std::string&amp; storeDir,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> std::string&amp; imageId);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;} <span class="comment">// namespace paths {</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;} <span class="comment">// namespace appc {</span></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 // __PROVISIONER_APPC_PATHS_HPP__</span></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths_html_a12909a1910f5ec152fd5a5722f404ea8"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#a12909a1910f5ec152fd5a5722f404ea8">mesos::internal::slave::appc::paths::getImagesDir</a></div><div class="ttdeci">std::string getImagesDir(const std::string &amp;storeDir)</div></div>
<div class="ttc" id="namespaceos_1_1libraries_html_a41b3cb8b32c32ab2abf7a7aa62de9f18"><div class="ttname"><a href="namespaceos_1_1libraries.html#a41b3cb8b32c32ab2abf7a7aa62de9f18">os::libraries::paths</a></div><div class="ttdeci">std::string paths()</div><div class="ttdef"><b>Definition:</b> os.hpp:136</div></div>
<div class="ttc" id="include_2mesos_2appc_2spec_8hpp_html"><div class="ttname"><a href="include_2mesos_2appc_2spec_8hpp.html">spec.hpp</a></div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths_html_af62e6ac6a6f447bf9861ee74b98da15e"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#af62e6ac6a6f447bf9861ee74b98da15e">mesos::internal::slave::appc::paths::getImagePath</a></div><div class="ttdeci">std::string getImagePath(const std::string &amp;storeDir, const std::string &amp;imageId)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths_html_aa4d78d16b3e6cd13881a753885635733"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#aa4d78d16b3e6cd13881a753885635733">mesos::internal::slave::appc::paths::getImageManifestPath</a></div><div class="ttdeci">std::string getImageManifestPath(const std::string &amp;storeDir, const std::string &amp;imageId)</div></div>
<div class="ttc" id="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths_html_a17489dbcd97bdbbb300923e01dee456a"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#a17489dbcd97bdbbb300923e01dee456a">mesos::internal::slave::appc::paths::getImageRootfsPath</a></div><div class="ttdeci">std::string getImageRootfsPath(const std::string &amp;storeDir, const std::string &amp;imageId)</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="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths_html_afe762bdaed14ea2293b3db4b076bb650"><div class="ttname"><a href="namespacemesos_1_1internal_1_1slave_1_1appc_1_1paths.html#afe762bdaed14ea2293b3db4b076bb650">mesos::internal::slave::appc::paths::getStagingDir</a></div><div class="ttdeci">std::string getStagingDir(const std::string &amp;storeDir)</div></div>
<div class="ttc" id="hashmap_8hpp_html"><div class="ttname"><a href="hashmap_8hpp.html">hashmap.hpp</a></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>